优雅处理自定义 HTTP 状态码：使用 ReasonPhrase 注解

2024-03-21 11:23:12

## 自定义 HTTP 状态码的优雅处理

引言

在构建 RESTful API 时，经常需要使用自定义 HTTP 状态码来传达特定错误或状态。但是，Spring Boot 的 HttpStatus 枚举并不总是包含我们所需的全部状态码。本文将介绍一种优雅的方法来使用 ReasonPhrase 注解处理自定义状态码。

问题

在使用 Spring Boot 时，通过 @ResponseStatus 注解可以轻松设置响应状态码。但是，当需要使用超出 HttpStatus 枚举范围的状态码时，我们就遇到了问题。

解决方案：ReasonPhrase 注解

Spring Boot 提供了 ReasonPhrase 注解，它允许我们指定自定义原因短语来非标准状态码。这可以非常方便地处理自定义状态码。

@ResponseStatus(value = HttpStatus.OK, reason = "Custom Status Code 210")

在上面的代码中，我们指定了状态码 210 并使用了原因短语 "Custom Status Code 210" 来描述它。

优点

使用 ReasonPhrase 注解具有以下优点：

清晰简洁： 它使用现有的 @ResponseStatus 注解，只需添加一个 reason 属性即可。
可扩展： 它允许处理任意数量的自定义状态码。
与 Spring Boot 生态系统集成： 它与 Spring Boot 框架无缝集成，无需额外的依赖项或配置。

使用示例

@RestController
public class CustomStatusCodeController {

    @GetMapping("/custom")
    @ResponseStatus(value = HttpStatus.OK, reason = "Custom Status Code 210")
    public String customStatusCode() {
        return "Custom Status Code 210";
    }
}