Spring Boot 3 中将 HttpStatus 迁移到 HttpStatusCode

Spring Boot 3.3.3 引入了HttpStatusCode，通过允许我们定义自定义状态代码来解决此限制。这提供了一种更灵活的方式来处理 HTTP 状态代码，并为常用状态代码提供实例方法，例如is2xxSuccessful()和is3xxRedirection()，最终允许对响应处理进行更精细的控制。

在本文中，我们将介绍如何在 Spring Boot 应用程序中使用HttpStatusCode，重点介绍版本 3.3.3 中引入的最新增强功能。通过这些增强功能，HttpStatusCode已合并到HttpStatus实现中，从而简化了我们使用 HTTP 状态代码的方式。

这些改进的主要目的是提供一种更灵活、更可靠的方法来处理标准和自定义 HTTP 状态代码，使我们在处理 HTTP 响应时具有更高的灵活性和可扩展性，同时保持向后兼容性。

HttpStatus枚举器
在 Spring 3.3.3 之前，HTTP 状态代码在HttpStatus中以枚举形式表示。这限制了自定义或非标准 HTTP 状态代码的使用，因为枚举是一组固定的预定义值。

尽管HttpStatus类尚未被弃用，但一些返回原始整数状态代码的枚举和方法（例如getRawStatusCode()和rawStatusCode() ）现已被弃用。不过，使用@ResponseStatus注释来提高代码的可读性仍然是推荐的方法。

我们还可以将HttpStatus与HttpStatusCode结合使用，以实现更灵活的 HTTP 响应管理：

@GetMapping("/exception")
public ResponseEntity<String> resourceNotFound() {
    HttpStatus statusCode = HttpStatus.NOT_FOUND;
    if (statusCode.is4xxClientError()) {
        return new ResponseEntity<>("Resource not found", HttpStatusCode.valueOf(404));
    }
    return new ResponseEntity<>("Resource found", HttpStatusCode.valueOf(200));
}

HttpStatusCode接口​
HttpStatusCode接口旨在支持除HttpStatus中预定义的状态代码之外的自定义状态代码。它有 8 个实例方法：

• is1xxInformational()
• is2xxSuccessful()
• is3xxRedirection()
• is4xxClientError()
• is5xxServerError()
• isError()
• isSameCodeAs(HttpStatusCode other)
• value()

这些方法不仅增加了处理不同 HTTP 状态的灵活性，而且简化了检查响应类别的流程，提高了状态码管理的清晰度和效率。

让我们看一个例子来了解我们如何在实践中使用它们：

@GetMapping("/resource")
public ResponseEntity successStatusCode() {
    HttpStatusCode statusCode = HttpStatusCode.valueOf(200);
    if (statusCode.is2xxSuccessful()) {
        return new ResponseEntity("Success", statusCode);
    }
    return new ResponseEntity("Moved Permanently", HttpStatusCode.valueOf(301));
}

静态方法valueOf(int)
此方法返回给定int值的HttpStatusCode对象。输入参数必须是 3 位正数，否则会引发IllegalArgumentException。

valueOf()将状态代码映射到HttpStatus中的相应枚举值。如果没有现有条目与提供的状态代码匹配，则该方法默认返回DefaultHttpStatusCode的实例。

DefaultHttpStatusCode类实现了HttpStatusCode ，并提供了value()方法的直接实现，该方法返回用于初始化它的原始整数值。这种方法可确保所有 HTTP 状态代码（无论是自定义还是非标准）都易于使用：

@GetMapping("/custom-exception")
public ResponseEntity<String> goneStatusCode() {
    throw new ResourceGoneException("Resource Gone", HttpStatusCode.valueOf(410));
}

在自定义异常中使用HttpStatusCode
接下来，让我们看看如何在ExceptionHandler中使用带有HttpStatusCode的自定义异常。我们将使用@ControllerAdvice注释在所有控制器中全局处理异常，并使用@ExceptionHandler注释来管理自定义异常的实例。

这种方法将错误处理集中在 Spring MVC 应用程序中，从而使代码更清晰、更易于维护。

@ControllerAdvice和@ExceptionHandler
@ControllerAdvice全局处理异常，而@ExceptionHandler管理自定义异常实例以返回具有异常消息和状态代码的一致 HTTP 响应。

让我们看看如何在实践中使用这两个注释：

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(CustomException.class)
    public ResponseEntity<String> handleGoneException(CustomException e) {
        return new ResponseEntity<>(e.getMessage(), e.getStatusCode());
    }
}

自定义异常
接下来，让我们定义一个扩展RuntimeException并包含HttpStatusCode字段的CustomException类，启用自定义消息和 HTTP 状态代码，以便更精确地处理错误：

public class CustomException extends RuntimeException {
    private final HttpStatusCode statusCode;
    public CustomException(String message, HttpStatusCode statusCode) {
        super(message);
        this.statusCode = statusCode;
    }
    public HttpStatusCode getStatusCode() {
        return statusCode;
    }
}