Spring Boot統(tǒng)一異常處理

Spring boot 通過(guò)AOP思想,使用注解@RestControllerAdvice將異常統(tǒng)一到一個(gè)地方進(jìn)行處理眯牧,這樣可以避免代碼中到處捕獲和處理異常话浇,讓代碼保持干凈整潔挽鞠。


簡(jiǎn)單對(duì)象的創(chuàng)建

首先創(chuàng)建一個(gè)枚舉類型牵署,用來(lái)保存各種返回狀態(tài)

public enum ResultCode {
    SUCCESS(200, "成功"),
    PARAM_INVALID(401, "參數(shù)無(wú)效"),
    TASK_NULL(404, "任務(wù)不存在"),
   ...

    private int code;
    private String msg;

    ResultCode(int code, String msg) {
        this.code = code;
        this.msg = msg;
    }

    public int getCode() {
        return code;
    }

    public String getMsg() {
        return msg;
    }

}

然后再有一個(gè)統(tǒng)一的controller返回對(duì)象類:

public class ResultJson<T> implements Serializable{

    private static final long serialVersionUID = 783015033603078674L;
    private int code;
    private String msg;
    private T data;

    public ResultJson (ResultCode resultCode,T data) {
        setResultCode(resultCode);
        this.data = data;
    }

    public static ResultJson success() {
        ResultJson resultJson = new ResultJson();
        resultJson.setResultCode(ResultCode.SUCCESS);
        return resultJson;
    }

    public static <T> ResultJson success(T data){
        return new ResultJson(ResultCode.SUCCESS, data);
    }

    public static ResultJson failure(ResultCode resultCode){
        ResultJson resultJson = new ResultJson();
        resultJson.setResultCode(resultCode);
        return resultJson;
    }

    public void setResultCode(ResultCode resultCode) {
        this.code = resultCode.getCode();
        this.msg = resultCode.getMsg();
    }
...省略構(gòu)造方法和getter和setter方法漏隐;
}

自定義異常類:

public class CustomException extends RuntimeException {
    private static final long serialVersionUID = 2984474148327146104L;

    private ResultCode resultCode;

    public CustomException(ResultCode resultCode) {
        this.resultCode = resultCode;
    }
    ...省略getter和setter方法;
}

然后就是創(chuàng)建一個(gè)統(tǒng)一異常處理的類了

@RestControllerAdvice
public class DefaultExceptionHandler {
    private Logger logger = LoggerFactory.getLogger(DefaultExceptionHandler.class);
    /**
     * 處理所有自定義異常
     * @param e
     * @return
     */
    @ExceptionHandler(CustomException.class)
    public ResultJson handleCustomException(CustomException e){
        return ResultJson.failure(e.getResultCode());
    }
  ...這里可以增加其他想處理的異常
    /**
     * 處理所有異常
     * @param e
     * @return
     */
    @ExceptionHandler(Exception.class)
    public ResultJson handleException(Exception e){
        logger.error(e.getMessage());
        return ResultJson.failure(ResultCode.SERVER_ERROR);
    }
}

該類會(huì)攔截controller轉(zhuǎn)發(fā)的請(qǐng)求過(guò)程中產(chǎn)生的異常,只要在異常處理類中定義的異常都可以被捕獲處理奴迅,并返回給controller調(diào)用者青责。
業(yè)務(wù)方法中就可以不用去處理異常了。異常都集中到一處處理取具,修改也方便脖隶,而且所有定義的異常都能按照格式返回到前臺(tái)。

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末暇检,一起剝皮案震驚了整個(gè)濱河市产阱,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌块仆,老刑警劉巖构蹬,帶你破解...
    沈念sama閱讀 221,635評(píng)論 6 515
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異悔据,居然都是意外死亡庄敛,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 94,543評(píng)論 3 399
  • 文/潘曉璐 我一進(jìn)店門科汗,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)藻烤,“玉大人,你說(shuō)我怎么就攤上這事肛捍∫啵” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 168,083評(píng)論 0 360
  • 文/不壞的土叔 我叫張陵拙毫,是天一觀的道長(zhǎng)依许。 經(jīng)常有香客問(wèn)我,道長(zhǎng)缀蹄,這世上最難降的妖魔是什么峭跳? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 59,640評(píng)論 1 296
  • 正文 為了忘掉前任,我火速辦了婚禮缺前,結(jié)果婚禮上蛀醉,老公的妹妹穿的比我還像新娘。我一直安慰自己衅码,他們只是感情好拯刁,可當(dāng)我...
    茶點(diǎn)故事閱讀 68,640評(píng)論 6 397
  • 文/花漫 我一把揭開(kāi)白布。 她就那樣靜靜地躺著逝段,像睡著了一般垛玻。 火紅的嫁衣襯著肌膚如雪割捅。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 52,262評(píng)論 1 308
  • 那天帚桩,我揣著相機(jī)與錄音亿驾,去河邊找鬼。 笑死账嚎,一個(gè)胖子當(dāng)著我的面吹牛莫瞬,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播郭蕉,決...
    沈念sama閱讀 40,833評(píng)論 3 421
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼疼邀,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了恳不?” 一聲冷哼從身側(cè)響起檩小,我...
    開(kāi)封第一講書(shū)人閱讀 39,736評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎烟勋,沒(méi)想到半個(gè)月后规求,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 46,280評(píng)論 1 319
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡卵惦,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 38,369評(píng)論 3 340
  • 正文 我和宋清朗相戀三年阻肿,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片沮尿。...
    茶點(diǎn)故事閱讀 40,503評(píng)論 1 352
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡丛塌,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出畜疾,到底是詐尸還是另有隱情赴邻,我是刑警寧澤,帶...
    沈念sama閱讀 36,185評(píng)論 5 350
  • 正文 年R本政府宣布啡捶,位于F島的核電站姥敛,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏瞎暑。R本人自食惡果不足惜彤敛,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,870評(píng)論 3 333
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望了赌。 院中可真熱鬧墨榄,春花似錦、人聲如沸勿她。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 32,340評(píng)論 0 24
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)。三九已至播揪,卻和暖如春贮喧,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背猪狈。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 33,460評(píng)論 1 272
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留辩恼,地道東北人雇庙。 一個(gè)月前我還...
    沈念sama閱讀 48,909評(píng)論 3 376
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像灶伊,于是被迫代替她去往敵國(guó)和親疆前。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 45,512評(píng)論 2 359

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