Java Spring MVC 怎么通过异常处理器返回标准的 RFC 错误响应报文

冷炫風刃

冷炫風刃

2026-08-02

499人浏览

原创

spring mvc可通过@controlleradvice+@exceptionhandler结合problemdetail类实现rfc 7807标准异常响应,返回含type、title、status、detail、instance字段的application/problem+json格式json,无需手动拼接。

java spring mvc 怎么通过异常处理器返回标准的 rfc 错误响应报文

Spring MVC 可以通过 @ControllerAdvice + @ExceptionHandler 统一捕获异常,并按 RFC 7807(Problem Details for HTTP APIs)规范构造标准错误响应体,同时设置对应 HTTP 状态码。

使用 RFC 7807 标准定义错误响应结构

RFC 7807 要求响应体是 JSON,包含至少 typetitlestatus 三个字段,推荐加上 detailinstance。Spring Boot 2.3+ 内置了 ProblemDetail 类(位于 org.springframework.http.ProblemDetail),可直接用于构建合规响应。

  • type:机器可读的错误类型 URI(如 "https://example.com/problems/validation-failed"),不一定是真实可访问链接
  • title:简短、人类可读的错误概要(如 "Validation Failed"
  • status:HTTP 状态码(必须与响应状态一致)
  • detail:具体错误原因(如字段校验失败详情)
  • instance:当前请求唯一标识(可选,常设为请求路径或 traceId)

编写全局异常处理器

创建一个 @ControllerAdvice 类,用 @ExceptionHandler 拦截特定异常,并返回 ResponseEntity<problemdetail></problemdetail>

Java JDK 25
Java JDK 25

Java JDK 25 来自 OpenJDK 官方归档,版本为 JDK 25,本条下载地址已指向官方 Windows x64 zip 安装包直链,适合调试旧项目或兼容旧版 Java 运行环境。

下载
@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public ResponseEntity<problemdetail> handleValidationException(
            MethodArgumentNotValidException ex, HttpServletRequest request) {

        ProblemDetail problemDetail = ProblemDetail.forStatusAndDetail(
                HttpStatus.UNPROCESSABLE_ENTITY, "Validation failed");

        problemDetail.setTitle("Validation Error");
        problemDetail.setType(URI.create("https://example.com/problems/validation-failed"));
        problemDetail.setDetail(ex.getBindingResult().getFieldErrors().stream()
                .map(e -> e.getField() + ": " + e.getDefaultMessage())
                .collect(Collectors.joining("; ")));
        problemDetail.setInstance(URI.create(request.getRequestURI()));

        return ResponseEntity.status(HttpStatus.UNPROCESSABLE_ENTITY).body(problemDetail);
    }

    @ExceptionHandler(RuntimeException.class)
    public ResponseEntity<problemdetail> handleGenericException(
            RuntimeException ex, HttpServletRequest request) {

        ProblemDetail problemDetail = ProblemDetail.forStatusAndDetail(
                HttpStatus.INTERNAL_SERVER_ERROR, "An unexpected error occurred");

        problemDetail.setTitle("Internal Server Error");
        problemDetail.setType(URI.create("https://example.com/problems/internal-error"));
        problemDetail.setDetail(ex.getMessage());
        problemDetail.setInstance(URI.create(request.getRequestURI()));

        return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).body(problemDetail);
    }
}</problemdetail></problemdetail>

确保响应 Content-Type 正确且无额外包装

默认情况下,Spring 会将 ProblemDetail 序列化为 application/problem+json(RFC 7807 推荐 MIME 类型)。若需兼容旧客户端,也可显式设为 application/json

  • 保持 produces = MediaType.APPLICATION_PROBLEM_JSON_VALUE(推荐)
  • 若返回 application/json,需确认前端能解析该结构;Spring 默认支持,无需额外配置
  • 避免在响应体外再套一层 data 或 result 字段——RFC 7807 要求顶层即为 problem 对象

配合 Spring Boot 的自动配置启用 ProblemDetail 支持

Spring Boot 2.3+ 默认启用 ProblemDetail 支持。若使用更早版本(如 2.2.x),需手动引入依赖并注册序列化器:

  • 添加 spring-boot-starter-validation(校验场景必需)
  • 确保 Jackson 版本 ≥ 2.12(对 ProblemDetail 的序列化友好)
  • 无需自定义 ObjectMapper,Spring Boot 自动注册 ProblemDetail 的序列化逻辑

只要异常处理器返回 ProblemDetail 并正确设置状态码,Spring 就会生成符合 RFC 7807 的响应,无需手动拼 JSON 或操作 HttpServletResponse。

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

相关专题

更多
java
java

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

2023.06.15

3741

6

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

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

2023.07.05

2753

9

java自学难吗
java自学难吗

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

2023.07.31

2777

8

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

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

2023.08.01

635

3

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

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

2023.08.02

600

3

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

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

2023.08.02

705

5

java有什么用
java有什么用

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

2023.08.02

1288

5

java在线网站
java在线网站

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

2023.08.03

18844

3

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

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

2023.08.03

646

8

热门下载

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

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
Java JDBC数据库连接官方教程
Java JDBC数据库连接官方教程

共0课时 | 0人学习

Java 26官方文档
Java 26官方文档

共0课时 | 0人学习