SpringMVC中@controllerAdvice注解的詳細解釋

更新時間：2022年02月17日 10:32:57 作者：zhangkaixuan456

剛接觸SpringMVC應該很少會見到這個注解,其實它的作用非常大,下面這篇文章主要給大家介紹了關于SpringMVC中@controllerAdvice注解的相關資料,需要的朋友可以參考下

1.全局異常處理

使用 @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，則數組越界異常就不會進到這個方法中來。

2.全局數據綁定

全局數據綁定功能可以用來做一些初始化的數據操作，我們可以將一些公共的數據定義在添加了 @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 就是方法返回值，當然開發(fā)者可以通過 @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);
     
    }
}

輸出結果：

3.全局數據預處理

考慮我有兩個實體類，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 屬性，從前端傳遞時，無法區(qū)分。此時，通過 @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前綴.