@RestControllerAdvice 与 @ControllerAdvice

Spring

@RestControllerAdvice 与 @ControllerAdvice 的区别及使用方式

在Spring框架中，我们经常会使用到@ControllerAdvice和@RestControllerAdvice这两个注解。它们是用来处理全局异常和全局数据绑定的。虽然它们的名称相似，但是在使用方式和适用范围上却有一些区别。本文将介绍这两个注解的区别，并通过案例代码来说明它们的使用方式。

1. @ControllerAdvice

@ControllerAdvice是一个类级别的注解，用于定义全局控制器增强。它可以被用于定义一个统一的异常处理器、全局数据绑定或全局数据预处理等。通过@ControllerAdvice注解，我们可以将一些通用的处理逻辑集中到一个类中，以便在多个控制器中共享。

下面是一个使用@ControllerAdvice处理全局异常的例子：

Java
@ControllerAdvice
public class GlobalExceptionHandler {
  
  @ExceptionHandler(Exception.class)
  public ResponseEntity<String> handleException(Exception e) {
    // 异常处理逻辑
    return new ResponseEntity<>("Internal Server Error", HttpStatus.INTERNAL_SERVER_ERROR);
  }
}

在上面的例子中，我们使用@ControllerAdvice注解来定义了一个全局异常处理器。通过@ExceptionHandler注解，我们可以定义对特定类型异常的处理逻辑。当发生Exception类型的异常时，handleException方法会被调用，并返回一个自定义的响应实体。

2. @RestControllerAdvice

@RestControllerAdvice是Spring 4.3版本引入的新注解，它结合了@RestController和@ControllerAdvice的功能。与@ControllerAdvice不同的是，@RestControllerAdvice注解是用于处理全局异常的RestController增强。

下面是一个使用@RestControllerAdvice处理全局异常的例子：

Java
@RestControllerAdvice
public class GlobalExceptionHandler {
  
  @ExceptionHandler(Exception.class)
  public ResponseEntity<String> handleException(Exception e) {
    // 异常处理逻辑
    return new ResponseEntity<>("Internal Server Error", HttpStatus.INTERNAL_SERVER_ERROR);
  }
}

与@ControllerAdvice的使用方式基本相同，我们同样需要在类级别上添加@RestControllerAdvice注解，并使用@ExceptionHandler注解来定义异常处理方法。

3. @ControllerAdvice与@RestControllerAdvice的区别

两者的主要区别在于返回值的类型。@ControllerAdvice处理全局异常时，其方法可以定义为任意类型，包括String、ModelAndView、ResponseEntity等。而@RestControllerAdvice处理全局异常时，其方法的返回值只能是对象，即通过@ResponseBody注解返回JSON格式的数据。

此外，@RestControllerAdvice还可以应用于全局数据绑定和全局数据预处理。通过使用@ModelAttribute、@InitBinder和@RequestBody等注解，我们可以在@RestControllerAdvice中定义一些通用的数据绑定或数据预处理方法，以便在多个RestController中共享。

4.

@ControllerAdvice和@RestControllerAdvice是Spring框架中用于处理全局异常和全局数据绑定的注解。它们的使用方式相似，但在返回值类型上有所区别。通过使用这两个注解，我们可以将一些通用的处理逻辑集中到一个类中，以便在整个应用程序中共享。

在实际开发中，我们可以根据项目的需求选择合适的注解来处理全局异常和全局数据绑定。无论是@ControllerAdvice还是@RestControllerAdvice，它们都提供了一种简单而有效的方式来处理全局的控制器增强逻辑。

总的来说，@ControllerAdvice适用于处理返回多种类型的响应，而@RestControllerAdvice适用于处理返回JSON格式的响应。根据具体的需求和应用场景来选择合适的注解，可以让我们的代码更加简洁、优雅。

希望本文对您理解和使用@ControllerAdvice和@RestControllerAdvice有所帮助！

参考文献：

- Spring Framework Documentation: Spring.io/Spring-framework/docs/current/reference/html/web.html#mvc-ann-controller-advice">https://docs.Spring.io/Spring-framework/docs/current/reference/html/web.html#mvc-ann-controller-advice

- Baeldung: https://www.baeldung.com/exception-handling-for-rest-with-Spring