Java核心 - 使用 `@RestControllerAdvice` 代替满屏 `try...catch` 异常处理

作者：逍遥Sean
简介：一个主修Java的Web网站\游戏服务器后端开发者
主页：https://blog.csdn.net/Ureliable
觉得博主文章不错的话，可以三连支持一下~ 如有疑问和建议，请私信或评论留言！

前言
在构建 Java 应用程序时，异常处理是一个至关重要的部分。传统上，我们在每个可能出错的地方使用 try...catch 来处理异常，这可能会导致代码变得臃肿且难以维护。为了提升代码的整洁性和可读性，我们可以使用 @RestControllerAdvice 来集中处理异常。这种方法特别适合于 Spring Boot 应用程序，它使我们能够将异常处理逻辑从控制器中分离出来，从而保持控制器代码的简洁性。

使用 @RestControllerAdvice 代替满屏 try...catch 异常处理

什么是 @RestControllerAdvice？

@RestControllerAdvice 是 Spring 4 引入的一个注解，它结合了 @ControllerAdvice 和 @ResponseBody。@ControllerAdvice 允许你定义全局的异常处理、数据绑定和模型属性，而 @ResponseBody 确保返回的异常信息会被序列化成 JSON 格式，以适应 RESTful API 的需求。

为什么使用 @RestControllerAdvice？

1. 集中管理异常处理：将所有异常处理逻辑集中在一个地方，使得异常处理更具一致性和可维护性。
2. 提高代码可读性：避免在每个控制器方法中嵌套大量 try...catch，使控制器代码更简洁。
3. 简化异常响应：自动将异常转换为 JSON 响应，减少了手动处理响应的复杂度。

如何使用 @RestControllerAdvice？

1. 创建异常处理类

首先，创建一个类并使用 @RestControllerAdvice 注解。然后，定义方法来处理各种类型的异常。

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

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(ResourceNotFoundException.class)
    public ResponseEntity<String> handleResourceNotFoundException(ResourceNotFoundException ex) {
        return new ResponseEntity<>(ex.getMessage(), HttpStatus.NOT_FOUND);
    }

    @ExceptionHandler(IllegalArgumentException.class)
    public ResponseEntity<String> handleIllegalArgumentException(IllegalArgumentException ex) {
        return new ResponseEntity<>(ex.getMessage(), HttpStatus.BAD_REQUEST);
    }

    @ExceptionHandler(Exception.class)
    public ResponseEntity<String> handleGenericException(Exception ex) {
        return new ResponseEntity<>("An unexpected error occurred", HttpStatus.INTERNAL_SERVER_ERROR);
    }
}

在上面的代码中，我们定义了三个异常处理方法。每个方法都使用 @ExceptionHandler 注解来指定要处理的异常类型，并返回适当的 HTTP 状态码和错误消息。

2. 配置自定义异常

创建自定义异常类，以便我们可以在处理逻辑中使用它们：

public class ResourceNotFoundException extends RuntimeException {
    public ResourceNotFoundException(String message) {
        super(message);
    }
}

3. 使用自定义异常

在控制器中，你可以抛出自定义异常，并让 @RestControllerAdvice 处理它们：

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/api")
public class MyController {

    @GetMapping("/items/{id}")
    public String getItem(@PathVariable("id") String id) {
        if ("notfound".equals(id)) {
            throw new ResourceNotFoundException("Item not found");
        }
        return "Item details";
    }
}

在这个例子中，当请求的 ID 为 “notfound” 时，会抛出 ResourceNotFoundException，并由 GlobalExceptionHandler 类处理。

总结

使用 @RestControllerAdvice 可以显著提升异常处理的效率和代码的整洁性。通过集中处理异常逻辑，我们不仅能保持控制器代码的简洁，还能确保一致的错误响应格式。这种方法对于构建可靠且易于维护的 RESTful API 至关重要。