讲师中心 微信公众号

工具推荐

视频效率加速
立刻MV
立刻MV

低成本歌曲 MV、视频生成

updream

一键生成高质量推广成片

Seko
Seko

AI短剧一键生成成片

Laper
Laper

剧本策划到成片协作

Java 自定义异常中 Problem Detail RFC 7807 怎么实现

老丽君_6200

老丽君_6200

发布时间:2026-11-16 11:30:21

|

516人浏览过

|

来源于php中文网

原创

在 java 中实现 rfc 7807 problem detail,核心是定义一个符合规范的 json 结构并配置 spring boot 的全局异常处理器。具体做法是创建一个包含 type、title、status、detail 等字段的 dto 类,然后使用 @controlleradvice 捕获业务异常,将其转换为该 dto 并通过 responseentity 返回。这样当发生错误时,客户端会收到标准的 http 4xx/5xx 响应及对应的 json 描述。

Java 自定义异常中 Problem Detail RFC 7807 怎么实现

如何定义符合 RFC 7807 的 JSON 数据结构

要实现标准格式,需要创建一个 Java 类来映射 JSON 字段。该类必须包含 type(问题类型 URI)、title(简短标题)和 status(HTTP 状态码),而 detail(详细解释)和 instance(实例 URI)则是可选的。推荐使用 Jackson 注解来控制序列化行为,确保字段名与 RFC 规范一致。

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.annotation.JsonProperty;

@JsonInclude(JsonInclude.Include.NON_NULL)
public class ProblemDetail {
    private String type;
    private String title;
    private int status;
    private String detail;
    private String instance;

    public ProblemDetail(String type, String title, int status, String detail) {
        this.type = type;
        this.title = title;
        this.status = status;
        this.detail = detail;
    }

    // Getters and Setters omitted for brevity
}

上述代码定义了基础结构。通过 @JsonInclude(JsonInclude.Include.NON_NULL),如果某个字段为空(如 detail),它将被排除在 JSON 输出之外,这符合 RFC 7807 中关于可选字段的规定。在实际使用中,你可以根据不同的错误场景填充这些字段。

如何在全局异常处理器中统一返回 Problem Detail

为了让所有控制器自动应用这一格式,需要编写一个全局异常处理类。利用 @RestControllerAdvice 拦截抛出的自定义异常,并将其转换为 ProblemDetail 对象。关键在于设置正确的 HTTP 状态码,并确保响应头正确无误。这样,无论哪个 Controller 抛出异常,客户端都能获得一致的响应格式。

Build Java agent transport gateways with Atmosphere
Build Java agent transport gateways with Atmosphere

使用Atmosphere构建通过WebSocket、SSE、gRPC、WebTransport、MCP、A2A和AG-UI流传输的JVM代理网关,并带有治理钩子。

下载

立即学习“Java免费学习笔记(深入)”;

import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;

@ControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(ResourceNotFoundException.class)
    public ResponseEntity<ProblemDetail> handleNotFound(ResourceNotFoundException ex) {
        ProblemDetail problem = new ProblemDetail(
            "https://example.com/errors/not-found",
            "Resource Not Found",
            HttpStatus.NOT_FOUND.value(),
            ex.getMessage()
        );
        return new ResponseEntity<>(problem, HttpStatus.NOT_FOUND);
    }

    @ExceptionHandler(IllegalArgumentException.class)
    public ResponseEntity<ProblemDetail> handleBadRequest(IllegalArgumentException ex) {
        ProblemDetail problem = new ProblemDetail(
            "https://example.com/errors/bad-request",
            "Bad Request",
            HttpStatus.BAD_REQUEST.value(),
            ex.getMessage()
        );
        return new ResponseEntity<>(problem, HttpStatus.BAD_REQUEST);
    }
}

这段代码展示了如何处理两种常见异常。对于 ResourceNotFoundException,返回 404 状态码;对于 IllegalArgumentException,返回 400 状态码。每个处理器都构建了一个 ProblemDetail 实例,其中 type 指向具体的错误文档,detail 提供用户友好的消息。这种集中处理方式避免了在每个 Controller 中重复编写错误响应逻辑。

当自定义异常未指定 message 时,detail 字段会显示什么

如果在抛出异常时没有提供具体的错误信息,即调用无参构造函数或 super(),那么 ex.getMessage() 将返回 null。由于我们在 ProblemDetail 类中使用了 @JsonInclude(JsonInclude.Include.NON_NULL),这个 null 值会导致 detail 字段被完全省略,而不是显示为 null 字符串。这确保了 JSON 响应的简洁性,符合 RFC 7807 对可选字段的行为定义。

热门AI工具

更多
蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

咔片AIPPT

一款在线AI演示文稿制作工具,可根据主题和内容需求辅助生成PPT结构与页面,提高演示材料制作效率。

函子Zion

一款支持AI搭建、可视化编辑和多端发布的全栈无代码开发平台。

PixTV
PixTV Hot

PixTV是一款面向AIGC内容创作的AI视频生成工具。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

PixPix
PixPix Hot

PixPix是一款面向电商视觉生产的AI商品图生成工具。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

相关专题

更多
java
java

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

12717

2023.06.15

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

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

9802

2023.07.05

java自学难吗
java自学难吗

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

8332

2023.07.31

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

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

1344

2023.08.01

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

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

1068

2023.08.02

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

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

1596

2023.08.02

java有什么用
java有什么用

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

3329

2023.08.02

java在线网站
java在线网站

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

20551

2023.08.03

Go-Zero API开发使用教程
Go-Zero API开发使用教程

本专题聚焦Go-Zero的API开发,拆解.api描述文件的语法结构、路由与分组定义、参数绑定与校验规则,说明统一响应体、JWT鉴权、跨域与接口文档生成的落地方式,并给出网关聚合与接口测试的实践建议。

120

2026.11.12

热门下载

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

精品课程

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

共0课时 | 0人学习

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

共0课时 | 0人学习

关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn