Java规范日志需选对级别、用占位符避免拼接、脱敏敏感信息、记录完整异常堆栈;ERROR用于需人工介入的严重故障,WARN用于可降级的非预期情况,INFO记录关键业务节点,DEBUG仅限开发环境。

Java 中规范的日志输出,核心是 用对日志级别、避免字符串拼接、使用占位符、不泄露敏感信息、保持可读可检索。不是“记下发生了什么”,而是“让运维和开发者能快速定位问题”。
选对日志级别,不滥用 info 和 debug
级别混乱会让关键告警被淹没。基本原则:
- ERROR:发生异常且无法恢复(如数据库连接彻底失败、核心服务调用超时未降级),必须人工介入;
- WARN:非预期但可继续运行的情况(如第三方接口返回空数据、配置项缺失使用默认值);
- INFO:重要业务节点的完成确认(如“订单ID=123456 支付成功”“用户ID=789 登录成功”),不是每行都打;
- DEBUG:仅开发/测试环境开启,用于追踪内部状态(如“缓存 key=order:123456 命中率 0.82”),生产环境应关闭;
- TRACE(若支持):极细粒度,如方法入参/出参、SQL 绑定参数,慎用。
用占位符替代字符串拼接,兼顾性能与可读性
错误写法:log.info("处理用户 " + userId + " 的订单,金额:" + amount + ",状态:" + status);
问题:即使日志级别被关闭,字符串仍会拼接,浪费 CPU。
正确写法(以 SLF4J 为例):log.info("处理用户 {} 的订单,金额:{},状态:{}", userId, amount, status);
优势:仅当日志实际输出时才格式化,且语义清晰,便于日志平台按模板提取字段。
注意:如果参数可能为 null,SLF4J 默认输出 null 字符串,必要时先做非空判断或使用 Optional.ofNullable() 处理。
Java项目代码review工具。分析Git变更+完整调用链路上下文,推断业务需求,进行多维度评分和分类汇总,生成完整PRD文档。包含细粒度Java代码审查清单(Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...
记录关键上下文,但绝不打印明文密码、身份证、手机号等敏感数据
好日志 = 可追溯 + 可脱敏。例如:
立即学习“Java免费学习笔记(深入)”;
- ✅ 记录脱敏后的用户标识:
"用户手机号尾号 4321 下单"或"用户ID=U_abc789 提交支付请求"; - ✅ 记录请求唯一 ID(如 traceId):
"traceId=abc123 | 订单创建开始",方便全链路排查; - ❌ 不记录:
"用户密码=123456"、"身份证号=110101199001011234"; - ❌ 避免直接打印整个 request/response 对象(尤其含 headers/body),应提取关键字段并脱敏。
异常日志必须带完整堆栈,且优先记录 root cause
错误写法:log.error("订单创建失败"); —— 没有原因,等于没记。
更差写法:log.error("订单创建失败: " + e.getMessage()); —— 丢掉了堆栈和嵌套异常。
正确写法:log.error("订单创建失败,用户ID={},订单号={}", userId, orderId, e);
说明:SLF4J 会自动将最后一个 Throwable 参数作为异常附加到日志中,保留完整堆栈,且前面的占位符仍可定位上下文。
进阶建议:若捕获的是包装异常(如 ServiceException),可用 e.getCause() 判断是否需额外记录根因,但通常直接传 e 即可,日志框架会递归展开。

















