WebFlux API 局部异常处理

见解分享

2024-01-03 11:37:40

引言

在构建 RESTful API 时，处理异常至关重要。Spring WebFlux 提供了强大的功能来处理异常，包括全局和局部异常处理。本文重点介绍局部异常处理，它允许我们在控制器级别处理异常，从而实现更细粒度的错误处理。

全局异常处理

Spring WebFlux 提供了 @ControllerAdvice 注解，它允许我们在全局范围内处理异常。该注解可以应用于控制器类，它将拦截所有控制器方法的异常。全局异常处理程序适用于需要在整个应用程序中一致处理的异常场景。

局部异常处理

局部异常处理允许我们在控制器方法级别处理异常。这提供了比全局异常处理更细粒度的控制，因为它允许我们根据每个方法的不同需求定制错误响应。有两种主要方法可以在 WebFlux 中实现局部异常处理：

1. 使用 @ResponseStatus 注解

@ResponseStatus 注解允许我们在控制器方法上指定 HTTP 状态码。当方法抛出异常时，它将覆盖默认的 500 内部服务器错误状态码。例如：

@PostMapping("/")
@ResponseStatus(HttpStatus.BAD_REQUEST)
public Mono<Void> create(@RequestBody MyObject object) {
    // 业务逻辑
}

当 create() 方法抛出异常时，它将返回 400 错误响应，而不是默认的 500 错误。

2. 使用 ResponseEntityExceptionHandler

ResponseEntityExceptionHandler 是一个抽象类，它提供了处理异常并将其转换为 HTTP 响应的功能。我们可以在控制器类中扩展它来处理局部异常。例如：

@RestController
public class MyController implements ResponseEntityExceptionHandler {

    @Override
    protected ResponseEntity<Object> handleMethodArgumentNotValid(MethodArgumentNotValidException ex, HttpHeaders headers, HttpStatus status, WebRequest request) {
        // 处理 MethodArgumentNotValidException 异常
        return ResponseEntity.badRequest().body(ex.getMessage());
    }
}