错误响应 (Error Responses) | Spring Framework6.1.13中文文档|Spring官方文档|SpringBoot 教程|Spring中文网

REST 服务的常见要求是在错误正文中包含详细信息反应。Spring Framework 支持“HTTP API 的问题详细信息” 规范，RFC 9457。spring-doc.cn

以下是此支持的主要抽象：spring-doc.cn

ProblemDetail— RFC 9457 问题详细信息的表示形式;一个简单的容器对于规范中定义的标准字段和非标准字段。spring-doc.cn
ErrorResponse— 用于公开 HTTP 错误响应详细信息（包括 HTTP）的合约 status、响应标头和 RFC 9457 格式的正文;这允许封装并公开它们如何映射到 HTTP 响应的详细信息。所有 Spring WebFlux exceptions 实现此目的。spring-doc.cn
ErrorResponseException— 其他人的基本实现可以用作方便的基类。ErrorResponsespring-doc.cn
ResponseEntityExceptionHandler— 处理所有 Spring WebFlux 异常的 @ControllerAdvice 的便捷基类，和 any ，并呈现带有正文的错误响应。ErrorResponseExceptionspring-doc.cn

呈现

您可以从任何或 from 返回或从 any 方法呈现 RFC 9457 响应。其处理方式如下：ProblemDetailErrorResponse@ExceptionHandler@RequestMappingspring-doc.cn

的属性确定 HTTP 状态。statusProblemDetailspring-doc.cn
的属性是从当前 URL 路径设置的，如果没有已经设置好了。instanceProblemDetailspring-doc.cn
对于内容协商，Jackson 更喜欢 “application/problem+json”而不是“application/json”，当渲染如果未找到兼容的媒体类型，则还会回退到它。HttpMessageConverterProblemDetailspring-doc.cn

要为 Spring WebFlux 异常和 any 启用 RFC 9457 响应，请扩展并将其声明为 Spring 配置中的 @ControllerAdvice。处理程序具有处理任何异常的方法，该方法包括所有内置的 Web 例外。您可以添加更多异常处理方法，并且使用 protected 方法将任何异常映射到 .ErrorResponseExceptionResponseEntityExceptionHandler@ExceptionHandlerErrorResponseProblemDetailspring-doc.cn

非标准字段

请参阅 Servlet 堆栈中的等效项spring-doc.cn

您可以通过以下两种方式之一扩展包含非标准字段的 RFC 9457 响应。spring-doc.cn

第一，插入的 “属性” 中。使用 Jackson 时库，Spring Framework 寄存器确保 “properties” 被解包并呈现为 response，同样，反序列化期间的任何未知属性都会入到这。MapProblemDetailProblemDetailJacksonMixinMapMapspring-doc.cn

您还可以扩展以添加专用的非标准属性。中的 copy 构造函数允许子类易于创建从现有的 .这可以集中完成，例如，从这样一个将异常重新创建到具有附加非标准字段的子类中。ProblemDetailProblemDetailProblemDetail@ControllerAdviceResponseEntityExceptionHandlerProblemDetailspring-doc.cn

定制和 i18n

请参阅 Servlet 堆栈中的等效项spring-doc.cn

自定义和国际化错误响应详细信息是一个常见的要求。自定义 Spring WebFlux 异常的问题详细信息也是一种很好的做法以避免泄露实现细节。本节介绍对此的支持。spring-doc.cn

An 公开了 “type”、“title” 和 “detail” 的消息代码，以及 “detail” 字段的消息代码参数。解决这些字段，并相应地更新相应的字段。ErrorResponseResponseEntityExceptionHandlerProblemDetailspring-doc.cn

消息代码的默认策略遵循以下模式：spring-doc.cn

problemDetail.[type|title|detail].[fully qualified exception class name]spring-doc.cn

可以公开多个消息代码，通常会添加后缀设置为默认消息代码。下表列出了 Spring WebFlux 异常：ErrorResponsespring-doc.cn

例外消息代码消息代码参数

例外	消息代码	消息代码参数
`HandlerMethodValidationException`spring-doc.cn	（默认）spring-doc.cn	`{0}`列出所有验证错误。每个错误的消息代码和参数也通过解决。`MessageSource`spring-doc.cn
`MethodNotAllowedException`spring-doc.cn	（默认）spring-doc.cn	`{0}`当前 HTTP 方法，支持的 HTTP 方法列表`{1}`spring-doc.cn
`MissingRequestValueException`spring-doc.cn	（默认）spring-doc.cn	`{0}`值的标签（例如 “Request Header”、“Cookie Value”等）、值名称`{1}`spring-doc.cn
`NotAcceptableStatusException`spring-doc.cn	（默认）spring-doc.cn	`{0}`支持的媒体类型列表spring-doc.cn
`NotAcceptableStatusException`spring-doc.cn	（默认） + “.parseError”spring-doc.cn
`ServerErrorException`spring-doc.cn	（默认）spring-doc.cn	`{0}`提供给类构造函数的失败原因spring-doc.cn
`UnsupportedMediaTypeStatusException`spring-doc.cn	（默认）spring-doc.cn	`{0}`不支持的媒体类型，支持的媒体类型列表`{1}`spring-doc.cn
`UnsupportedMediaTypeStatusException`spring-doc.cn	（默认） + “.parseError”spring-doc.cn
`UnsatisfiedRequestParameterException`spring-doc.cn	（默认）spring-doc.cn	`{0}`参数条件列表spring-doc.cn
`WebExchangeBindException`spring-doc.cn	（默认）spring-doc.cn	`{0}`全局错误列表，字段错误列表。每个错误的消息代码和参数也通过解决。`{1}MessageSource`spring-doc.cn

HandlerMethodValidationExceptionspring-doc.cn

呈现

非标准字段

定制和 i18n

客户处理