如何在自定义异常中封装结构化业务字段并正确抛出

老芳小哥_3237

老芳小哥_3237

2026-03-27

541人浏览

原创

如何在自定义异常中封装结构化业务字段并正确抛出

本文详解如何设计可序列化的自定义异常类,通过构造函数注入业务字段(如 personid、code、debugger),避免字段丢失,并确保异常能被全局处理器捕获与标准化响应。

本文详解如何设计可序列化的自定义异常类,通过构造函数注入业务字段(如 personid、code、debugger),避免字段丢失,并确保异常能被全局处理器捕获与标准化响应。

在 Spring Boot 等现代 Java Web 应用中,仅继承 RuntimeException 并添加字段是不够的——若未正确初始化父类或未提供合理构造逻辑,异常对象可能无法携带关键上下文,导致下游(如全局异常处理器)无法提取 personId、code 等字段生成符合 API 规范的 JSON 响应(例如 { "personId": "1", "code": "1", "debugger": [...] })。

✅ 正确做法:显式构造 + 字段封装 + 可选 cause 传递

自定义异常类不能将业务字段“透传”给 super()(因为 RuntimeException 不接受这些参数),而应由子类自身持有并管理。关键在于:

  • 提供含全部业务字段的公有构造函数;
  • 支持传入原始异常 cause,以保留堆栈和根本原因;
  • 避免依赖 Lombok 的 @Builder 单独构建(因 Builder 不调用父类构造逻辑,且易遗漏 super(...) 初始化);
  • 如需 JSON 序列化输出,字段必须为 public 或配备标准 getter(推荐后者,兼顾封装性与 Jackson 兼容性)。

以下是推荐实现:

@NoArgsConstructor // 供框架反序列化/代理等场景使用(非必需但建议)
public class CustomException extends ProductsException {

    private final String personId;
    private final String code;
    private final List<string> debugger;

    // 主构造:仅业务字段
    public CustomException(String personId, String code, List<string> debugger) {
        super(); // 调用 ProductsException 的无参构造(注意:此时 error 为 null,需确保上层不依赖它)
        this.personId = personId;
        this.code = code;
        this.debugger = Collections.unmodifiableList(new ArrayList(debugger));
    }

    // 带 cause 的构造:保留原始异常链
    public CustomException(String personId, String code, List<string> debugger, Throwable cause) {
        super(cause); // 正确委托给父类带 cause 的构造器
        this.personId = personId;
        this.code = code;
        this.debugger = Collections.unmodifiableList(new ArrayList(debugger));
    }

    // 标准 getter —— Jackson 默认通过 getter 序列化字段
    public String getPersonId() { return personId; }
    public String getCode() { return code; }
    public List<string> getDebugger() { return debugger; }

    // (可选)重写 getMessage 用于日志或调试,不影响 JSON 响应结构
    @Override
    public String getMessage() {
        return String.format("CustomException[personId=%s, code=%s, debugger=%s]", 
            personId, code, debugger);
    }
}</string></string></string></string>

⚠️ 注意事项与常见陷阱

  • 不要仅用 @Builder:CustomException.builder().personId("1").code("ERR_001").build() 会跳过 super() 调用,且 Lombok 默认生成的 Builder 构造器不支持 Throwable cause 注入,极易导致异常链断裂。
  • ProductsException 的兼容性:当前 ProductsException 构造器仅接受 Exception e,但未暴露 getErrorCode() 等方法。若需从 ProductsException 中提取 errorCode,请为其补充 getter:
    public class ProductsException extends RuntimeException {
        private final MyError error;
        // ... 构造器
        public MyError getError() { return error; }
        // 若 MyError 有 getErrorCode(),则可链式调用
    }
  • 全局异常处理器需识别该类型:确保 @ControllerAdvice 类中包含对 CustomException 的处理逻辑,例如:
    @ExceptionHandler(CustomException.class)
    public ResponseEntity<map object>> handleCustomException(CustomException e) {
        Map<string object> body = new HashMap();
        body.put("personId", e.getPersonId());
        body.put("code", e.getCode());
        body.put("debugger", e.getDebugger());
        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(body);
    }</string></map>
  • 线程安全与不可变性:使用 Collections.unmodifiableList 包装 debugger,防止外部修改影响异常状态一致性。

✅ 总结

设计面向 API 响应的自定义异常,核心是字段自主管理 + 构造器显式初始化 + 标准化访问接口。摒弃仅靠 Builder 或字段直赋的懒惰方式,通过多态构造函数覆盖不同使用场景(无因异常 / 嵌套异常),并配合全局异常处理器完成从 Java 异常到结构化 JSON 的无缝转换。如此,既满足客户端契约,又保障系统可观测性与可维护性。

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

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

下载

相关标签:

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

相关专题

更多
java
java

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

2023.06.15

12137

6

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

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

2023.07.05

9222

9

java自学难吗
java自学难吗

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

2023.07.31

7892

8

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

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

2023.08.01

1284

3

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

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

2023.08.02

1028

3

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

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

2023.08.02

1536

5

java有什么用
java有什么用

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

2023.08.02

3169

5

java在线网站
java在线网站

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

2023.08.03

20431

3

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

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

2023.08.03

1395

8

热门下载

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

精品课程

更多
热门推荐
/
最新课程
phpStudy极速入门视频教程
phpStudy极速入门视频教程

共6课时 | 54.7万人学习

独孤九贱(4)_PHP视频教程
独孤九贱(4)_PHP视频教程

共89课时 | 134.1万人学习