java日志规范与脱敏指南的核心是记录必要信息、不泄露敏感数据、便于排查问题、符合安全合规要求,是开发、运维、安全三方共同遵守的协作约定。

Java 日志规范与脱敏指南的核心是:记录必要信息、不泄露敏感数据、便于排查问题、符合安全合规要求。它不是纯技术文档,而是开发、运维、安全三方共同遵守的协作约定。
一、日志内容规范:记什么、怎么记
避免“全量打印”或“只打异常堆栈”,应分场景明确日志级别和内容:
- INFO 级别:记录关键业务流转节点,如“用户[12345]提交订单成功,订单号ORD-20240501-789”——含主键ID、操作类型、结果状态,不含密码、手机号、身份证等原始值;
- WARN 级别:记录可恢复的异常或边界情况,如“支付回调签名验证失败(商户号MCH-678,时间偏差+3200ms)”,需包含上下文线索但不暴露密钥或明文签名;
- ERROR 级别:仅记录不可忽略的系统级错误,必须带完整异常类名、消息、关键业务ID(如订单ID、请求traceId),禁止直接打印Exception.printStackTrace()到业务日志;
- DEBUG 级别:仅在本地或测试环境开启,用于临时定位逻辑分支,上线前必须关闭或用条件日志(如if (log.isDebugEnabled()))包裹。
二、敏感信息识别与脱敏策略
脱敏不是“模糊处理”,而是按字段类型+使用场景分级控制:
你接手一个需求时,是不是经常这样:"改一个小字段 → 结果把不相关的代码也改了"、"需求说得很模糊 → 做着做着发现跑偏了"、"数据库加个字段 → 上线才发现漏了数据兼容"、"做了个新功能 → 一个月后自己都忘了当时怎么设计的"、"写到一半被中断 → 再回来不知道从哪继续";这个 Skill 就是专门解决这些问题的。 它会自动探测你的项目环境(JDK、Spring Boot、ORM、数据库、前端框架),记在
- 身份证号:保留前3位+后4位,中间用*代替(如110**********1234),日志中禁止出现完整18位;
- 手机号/固话:保留前3位+后4位(如138****1234),国际号码需保留国家码(如+86****1234);
- 银行卡号:仅记录发卡行+后4位(如ICBC-****5678),禁止记录BIN段或完整卡号;
- 密码、密钥、Token、JWT载荷:任何环境日志中均不得出现明文,连“***”都不建议打,可记录“[REDACTED: password]”或直接省略;
- 姓名、地址、邮箱:非必要不记录;若必须记录(如投诉工单日志),采用泛化方式,如“用户[张*]”、“地址[北京市朝*区]”、“邮箱[user_***@domain.com]”。
三、技术落地要点
规范要能跑在代码里,不是贴在墙上:
- 统一使用 SLF4J + Logback(或 Log4j2),禁止直接调用底层实现类(如LoggerFactory.getLogger() 可,new ConsoleAppender() 不可);
- 自定义日志工具类封装脱敏逻辑,例如LogUtil.info("下单完成", Map.of("uid", maskUserId(uid), "orderId", orderId));
- 在 MDC(Mapped Diagnostic Context)中注入 traceId、userId(脱敏后)、ip(匿名化,如192.168.1.*),确保跨线程/异步日志可追溯;
- 配置 logback-spring.xml 时,禁用 console 输出到生产环境,启用异步 Appender + 滚动策略(timeBased + sizeBased),并设置 maxHistory=30;
- 静态代码扫描(如 SonarQube)加入规则:拦截含“password”、“idCard”、“phone”等关键字的字符串拼接日志语句。
四、协同与演进机制
规范的生命力在于持续对齐:
- 新接口上线前,由开发填写《日志影响评估表》,说明记录字段、脱敏方式、日志级别、留存周期;
- 安全团队每季度抽样审计日志文件(尤其是 ERROR 和 WARN),检查脱敏覆盖率与 traceId 完整性;
- 将典型误打案例(如打印了Map.toString()导致泄露token)纳入新人培训题库;
- 当引入新中间件(如 Dubbo、Feign、RocketMQ)时,同步更新日志采集点清单,明确哪些框架日志需重定向或过滤。
一份好的日志规范,是写给未来自己和同事看的“系统旁白”。它不追求完美,但必须清晰、可执行、可验证。
Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南










