SpringMVC 中 @ControllerAdvice 註解的三種使用場景！

@ControllerAdvice ，不少初學者可能都沒有據說過這個註解，實際上，這是一個很是有用的註解，顧名思義，這是一個加強的 Controller。使用這個 Controller ，能夠實現三個方面的功能：

1. 全局異常處理
2. 全局數據綁定
3. 全局數據預處理

靈活使用這三個功能，能夠幫助咱們簡化不少工做，須要注意的是，這是 SpringMVC 提供的功能，在 Spring Boot 中能夠直接使用，下面分別來看。

全局異常處理

使用 @ControllerAdvice 實現全局異常處理，只須要定義類，添加該註解便可定義方式以下：

@ControllerAdvice
public class MyGlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    public ModelAndView customException(Exception e) {
        ModelAndView mv = new ModelAndView();
        mv.addObject("message", e.getMessage());
        mv.setViewName("myerror");
        return mv;
    }
}
複製代碼

在該類中，能夠定義多個方法，不一樣的方法處理不一樣的異常，例如專門處理空指針的方法、專門處理數組越界的方法...，也能夠直接向上面代碼同樣，在一個方法中處理全部的異常信息。

@ExceptionHandler 註解用來指明異常的處理類型，即若是這裏指定爲 NullpointerException，則數組越界異常就不會進到這個方法中來。

全局數據綁定

全局數據綁定功能能夠用來作一些初始化的數據操做，咱們能夠將一些公共的數據定義在添加了 @ControllerAdvice 註解的類中，這樣，在每個 Controller 的接口中，就都可以訪問致使這些數據。

使用步驟，首先定義全局數據，以下：

@ControllerAdvice
public class MyGlobalExceptionHandler {
    @ModelAttribute(name = "md")
    public Map<String,Object> mydata() {
        HashMap<String, Object> map = new HashMap<>();
        map.put("age", 99);
        map.put("gender", "男");
        return map;
    }
}
複製代碼

使用 @ModelAttribute 註解標記該方法的返回數據是一個全局數據，默認狀況下，這個全局數據的 key 就是返回的變量名，value 就是方法返回值，固然開發者能夠經過 @ModelAttribute 註解的 name 屬性去從新指定 key。

定義完成後，在任何一個Controller 的接口中，均可以獲取到這裏定義的數據：

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello(Model model) {
        Map<String, Object> map = model.asMap();
        System.out.println(map);
        int i = 1 / 0;
        return "hello controller advice";
    }
}
複製代碼

全局數據預處理

考慮我有兩個實體類，Book 和 Author，分別定義以下：

public class Book {
    private String name;
    private Long price;
    //getter/setter
}
public class Author {
    private String name;
    private Integer age;
    //getter/setter
}
複製代碼

此時，若是我定義一個數據添加接口，以下：

@PostMapping("/book")
public void addBook(Book book, Author author) {
    System.out.println(book);
    System.out.println(author);
}
複製代碼

這個時候，添加操做就會有問題，由於兩個實體類都有一個 name 屬性，從前端傳遞時 ，沒法區分。此時，經過 @ControllerAdvice 的全局數據預處理能夠解決這個問題

解決步驟以下:

1.給接口中的變量取別名

@PostMapping("/book")
public void addBook(@ModelAttribute("b") Book book, @ModelAttribute("a") Author author) {
    System.out.println(book);
    System.out.println(author);
}
複製代碼

2.進行請求數據預處理
在 @ControllerAdvice 標記的類中添加以下代碼:

@InitBinder("b")
public void b(WebDataBinder binder) {
    binder.setFieldDefaultPrefix("b.");
}
@InitBinder("a")
public void a(WebDataBinder binder) {
    binder.setFieldDefaultPrefix("a.");
}
複製代碼

@InitBinder("b") 註解表示該方法用來處理和Book和相關的參數,在方法中,給參數添加一個 b 前綴,即請求參數要有b前綴.

3.發送請求

請求發送時,經過給不一樣對象的參數添加不一樣的前綴,能夠實現參數的區分.

總結

這就是鬆哥給大夥介紹的 @ControllerAdvice 的幾個簡單用法，這些點既能夠在傳統的 SSM 項目中使用，也能夠在 Spring Boot + Spring Cloud 微服務中使用，歡迎你們有問題一塊兒討論。

關注公衆號【江南一點雨】，專一於 Spring Boot+微服務以及先後端分離等全棧技術，按期視頻教程分享，關注後回覆 Java ，領取鬆哥爲你精心準備的 Java 乾貨！