嚴格來說，本文並不算是 Spring Boot 中的知識點，但是很多學過 SpringMVC 的小夥伴，對於 @ControllerAdvice 卻並不熟悉，Spring Boot 和 SpringMVC 一脈相承，@ControllerAdvice 在 Spring Boot 中也有廣泛的使用場景，因此本文我們就來聊一聊這個問題。

@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 乾貨！

相關推薦