快捷導(dǎo)航

SpringBoot中@ControllerAdvice注解的使用方法

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

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

@ControllerAdvice注解的使用

這是一個(gè)增強(qiáng)的 Controller，對(duì)controller層做異常處理、數(shù)據(jù)預(yù)處理、全局?jǐn)?shù)據(jù)綁定, springboot 會(huì)自動(dòng)掃描到,不需要調(diào)用。

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

全局異常處理

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

第一步：定義類(lèi)，添加 @ControllerAdvice 注解，開(kāi)啟全局異常捕獲；

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

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

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

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

在具體使用上，

1）注解有@ControllerAdvice的類(lèi)，需要在具體方法上同時(shí)添加@ExceptionHandler和@ResponseBody注解；

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

全局?jǐn)?shù)據(jù)綁定

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

使用 @ModelAttribute 注解標(biāo)記該方法的返回?cái)?shù)據(jù)是一個(gè)全局?jǐn)?shù)據(jù)，默認(rèn)情況下，這個(gè)全局?jǐn)?shù)據(jù)的 key 就是返回的變量名，value 就是方法返回值，當(dāng)然開(kāi)發(fā)者可以通過(guò) @ModelAttribute 注解的 name 屬性去重新指定 key。

定義完成后，在任何一個(gè)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;
    }
}

獲取全局?jǐn)?shù)據(jù)

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

輸出：

到此這篇關(guān)于SpringBoot中@ControllerAdvice注解的使用方法的文章就介紹到這了,更多相關(guān)@ControllerAdvice注解的使用內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: