Java 中日志记录怎么规范异常日志的输出格式

大静同学_8911

大静同学_8911

2026-09-30

129人浏览

原创

java异常日志需结构化输出:用logger.error("msg", e)保留堆栈,显式携带订单号等业务上下文,脱敏敏感信息,区分error/warn级别,并采用json结构化日志便于elk检索。

java 中日志记录怎么规范异常日志的输出格式

Java 中规范异常日志输出,核心是让日志具备可读性、可追溯性和可排查性。关键不是只打印 e.toString() 或空泛的“出错了”,而是结构化呈现:谁(类/方法)、何时(时间戳)、在哪(行号)、发生了什么(异常类型+消息)、为什么(完整堆栈+上下文参数)。

用 logger.error() 记录异常,且传入 Throwable 对象

这是最基础也最容易被忽略的一点。不要手动拼接堆栈或只打异常消息。

  • ✅ 正确写法:logger.error("订单支付失败,订单号: {}", orderNo, e); —— SLF4J / Logback 会自动将 e 的完整堆栈写入日志末尾
  • ❌ 错误写法:logger.error("订单支付失败,订单号: {},异常: {}", orderNo, e.getMessage()); —— 丢失堆栈,无法定位根因
  • ❌ 错误写法:logger.error("订单支付失败", e); —— 缺少关键业务上下文(如订单号、用户ID),查问题时要反复翻日志关联

在日志中显式带上关键业务上下文

异常本身是技术事实,但“为什么在这个场景发生”依赖业务参数。仅靠堆栈无法还原现场。

deep-java-review
deep-java-review

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

下载
  • 记录能唯一标识操作的字段:订单号、用户ID、请求ID(traceId)、接口路径等
  • 避免记录敏感信息:密码、身份证号、银行卡号等需脱敏或禁止落盘
  • 示例:logger.error("调用短信网关超时,手机号: {}, templateId: {}, 耗时: {}ms", maskPhone(phone), templateId, costMs, e);

区分 error 和 warn,避免日志污染

不是所有异常都该记为 ERROR 级别。日志级别混乱会让真正的问题被淹没。

  • ERROR:系统级故障、数据不一致、外部服务不可用、无法降级的失败(如扣款成功但通知失败)
  • WARN:预期外但可恢复的情况,如缓存穿透后查库成功、第三方接口返回非200但业务可兜底(如默认头像)
  • 对可预期的业务异常(如“余额不足”),通常不打 ERROR,而是在业务逻辑中处理并返回友好提示;若需审计,可用 INFO + 结构化字段

配置日志框架支持结构化与可检索

格式再规范,如果日志是纯文本且无字段分隔,排查效率仍低。建议启用结构化日志能力:

  • Logback + logstash-logback-encoder:输出 JSON 格式,含 timestamp、level、class、method、line、traceId、orderNo、exception 等字段
  • 确保 pattern 中包含 %throwable 或 encoder 显式处理异常对象,避免堆栈被截断
  • 在日志平台(如 ELK、阿里SLS)中按 traceId 聚合全链路日志,结合异常堆栈快速下钻

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

相关文章

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

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

下载

相关标签:

java java异常 json

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

相关专题

更多
java
java

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

2023.06.15

9357

6

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

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

2023.07.05

6522

9

java自学难吗
java自学难吗

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

2023.07.31

5812

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

2469

5

java在线网站
java在线网站

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

2023.08.03

19811

3

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

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

2023.08.03

1115

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习