SpringMVC常用註解（超級詳細）

一、ControllerAdvice的常用場景

1、全局異常處理

2、全局數據綁定

3、全局數據預處理

靈活使用這三個功能，可以幫助我們簡化很多工作，需要注意的是，這是 SpringMVC 提供的功能，在 Spring Boot 中可以直接使用，下面分別來看。

二、全局異常處理

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

package com.atguigu.commonutils.exceptionhandler;

import com.atguigu.commonutils.R;
import org.springframework.web.bind.annotation.ControllerAdvice;
import org.springframework.web.bind.annotation.ExceptionHandler;
import org.springframework.web.bind.annotation.ResponseBody;

@ControllerAdvice
public class GlobalExceptionHandler {
    @ExceptionHandler(Exception.class)
    @ResponseBody //爲了能夠返回數據
    public R error(Exception e){
        e.printStackTrace();
        return R.error().message("執行了全局異常處理");
    }

    @ExceptionHandler(ArithmeticException.class)
    @ResponseBody //爲了能夠返回數據
    public R error(ArithmeticException e){
        e.printStackTrace();
        return R.error().message("執行了ArithmeticException異常處理");
    }
}

在該類中，可以定義多個方法，不同的方法處理不同的異常，例如處理全部異常的方法、專門處理算術運算異常的方法...

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

三、全局數據綁定

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

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

@ControllerAdvice
public class MyGlobalExceptionHandler {
    @ModelAttribute(name = "md")
    public Map<String,Object> mydata() {
        Map<String, Object> map = new HashMap<>();
        map.put("id", 23);
        map.put("name", "素小暖");
        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、發送請求

請求發送時,通過給不同對象的參數添加不同的前綴,可以實現參數的區分.