Java 中日志记录怎么编写规范的日志输出语句

轻杰酱_9497

轻杰酱_9497

2026-09-29

729人浏览

原创

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

java 中日志记录怎么编写规范的日志输出语句

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() 处理。

deep-java-review
deep-java-review

Java项目代码review工具。分析Git变更+完整调用链路上下文,推断业务需求,进行多维度评分和分类汇总,生成完整PRD文档。包含细粒度Java代码审查清单(Null安全、异常处理、Streams、并发、equals/hashCode、资源管理、API设计、性能、MyBatis/ORM、事务边界、SQL/DD...

下载

记录关键上下文,但绝不打印明文密码、身份证、手机号等敏感数据

好日志 = 可追溯 + 可脱敏。例如:

  • ✅ 记录脱敏后的用户标识:"用户手机号尾号 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 即可,日志框架会递归展开。

Java免费学习笔记:立即使用
解锁 Java 大师之旅:从入门到精通的终极指南

相关文章

PHP速学视频免费教程(入门到精通)
PHP速学视频免费教程(入门到精通)

PHP怎么学习?PHP怎么入门?PHP在哪学?PHP怎么学才快?不用担心,这里为大家提供了PHP速学教程(入门到精通),有需要的小伙伴保存下载就能学习啦!

下载

相关标签:

java

本站声明:本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系admin@php.cn

相关专题

更多
java
java

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

2023.06.15

9277

6

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

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

2023.07.05

6442

9

java自学难吗
java自学难吗

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

2023.07.31

5752

8

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

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

2023.08.01

1024

3

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

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

2023.08.02

848

3

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

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

2023.08.02

1216

5

java有什么用
java有什么用

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

2023.08.02

2449

5

java在线网站
java在线网站

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

2023.08.03

19791

3

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

配置Java环境变量是为了让操作系统能够识别和使用Java的相关命令和功能。本专题为大家提供配置java环境变量相关文章,帮助大家解决问题。

2023.08.03

1095

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习