如何在 Logbook 日志中忽略 JSON 响应中的敏感字段

雨墨大大_7054

雨墨大大_7054

2026-01-21

188人浏览

原创

如何在 Logbook 日志中忽略 JSON 响应中的敏感字段

本文介绍如何通过 jackson 的 `@jsonignore` 注解或自定义 bodyfilter,在 zalando logbook 中精准过滤响应体中的特定字段,避免敏感数据(如 `fieldtwo`)被记录到日志中。

Zalando Logbook 是一款轻量、高性能的 HTTP 请求/响应日志框架,但其默认行为会完整记录序列化后的响应体(如 JSON 字符串)。若响应对象中包含需脱敏的字段(例如令牌、密码、内部标识等),仅靠 Logbook 自身配置无法直接“选择性忽略 Java 对象字段”——真正的过滤时机发生在序列化阶段,而非日志捕获阶段。

因此,最直接、可靠且符合职责分离原则的方案是:在 JSON 序列化层控制字段可见性。如果你使用的是 Jackson(Spring Boot 默认 JSON 库),只需为待忽略字段添加 @JsonIgnore 注解:

Expanso yaml-to-json
Expanso yaml-to-json

使用 Expanso Edge 管道将 YAML 输入转换为 JSON 格式。

下载
import com.fasterxml.jackson.annotation.JsonIgnore;

class MyResponse {
    private String fieldOne;

    @JsonIgnore  // ✅ Logbook 将记录不含该字段的 JSON
    private String fieldTwo;

    private String fieldThree;

    // 必须提供 getter/setter(Jackson 默认依赖)
    public String getFieldOne() { return fieldOne; }
    public void setFieldOne(String fieldOne) { this.fieldOne = fieldOne; }

    public String getFieldTwo() { return fieldTwo; }
    public void setFieldTwo(String fieldTwo) { this.fieldTwo = fieldTwo; }

    public String getFieldThree() { return fieldThree; }
    public void setFieldThree(String fieldThree) { this.fieldThree = fieldThree; }
}
✅ 效果:当 MyResponse 被 Jackson 序列化为 JSON 并交由 Logbook 记录时,fieldTwo 将完全不出现,日志中仅保留 fieldOne 和 fieldThree。

其他可行方案补充说明

  • @JsonInclude(JsonInclude.Include.NON_NULL) + null 赋值:适用于运行时动态决定是否记录(如将 fieldTwo = null),但语义不如 @JsonIgnore 清晰,且可能影响业务逻辑。
  • 自定义 BodyFilter(高级用法):Logbook 提供 BodyFilter 接口用于正则/字符串级过滤(如 bodyFilter(body -> body.replace("\"fieldTwo\":\".*?\"", ""))),但强烈不推荐——它操作的是已序列化的 JSON 字符串,易因格式变化(空格、换行、嵌套结构)导致过滤失败或 JSON 损坏,违背类型安全原则。
  • @JsonIgnoreProperties(类级别):适用于批量忽略,例如 @JsonIgnoreProperties({"fieldTwo", "internalId"}),适合统一策略场景。

注意事项与最佳实践

  • @JsonIgnore 仅作用于序列化(Object → JSON),反序列化(JSON → Object)仍可正常赋值(除非额外加 @JsonIgnore 在 setter 或使用 @JsonIgnoreProperties(allowSetters = true))。
  • 确保你的响应对象有标准 getter 方法,Jackson 默认仅序列化 public getter;若使用 Lombok,请添加 @Getter。
  • 若项目中混合使用多种序列化库(如 Gson),需改用对应注解(如 Gson 的 @Expose(serialize = false))。
  • 对于无法修改源码的第三方响应类,可考虑使用 Jackson 的 SimpleModule + BeanSerializerModifier 进行运行时定制,但复杂度显著上升,应作为最后选项。

综上,优先采用 @JsonIgnore 是最简洁、稳定、可维护的解决方案——它把字段过滤逻辑内聚在领域模型中,Logbook 仅忠实记录序列化结果,既符合单一职责,也规避了字符串解析的风险。

