0

0

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

聖光之護

聖光之護

发布时间:2026-01-21 18:39:11

|

168人浏览过

|

来源于php中文网

原创

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

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

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

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

慧中标AI标书
慧中标AI标书

慧中标AI标书是一款AI智能辅助写标书工具。

下载
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 仅忠实记录序列化结果,既符合单一职责,也规避了字符串解析的风险。

相关专题

更多
java
java

Java是一个通用术语,用于表示Java软件及其组件,包括“Java运行时环境 (JRE)”、“Java虚拟机 (JVM)”以及“插件”。php中文网还为大家带了Java相关下载资源、相关课程以及相关文章等内容,供大家免费下载使用。

841

2023.06.15

java正则表达式语法
java正则表达式语法

java正则表达式语法是一种模式匹配工具,它非常有用,可以在处理文本和字符串时快速地查找、替换、验证和提取特定的模式和数据。本专题提供java正则表达式语法的相关文章、下载和专题,供大家免费下载体验。

742

2023.07.05

java自学难吗
java自学难吗

Java自学并不难。Java语言相对于其他一些编程语言而言,有着较为简洁和易读的语法,本专题为大家提供java自学难吗相关的文章,大家可以免费体验。

738

2023.07.31

java配置jdk环境变量
java配置jdk环境变量

Java是一种广泛使用的高级编程语言,用于开发各种类型的应用程序。为了能够在计算机上正确运行和编译Java代码,需要正确配置Java Development Kit(JDK)环境变量。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

397

2023.08.01

java保留两位小数
java保留两位小数

Java是一种广泛应用于编程领域的高级编程语言。在Java中,保留两位小数是指在进行数值计算或输出时,限制小数部分只有两位有效数字,并将多余的位数进行四舍五入或截取。php中文网给大家带来了相关的教程以及文章,欢迎大家前来阅读学习。

399

2023.08.02

java基本数据类型
java基本数据类型

java基本数据类型有:1、byte;2、short;3、int;4、long;5、float;6、double;7、char;8、boolean。本专题为大家提供java基本数据类型的相关的文章、下载、课程内容,供大家免费下载体验。

446

2023.08.02

java有什么用
java有什么用

java可以开发应用程序、移动应用、Web应用、企业级应用、嵌入式系统等方面。本专题为大家提供java有什么用的相关的文章、下载、课程内容,供大家免费下载体验。

430

2023.08.02

java在线网站
java在线网站

Java在线网站是指提供Java编程学习、实践和交流平台的网络服务。近年来,随着Java语言在软件开发领域的广泛应用,越来越多的人对Java编程感兴趣,并希望能够通过在线网站来学习和提高自己的Java编程技能。php中文网给大家带来了相关的视频、教程以及文章,欢迎大家前来学习阅读和下载。

16926

2023.08.03

Java编译相关教程合集
Java编译相关教程合集

本专题整合了Java编译相关教程,阅读专题下面的文章了解更多详细内容。

9

2026.01.21

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Kotlin 教程
Kotlin 教程

共23课时 | 2.7万人学习

C# 教程
C# 教程

共94课时 | 7.2万人学习

Java 教程
Java 教程

共578课时 | 48.8万人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号 技术交流群
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn | 湘ICP备2023035733号