統(tǒng)一處理異常機(jī)制

SpringBoot 是如何統(tǒng)一處理全局異常的滨攻。SpringBoot 中的全局異常處理主要起作用的兩個(gè)注解是 @ControllerAdvice 和 @ExceptionHandler 够话,其中 @ControllerAdvice 是組件注解,添加了這個(gè)注解的類能夠攔截 Controller 的請(qǐng)求光绕,而 ExceptionHandler 注解可以設(shè)置全局處理控制里的異常類型來(lái)攔截要處理的異常女嘲。 比如:@ExceptionHandler(value = NullPointException.class) 。

返回的消息類

public class Message<T> implements Serializable {

    /**
     * 狀態(tài)碼
     */
    private Integer code;

    /**
     * 返回信息
     */
    private String message;

    /**
     * 返回的數(shù)據(jù)類
     */
    private T data;

    /**
     * 時(shí)間
     */
    private Long time;

    // getter诞帐、setter 以及 構(gòu)造方法略欣尼。。。
}

工具類

用于處理返回的數(shù)據(jù)以及信息類愕鼓,代碼注釋很詳細(xì)不說(shuō)了钙态。

public class MessageUtil {

    /**
     * 成功并返回?cái)?shù)據(jù)實(shí)體類
     * @param o
     * @param <E>
     * @return
     */
    public static <E>Message<E> ok(E o){
        return new Message<>(200, "success", o, new Date().getTime());
    }

    /**
     * 成功,但無(wú)數(shù)據(jù)實(shí)體類返回
     * @return
     */
    public static <E>Message<E> ok(){
        return new Message<>(200, "success", null, new Date().getTime());
    }

    /**
     * 失敗菇晃,有自定義異常返回
     * @param code
     * @param msg
     * @return
     */
    public static <E>Message<E> error(Integer code,String msg){
        return new Message<>(code, msg, null, new Date().getTime());
    }
}

自定義異常

通過(guò)繼承 RuntimeException 册倒,聲明 code 用于定義不同類型的自定義異常。主要是用于異常攔截出獲取 code 并將 code 設(shè)置到消息類中返回磺送。
public class CustomException extends RuntimeException{

    /**
     * 狀態(tài)碼
     */
    private Integer code;

    public Integer getCode() {
        return code;
    }

    public void setCode(Integer code) {
        this.code = code;
    }

    public CustomException(Integer code, String message){

        super(message);
        this.code = code;

    }
}

異常攔截類

通過(guò)加入 @RestControllerAdvice 來(lái)聲明該類可攔截 Controller 請(qǐng)求驻子,同時(shí)在 handle方法加入 @ExceptionHandler 并在該注解中指定要攔截的異常類。

@RestControllerAdvice // 控制器增強(qiáng)處理(返回 JSON 格式數(shù)據(jù))估灿,添加了這個(gè)注解的類能被 classpath 掃描自動(dòng)發(fā)現(xiàn)
public class ExceptionHandle {

    @ExceptionHandler(value = Exception.class) // 捕獲 Controller 中拋出的指定類型的異常崇呵,也可以指定其他異常
    public <E>Message<E> handler(Exception exception){

        if (exception instanceof CustomException){
            CustomException customException = (CustomException) exception;
            return MessageUtil.error(customException.getCode(), customException.getMessage());
        } else {
            return MessageUtil.error(120, "異常信息:" + exception.getMessage());
        }
    }
}

這里只對(duì)自定義異常以及未知異常進(jìn)行處理,如果你在某方法中明確知道可能會(huì)拋出某個(gè)異常馅袁,可以加多一個(gè)特定的處理演熟。比如說(shuō)你明確知道該方法可能拋出 NullPointException 可以追加 NullPointException 的處理:

if (exception instanceof CustomException){
     CustomException customException = (CustomException) exception;
     return MessageUtil.error(customException.getCode(), customException.getMessage());
} else if (exception instanceof NullPointException ){
     return MessageUtil.error(500, "空指針異常信!");
} else {
     return MessageUtil.error(120, "異常信息:" + exception.getMessage());
}