相关专题

更多
spring框架介绍
spring框架介绍

本专题整合了spring框架相关内容,想了解更多详细内容,请阅读专题下面的文章。

2025.08.06

2851

22

Java Spring Security 与认证授权
Java Spring Security 与认证授权

本专题系统讲解 Java Spring Security 框架在认证与授权中的应用,涵盖用户身份验证、权限控制、JWT与OAuth2实现、跨站请求伪造(CSRF)防护、会话管理与安全漏洞防范。通过实际项目案例,帮助学习者掌握如何 使用 Spring Security 实现高安全性认证与授权机制,提升 Web 应用的安全性与用户数据保护。

2026.01.26

517

25

spring boot框架优点
spring boot框架优点

spring boot框架的优点有简化配置、快速开发、内嵌服务器、微服务支持、自动化测试和生态系统支持。本专题为大家提供spring boot相关的文章、下载、课程内容,供大家免费下载体验。

2023.09.05

691

5

spring框架有哪些
spring框架有哪些

spring框架有Spring Core、Spring MVC、Spring Data、Spring Security、Spring AOP和Spring Boot。详细介绍:1、Spring Core,通过将对象的创建和依赖关系的管理交给容器来实现,从而降低了组件之间的耦合度;2、Spring MVC,提供基于模型-视图-控制器的架构,用于开发灵活和可扩展的Web应用程序等。

2023.10.12

1455

7

Java Spring Boot开发
Java Spring Boot开发

本专题围绕 Java 主流开发框架 Spring Boot 展开,系统讲解依赖注入、配置管理、数据访问、RESTful API、微服务架构与安全认证等核心知识,并通过电商平台、博客系统与企业管理系统等项目实战,帮助学员掌握使用 Spring Boot 快速开发高效、稳定的企业级应用。

2025.08.19

5526

10

Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性
Java Spring Boot 4更新教程_Java Spring Boot 4有哪些新特性

Spring Boot 是一个基于 Spring 框架的 Java 开发框架,它通过 约定优于配置的原则,大幅简化了 Spring 应用的初始搭建、配置和开发过程,让开发者可以快速构建独立的、生产级别的 Spring 应用,无需繁琐的样板配置,通常集成嵌入式服务器(如 Tomcat),提供“开箱即用”的体验,是构建微服务和 Web 应用的流行工具。

2025.12.22

436

5

Java Spring Boot 微服务实战
Java Spring Boot 微服务实战

本专题深入讲解 Java Spring Boot 在微服务架构中的应用,内容涵盖服务注册与发现、REST API开发、配置中心、负载均衡、熔断与限流、日志与监控。通过实际项目案例(如电商订单系统),帮助开发者掌握 从单体应用迁移到高可用微服务系统的完整流程与实战能力。

2025.12.24

680

18

Spring Boot企业级开发与MyBatis Plus实战
Spring Boot企业级开发与MyBatis Plus实战

本专题面向 Java 后端开发者,系统讲解如何基于 Spring Boot 与 MyBatis Plus 构建高效、规范的企业级应用。内容涵盖项目架构设计、数据访问层封装、通用 CRUD 实现、分页与条件查询、代码生成器以及常见性能优化方案。通过完整实战案例,帮助开发者提升后端开发效率,减少重复代码,快速交付稳定可维护的业务系统。

2026.02.11

405

24

Kotlin协程编程与Spring Boot集成实践
Kotlin协程编程与Spring Boot集成实践

本专题围绕 Kotlin 协程机制展开,深入讲解挂起函数、协程作用域、结构化并发与异常处理机制,并结合 Spring Boot 展示协程在后端开发中的实际应用。内容涵盖异步接口设计、数据库调用优化、线程资源管理以及性能调优策略,帮助开发者构建更加简洁高效的 Kotlin 后端服务架构。

2026.02.12

391

18

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
dev.java 官方:Learn Java
dev.java 官方:Learn Java

共0课时 | 0人学习

Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习