如何创建携带自定义字段的异常类

老芳小哥_3237

老芳小哥_3237

2026-03-27

187人浏览

原创

如何创建携带自定义字段的异常类

本文详解如何在 java 中设计可序列化、含业务字段(如 personid、code、debugger)的自定义异常类,解决继承链中字段传递与 json 响应适配问题,并提供构造器设计、getter 封装及 spring 全局异常处理建议。

本文详解如何在 java 中设计可序列化、含业务字段(如 personid、code、debugger)的自定义异常类,解决继承链中字段传递与 json 响应适配问题,并提供构造器设计、getter 封装及 spring 全局异常处理建议。

在构建面向 API 的微服务时,客户端常期望异常响应具备结构化、业务语义明确的 JSON 格式(例如包含 personId、code、debugger 字段)。但 Java 异常机制本身不支持直接将任意字段“透传”给父类(如 RuntimeException 或 ProductsException),因此必须通过子类自主持有并管理业务字段,而非试图将其注入父类构造器。

✅ 正确做法:子类封装字段 + 提供完整构造器

CustomException 应作为独立的业务异常载体,显式声明所需字段,并提供带参构造器(含 cause 支持),同时避免依赖父类存储逻辑:

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 的无参构造(确保链路通畅)
        this.personId = Objects.requireNonNull(personId, "personId must not be null");
        this.code = Objects.requireNonNull(code, "code must not be null");
        this.debugger = Collections.unmodifiableList(
            Objects.requireNonNullElse(debugger, Collections.emptyList())
        );
    }

    // 带异常原因的构造器(推荐用于包装原始异常)
    public CustomException(String personId, String code, List<string> debugger, Throwable cause) {
        super(cause); // 正确传递 cause 给 ProductsException 父类
        this.personId = Objects.requireNonNull(personId, "personId must not be null");
        this.code = Objects.requireNonNull(code, "code must not be null");
        this.debugger = Collections.unmodifiableList(
            Objects.requireNonNullElse(debugger, Collections.emptyList())
        );
    }

    // 标准 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>

⚠️ 注意:不要重写 toString() 或 getMessage() 来拼接 JSON —— 序列化应由 Jackson 等框架基于 getter 自动完成;业务字段必须提供 public getter,否则 Spring Boot 默认 @RestControllerAdvice 无法反射获取值。

? 在 Controller 中正确抛出

避免在 catch 块中手动构建并立即 throw —— 这容易因异常未被捕获而中断流程。更健壮的方式是:

  1. 捕获原始异常(如 ProductsException);
  2. 提取必要信息(如从 e.getError().getErrorCode() 获取 code);
  3. 构造并抛出 CustomException:
@GetMapping("/products/{personId}")
public ResponseEntity> getProduct(@PathVariable String personId) {
    try {
        return ResponseEntity.ok(productService.getProducts(personId));
    } catch (ProductsException e) {
        // 提取原始错误信息,构造业务异常
        String errorCode = Optional.ofNullable(e.getError())
            .map(MyError::getErrorCode)
            .orElse("UNKNOWN_ERROR");

        List<string> debugInfo = Optional.ofNullable(e.getError())
            .map(err -> List.of(err.getMessage()))
            .orElse(Collections.emptyList());

        throw new CustomException(personId, errorCode, debugInfo, e);
    }
}</string>

? 全局异常处理(Spring Boot 推荐实践)

为统一返回格式,应在 @RestControllerAdvice 中捕获 CustomException 并映射为标准 JSON 响应:

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(CustomException.class)
    public ResponseEntity<map object>> handleCustomException(CustomException e) {
        Map<string object> response = new HashMap();
        response.put("personId", e.getPersonId());
        response.put("code", e.getCode());
        response.put("debugger", e.getDebugger());
        // 可额外添加 timestamp、status 等通用字段
        response.put("timestamp", Instant.now().toString());

        return ResponseEntity.status(HttpStatus.BAD_REQUEST).body(response);
    }
}</string></map>

此时客户端收到的响应即为预期结构:

{
  "personId": "1",
  "code": "PRODUCT_NOT_FOUND",
  "debugger": ["Product with ID '1' does not exist"]
}

✅ 关键总结

  • ❌ 错误认知:“把字段塞进 super() 就能被父类管理” → Java 异常链不支持字段继承;
  • ✅ 正确路径:子类自主持有字段 + 提供全参构造器 + 暴露 getter;
  • ✅ 安全实践:使用 Objects.requireNonNull 校验必填字段,Collections.unmodifiableList 防止外部篡改;
  • ✅ 生产就绪:配合 @RestControllerAdvice 实现响应标准化,解耦业务逻辑与错误渲染;
  • ? 调试提示:若仍遇“uncaught exception”,请检查是否遗漏 @ControllerAdvice 扫描包配置,或异常被更低层 try-catch 吞没而未向上抛出。

通过该模式,你既能保持异常的语义丰富性,又能无缝对接 REST API 的 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万人学习