controller 層

@RestController
@RequestMapping("/student")
public class StudentController {

    @Autowired
    private StudentService studentService;

    @GetMapping("/{id}")
    public Message<Student> findStudentById(@PathVariable("id") Integer id){

        if (id < 0){
            //測(cè)試自定義錯(cuò)誤
            throw new CustomException(110, "參數(shù)不能是負(fù)數(shù)司顿!");

        } else if (id == 0){
            //硬編碼芒粹,為了測(cè)試
            Integer i = 1/id;
            return null;
        } else {
            Student student = studentService.findStudentById(id);
            return MessageUtil.ok(student);
        }
    }
}
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市大溜,隨后出現(xiàn)的幾起案子化漆,更是在濱河造成了極大的恐慌,老刑警劉巖钦奋,帶你破解...
    沈念sama閱讀 219,039評(píng)論 6 508
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件座云,死亡現(xiàn)場(chǎng)離奇詭異,居然都是意外死亡付材,警方通過(guò)查閱死者的電腦和手機(jī)朦拖,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 93,426評(píng)論 3 395
  • 文/潘曉璐 我一進(jìn)店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)厌衔,“玉大人璧帝,你說(shuō)我怎么就攤上這事「皇伲” “怎么了睬隶?”我有些...
    開(kāi)封第一講書人閱讀 165,417評(píng)論 0 356
  • 文/不壞的土叔 我叫張陵,是天一觀的道長(zhǎng)页徐。 經(jīng)常有香客問(wèn)我苏潜,道長(zhǎng),這世上最難降的妖魔是什么变勇? 我笑而不...
    開(kāi)封第一講書人閱讀 58,868評(píng)論 1 295
  • 正文 為了忘掉前任恤左,我火速辦了婚禮,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘飞袋。我一直安慰自己戳气,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,892評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布授嘀。 她就那樣靜靜地躺著物咳,像睡著了一般锣险。 火紅的嫁衣襯著肌膚如雪蹄皱。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書人閱讀 51,692評(píng)論 1 305
  • 那天芯肤,我揣著相機(jī)與錄音巷折,去河邊找鬼。 笑死崖咨,一個(gè)胖子當(dāng)著我的面吹牛锻拘,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播击蹲,決...
    沈念sama閱讀 40,416評(píng)論 3 419
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼署拟,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了歌豺?” 一聲冷哼從身側(cè)響起推穷,我...
    開(kāi)封第一講書人閱讀 39,326評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎类咧,沒(méi)想到半個(gè)月后馒铃,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,782評(píng)論 1 316
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡痕惋,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,957評(píng)論 3 337
  • 正文 我和宋清朗相戀三年区宇,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片值戳。...
    茶點(diǎn)故事閱讀 40,102評(píng)論 1 350
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡议谷,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出堕虹,到底是詐尸還是另有隱情柿隙,我是刑警寧澤,帶...
    沈念sama閱讀 35,790評(píng)論 5 346
  • 正文 年R本政府宣布鲫凶,位于F島的核電站禀崖,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏螟炫。R本人自食惡果不足惜波附,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,442評(píng)論 3 331
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧掸屡,春花似錦封寞、人聲如沸。這莊子的主人今日做“春日...
    開(kāi)封第一講書人閱讀 31,996評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至盏求,卻和暖如春抖锥,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背碎罚。 一陣腳步聲響...
    開(kāi)封第一講書人閱讀 33,113評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工磅废, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人荆烈。 一個(gè)月前我還...
    沈念sama閱讀 48,332評(píng)論 3 373
  • 正文 我出身青樓拯勉,卻偏偏與公主長(zhǎng)得像,于是被迫代替她去往敵國(guó)和親憔购。 傳聞我的和親對(duì)象是個(gè)殘疾皇子宫峦,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,044評(píng)論 2 355

推薦閱讀更多精彩內(nèi)容