@ControllerAdvice的几个应用

1. 添加全局数据（搭配@ModelAttribute）

1. 设置全局数据
   @ControllerAdvice 是一个全局数据处理组件，因此也可以在 @ControllerAdvice 中配置全局数据，使用 @ModelAttribute 注释进行配置。

@ControllerAdvice
public class MyGlobalExceptionHandler {

    /**
     * 添加全局数据
     */
    @ModelAttribute(value = "msg")
    public String message(){
        return "欢迎访问 guns.com";
    }

    @ModelAttribute(value = "info")
    public Map<String,String>userInfo(){
        HashMap<String,String>map = new HashMap<>();
        map.put("name6","guns");
        map.put("age6","10");
        return map;
    }
}

2. 获取全局数据
   在任意请求的 Controller 中，方法参数中通过 @ModelAttribute 可以获取指定的全局数据，样例代码如下：

@Controller
@RequestMapping("/test")
public class AdviceTestcController {

    @RequestMapping("/adviceTest1")
    public String hello(@ModelAttribute("msg") String msg,@ModelAttribute("info") Map<String,String> info){
        String result = "msg:"+msg + "info:"+info;
        System.out.println(result);
        return result;
    }
}

我们也可以在请求的 Controller 方法参数中的 Model 获取所有的全局数据，下面代码的结果同上面的一样：

 @RequestMapping("/adviceTest2")
    public String hello2(Model model){
        Map<String, Object> map = model.asMap();
        String msg = map.get("msg").toString();
        Map<String,String>info = (Map<String, String>) map.get("info");
        String result = "msg:"+msg + "info:"+info;
        System.out.println(result);
        return result;
    }

2. 请求参数预处理（@InitBinder）

我们知道无论是 Get 请求还是 Post 请求，Controller 这边都可以定义一个实体类来接收这些参数。而 @ControllerAdvice 结合 @InitBinder 还能实现请求参数预处理，即将表单中的数据绑定到实体类上时进行一些额外处理。

问题描述

1. 假设我们有如下两个实体类 User 和 Book：

public class User {

    private String name;

    private int age;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

public class Book {

    private String name;
    private float price;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public float getPrice() {
        return price;
    }

    public void setPrice(float price) {
        this.price = price;
    }
}

2. 如果在 Contoller 上需要接收两个实体类的数据，接收方法可以这么定义：

@Controller
public class HelloController {

    @RequestMapping(value = "/hello")
    @ResponseBody
    public String hello(User user, Book book){
        return "name:"+user.getName()+",age:"+user.getAge()+",name:"+book.getName()+",price:"+book.getPrice();
    }
}

3. 但由于两个实体类中都有 name 属性，那么参数传递时就会发生混淆。

解决办法：

1. 使用 @ControllerAdvice 结合 @InitBinder 即可解决上面的问题，这里我们创建一个全局的参数预处理配置。

第一个 @InitBinder(“user”) 表示该方法是处理 Controller 中 @ModelAttribute(“user”) 对应的参数。
第二个 @InitBinder(“book”) 表示该方法是处理 Controller 中 @ModelAttribute(“book”) 对应的参数。
这两个方法中给相应的 Filed 设置一个前缀。
补充说明：在 WebDataBinder 对象中，除了可以设置前缀，还可以设置允许、禁止的字段、必填字段以及验证器等等。

@ControllerAdvice
@Order(-50)
public class MyGlobalExceptionHandler {
	@InitBinder("user")
    public void init1(WebDataBinder binder){
        binder.setFieldDefaultPrefix("user.");
    }
    @InitBinder("book")
    public void init2(WebDataBinder binder){
        binder.setFieldDefaultPrefix("book.");
    }
}

2. 然后 Controller 中方法的参数添加 @ModelAttribute 注解：

	@RequestMapping(value = "/hello")
    @ResponseBody
    public String hello(@ModelAttribute("user") User user, @ModelAttribute ("book") Book book){
        return "name:"+user.getName()+",age:"+user.getAge()+",name:"+book.getName()+",price:"+book.getPrice();
    }

3. 最后浏览器请求参数中添加相应的前缀，即可成功区分出 name 属性：

http://localhost:8082/hello?user.name=liming&user.age=12&book.name=book&price=800.2

3. 全局异常处理

基本用法

1. @ControllerAdvice 最常见的使用场景就是全局异常处理。这里我模拟了一个空指针异常的处理
2. 如果程序出现空指针异常，此时可以通过 @ControllerAdvice 结合 @ExceptionHandler 定义全局异常捕获机制，具体代码如下：

//这里打印了异常信息返回
@ControllerAdvice
@Order(-50)
public class MyGlobalExceptionHandler {
	@ExceptionHandler(NullPointerException.class)
    public void testException(NullPointerException e, HttpServletResponse rep) throws IOException {
        PrintWriter writer = rep.getWriter();
        writer.write("this a null pointer,please check your method and param,that is mesage:"+e.getMessage());
        writer.flush();
        writer.close();
    }

3. 也可以返回一个ModelAndView
   下面使用一个返回参数是 ModelAndView 的样例。这里我们使用的页面模版为 Thymeleaf，所以首先要在 pom.xml 中添加相关依赖。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>

@ControllerAdvice
@Order(-50)
public class MyGlobalExceptionHandler {
	@ExceptionHandler(NullPointerException.class)
    public ModelAndView  testException2(NullPointerExceptione,HttpServletResponse rep){
        ModelAndView mv = new ModelAndView();
        mv.addObject("msg","空指针异常！");
        mv.setViewName("error");
        return mv;
    }
   }

然后在 resources/templates 目录下创建 error.html 文件

测试代码：

@Controller
public class HelloController {
	@ResponseBody
    @RequestMapping(value = "/testnull")
    public void testNull(){
        Integer a  = null;
        a.intValue();
    }
}

测试：

http://localhost:8082/testnull

补充知识点：

@Order(-50) 注解可以控制多个@ControllerAdvice的配置类的优先级，数值越小，优先级越大，也就是说我们如果有另外一个@ControllerAdvice标注的类，也有一个处理空指针异常的方法，以小的那个为标准

参考文章：https://www.hangge.com/blog/cache/detail_2481.html