@ControllerAdvice ，很多初学者可能都没有听说过这个注解，实际上，这是一个非常有用的注解，顾名思义，这是一个增强的 Controller。使用这个 Controller ，可以实现三个方面的功能：

1. 全局异常处理

2. 全局数据绑定

3. 全局数据预处理

灵活使用这三个功能，可以帮助我们简化很多工作，需要注意的是，这是 SpringMVC 提供的功能，在 Spring Boot 中可以直接使用，下面分别来看。

全局异常处理

使用 @ControllerAdvice 实现全局异常处理，只需要定义类，添加该注解即可定义方式如下：

1. @ControllerAdvice

2. public class MyGlobalExceptionHandler {

3. @ExceptionHandler(Exception.class)

4. public ModelAndView customException(Exception e) {

5. ModelAndView mv = new ModelAndView();

6. mv.addObject("message", e.getMessage());

7. mv.setViewName("myerror");

8. return mv;

9. }

10. }

在该类中，可以定义多个方法，不同的方法处理不同的异常，例如专门处理空指针的方法、专门处理数组越界的方法...，也可以直接向上面代码一样，在一个方法中处理所有的异常信息。

@ExceptionHandler 注解用来指明异常的处理类型，即如果这里指定为 NullpointerException，则数组越界异常就不会进到这个方法中来。

全局数据绑定

全局数据绑定功能可以用来做一些初始化的数据操作，我们可以将一些公共的数据定义在添加了 @ControllerAdvice 注解的类中，这样，在每一个 Controller 的接口中，就都能够访问导致这些数据。

使用步骤，首先定义全局数据，如下：

1. @ControllerAdvice

2. public class MyGlobalExceptionHandler {

3. @ModelAttribute(name = "md")

4. public Map<String,Object> mydata() {

5. HashMap<String, Object> map = new HashMap<>();

6. map.put("age", 99);

7. map.put("gender", "男");

8. return map;

9. }

10. }

使用 @ModelAttribute 注解标记该方法的返回数据是一个全局数据，默认情况下，这个全局数据的 key 就是返回的变量名，value 就是方法返回值，当然开发者可以通过 @ModelAttribute 注解的 name 属性去重新指定 key。

定义完成后，在任何一个Controller 的接口中，都可以获取到这里定义的数据：

1. @RestController

2. public class HelloController {

3. @GetMapping("/hello")

4. public String hello(Model model) {

5. Map<String, Object> map = model.asMap();

6. System.out.println(map);

7. int i = 1 / 0;

8. return "hello controller advice";

9. }

10. }

全局数据预处理

考虑我有两个实体类，Book 和 Author，分别定义如下：

1. public class Book {

2. private String name;

3. private Long price;

4. //getter/setter

5. }

6. public class Author {

7. private String name;

8. private Integer age;

9. //getter/setter

10. }

此时，如果我定义一个数据添加接口，如下：

1. @PostMapping("/book")

2. public void addBook(Book book, Author author) {

3. System.out.println(book);

4. System.out.println(author);

5. }

这个时候，添加操作就会有问题，因为两个实体类都有一个 name 属性，从前端传递时 ，无法区分。此时，通过 @ControllerAdvice 的全局数据预处理可以解决这个问题

解决步骤如下:

1.给接口中的变量取别名

1. @PostMapping("/book")

2. public void addBook(@ModelAttribute("b") Book book, @ModelAttribute("a") Author author) {

3. System.out.println(book);

4. System.out.println(author);

5. }

2.进行请求数据预处理
在 @ControllerAdvice 标记的类中添加如下代码:

1. @InitBinder("b")

2. public void b(WebDataBinder binder) {

3. binder.setFieldDefaultPrefix("b.");

4. }

5. @InitBinder("a")

6. public void a(WebDataBinder binder) {

7. binder.setFieldDefaultPrefix("a.");

8. }

@InitBinder("b") 注解表示该方法用来处理和Book和相关的参数,在方法中,给参数添加一个 b 前缀,即请求参数要有b前缀.

3.发送请求

请求发送时,通过给不同对象的参数添加不同的前缀,可以实现参数的区分.

总结

这就是松哥给大伙介绍的 @ControllerAdvice 的几个简单用法。

关注我，你不会失望的！！

本文分享自微信公众号 - JAVA开发大本营（gh_42999193133a）。
如有侵权，请联系 support@oschina.cn 删除。
本文参与“OSC源创计划”，欢迎正在阅读的你也加入，一起分享。