Java 自定义异常日志记录怎么统一封装

风磊同学_6931

风磊同学_6931

2026-10-26

630人浏览

原创

Java自定义异常日志统一封装的核心是收口异常捕获、日志输出、上下文补充和响应处理:通过@ControllerAdvice统一拦截、MDC增强日志上下文、工具类联动抛异常与打日志,并为非Web场景提供AOP或主动try-catch兜底方案。

java 自定义异常日志记录怎么统一封装

Java 自定义异常的日志记录统一封装,核心是把异常捕获、日志输出、上下文补充和响应处理这几个环节收口到一个可控的点,避免到处 log.error("xxx", e) 或 e.printStackTrace() 这类散落写法。

统一异常处理器(@ControllerAdvice + @ExceptionHandler)

适用于 Spring Web 项目,集中拦截 Controller 层抛出的自定义异常,并做标准化日志记录和响应封装:

  • 定义自定义异常类(如 BusinessException),继承 RuntimeException,支持携带错误码、提示信息、扩展参数
  • 用 @ControllerAdvice 声明全局异常处理器,在其中用 @ExceptionHandler(BusinessException.class) 拦截
  • 在处理方法中统一调用日志框架(如 SLF4J)记录完整上下文:异常类型、错误码、消息、请求路径、用户ID(如有)、traceId(配合 MDC)
  • 示例关键代码:
      log.error("业务异常[{}],msg={},path={},uid={},traceId={}",
        e.getErrorCode(), e.getMessage(), request.getRequestURI(),
        SecurityContext.getUserId(), MDC.get("traceId")), e);

日志上下文增强(MDC + Filter/Interceptor)

让每条日志自动带上请求唯一标识和关键业务字段,无需每次手动传参:

Java注释规范Skills
Java注释规范Skills

当用户要求为 Java 代码添加注释、修改注释、审查注释、整理注释格式,或要求按照代码注释规范处理 Java 文件时,使用本技能。本技能用于统一生成和维护 Java 类注释模板、按 Git 对比 release 判断版本号、补充每行代码上方中文块注释、调整注释空行规则,并保持 Java 文件 UTF-8 无 BOM 编码。典型触发场景包括:补充类注释、更新 @version、检查 @author 来源、整理行尾注释、把注释放到代码上一行、检查注释是否符合规范、构建前检查 Java 注释风格。

下载
  • 在 WebFilter 或 HandlerInterceptor 中生成并注入 traceId、requestId、userId 等到 MDC
  • 确保日志配置(如 logback.xml)中 pattern 包含 %X{traceId} 等占位符
  • 异常发生时,即使没显式打印,日志里也天然带上下文,便于链路追踪和问题定位
  • 注意在线程切换(如异步、线程池)时需手动传递 MDC 内容,可用 MDC.getCopyOfContextMap() 保存再恢复

异常构造与日志联动(推荐封装工具类)

避免开发者手动 new 异常 + 单独打日志,把“抛异常”和“记日志”逻辑绑定:

  • 提供静态工具方法,如 Exceptions.business("USER_NOT_FOUND").withParam("uid", 123).throwAndLog();
  • 内部完成三件事:构建异常对象、用 SLF4J 记录带上下文的 ERROR 日志、再 throw 出去
  • 可选支持自动填充当前类名、方法名、行号(通过 Thread.currentThread().getStackTrace() 获取)
  • 这样既保证日志必打,又避免漏掉异常信息或上下文缺失

非 Web 场景(Service/Job/Utils)的兜底方案

对于非 Controller 的普通方法(如定时任务、工具类),无法依赖 @ControllerAdvice,需主动防御:

  • 约定所有 service 方法入口加 try-catch(慎用,仅关键路径),捕获自定义异常后统一 log.error + rethrow
  • 使用 AOP 对指定包下的方法做环绕通知,捕获异常后按规则记录日志(注意避免影响性能和吞吐)
  • 对关键第三方调用(如 HTTP、DB)做包装,失败时统一转为自定义异常并记录详细入参和响应体

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

11237

6

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

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

2023.07.05

8342

9

java自学难吗
java自学难吗

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

2023.07.31

7212

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

2969

5

java在线网站
java在线网站

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

2023.08.03

20231

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人学习