SpringBoot中@ControllerAdvice注解的使用方法

更新時間：2024年01月15日 10:26:39 作者：@紅@旗下的小兵

這篇文章主要介紹了SpringBoot中@ControllerAdvice注解的使用方法,這是一個增強的?Controller,對controller層做異常處理、數(shù)據(jù)預處理、全局數(shù)據(jù)綁定,?springboot?會自動掃描到,不需要調(diào)用,這個注解是spring?MVC提供的,在springboot中也可以使用,需要的朋友可以參考下

@ControllerAdvice注解的使用

這是一個增強的 Controller，對controller層做異常處理、數(shù)據(jù)預處理、全局數(shù)據(jù)綁定, springboot 會自動掃描到,不需要調(diào)用。

這個注解是spring MVC提供的，在springboot中也可以使用

全局異常處理

使用 @ControllerAdvice 注解，相當于開啟了全局異常捕獲，具體實現(xiàn)只需兩步：

第一步：定義類，添加 @ControllerAdvice 注解，開啟全局異常捕獲；

第二步：在方法上，使用 @ExceptionHandler，定義捕獲異常的類型即可。

@ControllerAdvice
public class ControllerExceptionHandler {
    /**
     * 校驗的統(tǒng)一異常處理
     * @param e
     * @return ComResponse
     *
     * BindException 有針對性的,是校驗不通過時,報的錯誤異常類做處理
     * Exception 對所有的報錯異常做處理
     */
    @ExceptionHandler(value = {BindException.class})
    @ResponseBody
    public ComResponse validExceptionHandler(BindException e) {
        // 獲取我們定義的校驗失敗的異常信息
        String msg = e.getBindingResult().getAllErrors().get(0).getDefaultMessage();
        ComResponse comResponse = new ComResponse<>();
        comResponse.setMsg(msg);
        comResponse.setSuccess(false);
        return comResponse;
    }
}

在該類中，你可以定義多個方法，不同方法吹不同的異常，只需要指定：@ExceptionHandler(value = {xxxException.class})，例如專門做空指針的處理方法，專門做數(shù)組越界的處理方法。 @ExceptionHandler 注解來指明異常的處理類型，上邊例子中，指定BindException類型，那么除了參數(shù)校驗拋出的異常，其他異常不會進這個方法中來。

關(guān)于@ControllerAdvice和@RestControllerAdvice區(qū)別：

在具體使用上，

1）注解有@ControllerAdvice的類，需要在具體方法上同時添加@ExceptionHandler和@ResponseBody注解；

2）注解有@RestControllerAdvice的類，只需要在具體方法上添加@ExceptionHandler注解。

全局數(shù)據(jù)綁定

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

使用 @ModelAttribute 注解標記該方法的返回數(shù)據(jù)是一個全局數(shù)據(jù)，默認情況下，這個全局數(shù)據(jù)的 key 就是返回的變量名，value 就是方法返回值，當然開發(fā)者可以通過 @ModelAttribute 注解的 name 屬性去重新指定 key。

定義完成后，在任何一個Controller 的接口中，都可以獲取到這里定義的數(shù)據(jù)：

定義：

@ControllerAdvice
public class Test {
    @ModelAttribute(name = "globalData")
    public Map<String, Object> setGlobalData() {
        Map<String, Object> map = new HashMap<>(){
            {
                put("username", "呂星辰");
                put("uid", 123);
            }
        };
        return map;
    }
}

獲取全局數(shù)據(jù)

@RestController
public class UserController {
    @RequestMapping(value = "/test")
    public String userTest(Model model) {
        // 獲取全局數(shù)據(jù)
        Map<String, Object> map = model.asMap();
        String json = JSON.toJSONString(map, SerializerFeature.PrettyFormat);
        System.out.println(json);
        return json;
    }
}

輸出：