在构建RESTful API的道路上，我们常常会遇到各种各样的异常情况。为了确保用户体验和应用稳定性，如何有效地捕获和处理这些异常就显得尤为重要。今天，就让我们一起深入探讨@RestControllerAdvice这个强大的工具，看看它是如何在Spring Boot应用中实现全局异常捕获与处理的。

一、基础使用

首先，我们来了解一下@RestControllerAdvice的基础使用方法。

1. 定义全局异常处理器

@RestControllerAdvice
public class GlobalExceptionHandler {

    @ExceptionHandler(UserNotFoundException.class)
    @ResponseStatus(HttpStatus.NOT_FOUND)
    public ErrorResponse handleUserNotFound(UserNotFoundException ex) {
        return new ErrorResponse(ex.getMessage(), HttpStatus.NOT_FOUND.value());
    }
}

这里，我们定义了一个全局异常处理器GlobalExceptionHandler，并使用@ExceptionHandler注解来捕获UserNotFoundException异常。当这个异常被抛出时，handleUserNotFound方法会被调用，并返回一个包含错误信息的ErrorResponse对象。

2. 自定义异常类

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

为了处理特定的异常情况，我们可以自定义一个异常类。在这个例子中，我们定义了一个UserNotFoundException类，用于表示用户未找到的情况。

3. 测试Controller

接下来，我们来看一个简单的Controller示例：

@RestController
@RequestMapping("/users")
public class UserController {

    @GetMapping("/{id}")
    public String getUser(@PathVariable Long id) {
        if (id == 0) {
            throw new UserNotFoundException("用户不存在");
        }
        return "用户信息";
    }
}

在这个Controller中，我们定义了一个getUser方法，用于根据用户ID获取用户信息。如果传入的ID为0，就会抛出UserNotFoundException异常。

4. 统一响应体

@Data
@AllArgsConstructor
public class ErrorResponse {
    private String message;
    private int statusCode;
}

为了统一异常处理的结果格式，我们可以定义一个ErrorResponse类，用于封装错误信息和HTTP状态码。

二、问题解答

接下来，我们来解答一些常见问题。

1. 为什么RestControllerAdvice常与@RestController配合使用？

   • 响应格式统一性：二者均基于@ResponseBody，确保异常处理结果与业务逻辑返回同为JSON格式。
   • 作用域明确：@RestControllerAdvice默认处理所有@RestController控制器抛出的异常，保持REST API异常处理的专一性。
   • 避免视图解析：传统@Controller可能返回视图，而@RestControllerAdvice专注于数据响应。

2. @RestControllerAdvice的依赖来源？

   该注解属于Spring Web模块，在项目中需引入：

   <!-- Maven -->
   <dependency>
       <groupId>org.springframework.boot</groupId>
       <artifactId>spring-boot-starter-web</artifactId>
   </dependency>
   

   或者使用Gradle：

   implementation 'org.springframework.boot:spring-boot-starter-web'
   

三、核心机制解析

最后，我们来了解一下@RestControllerAdvice的核心机制。

• 组合注解：@RestControllerAdvice实际上是@ControllerAdvice和@ResponseBody的组合注解。
• AOP代理：通过动态代理技术拦截控制器方法调用，在异常抛出时匹配处理策略。
• 优先级规则：更具体的异常处理器优先于通用处理器。

四、总结

@RestControllerAdvice通过集中管理异常处理逻辑，显著提升了代码的可维护性。结合@RestController使用时，能够有效统一REST API的错误响应格式，是构建企业级应用不可或缺的组件。理解其底层依赖和协作机制，有助于更灵活地进行定制化开发。