Java 中自定义异常怎么记录详细的业务错误日志

梦磊大大_8174

梦磊大大_8174

2026-10-24

763人浏览

原创

java自定义异常不负责日志记录,需在抛出或捕获时结合slf4j等框架主动记录业务上下文;应封装orderid、userid等字段并提供tologstring(),在catch块中用占位符结构化输出,全局异常处理器补充traceid等请求信息,并通过json日志和mdc配置提升可检索性。

java 中自定义异常怎么记录详细的业务错误日志

Java 中自定义异常本身不负责记录日志,关键在于抛出异常时或捕获异常后,主动将业务上下文信息写入日志。要记录详细的业务错误日志,需结合自定义异常的构造能力、日志框架(如 SLF4J + Logback)以及合理的日志位置设计。

在自定义异常中封装关键业务字段

让异常携带可读性强、便于排查的业务数据,而不是只依赖堆栈。例如订单场景:

  • 在异常类中添加 orderId、userId、businessCode、errorMessage 等字段
  • 重写 toString() 或提供 toLogString() 方法,返回结构化日志内容
  • 避免在异常中直接打印日志(违反单一职责),只做信息承载
示例:
public class BusinessException extends RuntimeException {
    private final String orderId;
    private final Long userId;
    private final String businessCode;

    public BusinessException(String message, String orderId, Long userId, String businessCode) {
        super(message);
        this.orderId = orderId;
        this.userId = userId;
        this.businessCode = businessCode;
    }

    public String toLogString() {
        return String.format("BusinessException[order=%s, user=%d, code=%s, msg=%s]",
                orderId, userId, businessCode, getMessage());
    }
}

在 catch 块中使用结构化日志输出

不要只写 log.error("出错了", e),而应把异常携带的业务字段和原始异常一起记录:

  • 用 SLF4J 的 {} 占位符传入业务参数,避免字符串拼接影响性能
  • 确保 异常对象作为最后一个参数传入,才能正确打印堆栈
  • 对敏感字段(如手机号、身份证号)做脱敏处理再记录
示例:
try {
    processOrder(order);
} catch (BusinessException e) {
    log.error("订单处理失败 order={} user={} code={} detail={}", 
               e.getOrderId(), e.getUserId(), e.getBusinessCode(), e.getMessage(), e);
}

统一异常处理层补充上下文信息

在 Spring MVC 的 @ControllerAdvice 或 WebFilter 中,可自动注入请求级上下文:

  • 获取当前 traceId、requestId、客户端 IP、URI、HTTP 方法等
  • 将这些信息与业务异常合并,构建完整日志事件
  • 避免每个 service 层都重复获取和拼接,提升一致性和可维护性
示例(在全局异常处理器中):
@ExceptionHandler(BusinessException.class)
public ResponseEntity> handleBusinessException(BusinessException e, HttpServletRequest request) {
    String traceId = MDC.get("traceId");
    log.warn("BusinessException caught [trace={}, uri={}, method={}, {}]", 
              traceId, request.getRequestURI(), request.getMethod(), e.toLogString(), e);
    return ResponseEntity.badRequest().body(...);
}

日志配置支持业务字段快速检索

光记录不够,还要方便查。通过日志框架配置增强可搜索性:

  • 在 Logback 的 PatternLayout 中加入 MDC 字段,如 %X{traceId} %X{userId}
  • 使用 JSON 日志格式(如 logstash-logback-encoder),让 order_id、error_code 等成为独立字段,便于 ELK/Kibana 聚合分析
  • 为不同业务模块设置独立 logger name(如 com.example.order),便于按包隔离日志

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

11117

6

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

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

2023.07.05

8242

9

java自学难吗
java自学难吗

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

2023.07.31

7112

8

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

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

2023.08.01

1204

3

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

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

2023.08.02

968

3

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

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

2023.08.02

1436

5

java有什么用
java有什么用

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

2023.08.02

2929

5

java在线网站
java在线网站

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

2023.08.03

20191

3

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

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

2023.08.03

1295

8

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习