使用Lombok时能否排除敏感字段值但保留字段名输出到日志?
实现目标的两种无逐类手写toString方案
首先明确:原生Lombok的@ToString.Exclude设计逻辑就是在生成toString时彻底剔除对应字段,没有内置参数可以直接实现“保留字段名、输出占位掩码”的效果。要实现clientSecret=<HIDDEN>的输出效果,完全不需要在每个类里手动重写toString,可根据项目规模选择下面两种成熟落地路径:
方案1:Lombok SPI 自定义编译期扩展(适合多类的大型项目)
这是侵入性最低、最贴合Lombok使用习惯的实现方式,一次开发即可让全项目所有数据类自动生效:
- 先定义专属的字段标记注解,替换掉原有代码里的
@ToString.Exclude@Target(ElementType.FIELD) @Retention(RetentionPolicy.SOURCE) public @interface SensitiveLogField {} - 按照Lombok的SPI扩展规范,开发一个轻量编译期插件,介入Lombok的toString生成流程:对所有被
@SensitiveLogField标注的字段,不再执行剔除逻辑,而是把原本输出字段实际值的部分,替换为固定占位字符串"<HIDDEN>" - 将该插件作为项目公共编译依赖引入后,所有用
@Data标注的类,编译生成的toString方法会自动输出敏感字段的占位内容,类本身的代码逻辑几乎不需要调整
该方案优势是编码体验和原生Lombok完全一致,不需要在每个类中编写重复的mask方法,长期维护成本最低
方案2:原生Lombok 能力组合实现(适合不想维护自定义插件的中小项目)
如果不想开发Lombok扩展插件,完全可以用Lombok原生注解搭配固定代码模板实现同等效果,不需要逐类重写toString逻辑:
- 对所有敏感字段保留
@ToString.Exclude标注,避免真实值被输出,同时保留原有字段用于业务逻辑 - 定义全局统一的日志掩码常量:
public final class LogMaskConst { /** 敏感字段日志输出占位值 */ public static final String MASK = "<HIDDEN>"; } - 借助Lombok的
@ToString.Include能力,为每个敏感字段配置仅用于日志输出的掩码返回方法,保留原有字段名在toString中的展示:@Data public class TokenReq { private String grantType; private String code; private String clientId; // 原敏感字段,用@ToString.Exclude排除真实值的输出 @ToString.Exclude private String refreshToken; @ToString.Exclude private String clientSecret; private String redirectUri; // 仅用于toString输出的掩码方法,不参与业务逻辑 @ToString.Include(name = "refreshToken") private String refreshTokenForLog() { return LogMaskConst.MASK; } @ToString.Include(name = "clientSecret") private String clientSecretForLog() { return LogMaskConst.MASK; } } - 实际使用时可以把上述掩码方法做成IDE实时模板,新增敏感字段时几秒钟即可插入对应代码,不需要手动编写重复逻辑
注意事项
- 不要为了临时快速实现,给每个类手动重写toString,大量数据类的场景下维护成本会指数级上升
- 自定义Lombok插件时需要和项目当前使用的Lombok版本做兼容校验,避免出现编译期注解处理冲突
- 占位字符串可以根据排查需求调整,比如附带字段值的前2位/哈希值,在不泄露敏感信息的前提下提升日志排查效率
内容的提问来源于stack exchange,提问作者Hamy
相关产品推荐
相关产品推荐

