SpringBoot:如何優(yōu)雅地處理全局異常？

之前用springboot的時(shí)候，只知道捕獲異常使用try{}catch，一個(gè)接口一個(gè)try{}catch，這也是大多數(shù)開(kāi)發(fā)人員異常處理的常用方式，雖然屢試不爽，但會(huì)造成一個(gè)問(wèn)題，就是一個(gè)Controller下面，滿屏幕的try{}catch，看著一點(diǎn)都不優(yōu)雅，一點(diǎn)都不符合小明的氣質(zhì)，憋了這么久，小明今天終于決定對(duì)所有異常實(shí)施統(tǒng)一處理的方案。

開(kāi)發(fā)準(zhǔn)備

JDK8、正常的springboot項(xiàng)目

代碼編寫(xiě)

通用異常處理


其實(shí)Spring系列的項(xiàng)目全局異常處理方式早已存在，只不過(guò)我們一直忙于搬磚，很少停下腳步去審視這個(gè)日夜與我們相伴的朋友。為了貼合主題，本次主要針對(duì)SpringBoot全局異常處理進(jìn)行舉例說(shuō)明。

SpringBoot中有一個(gè)@ControllerAdvice的注解，使用該注解即表示開(kāi)啟全局異常捕獲，接下來(lái)我們只需在自定義的方法上使用
@ExceptionHandler注解，并定義捕獲異常的類(lèi)型，對(duì)這種類(lèi)型的異常進(jìn)行統(tǒng)一的處理。

舉個(gè)例子:

假如我們需要針對(duì)NullException（空指針異常，是Java程序員最痛恨的異常，沒(méi)有之一）進(jìn)行全局處理（如下所示）。
@RestControllerAdvice public class GlobalExceptionHandler { /** * 處理空指針的異常 *
@param req * @param e * @return */ @ExceptionHandler(value
=NullPointerException.class) public BaseResponseFacade
exceptionHandler(HttpServletRequest req, NullPointerException e){
log.error("發(fā)生空指針異常！原因是:",e); return ResponseUtil.error(ResponseCode.ERROR); } }
訥，就這么簡(jiǎn)單。其他可能發(fā)生的異常，都可以以這種方式處理快速處理。此處大家應(yīng)該表現(xiàn)的十分興奮，但請(qǐng)不要高興太早，因?yàn)榻酉聛?lái)，有更令激動(dòng)人心的事情。

自定義異常處理

自定義一個(gè)異常
import lombok.AllArgsConstructor; import lombok.Data; import
lombok.experimental.Accessors; /** * @Description 自定義異常 * @Date 2019-08-05
15:49 * @Created by 程序員小明 */ @Data @AllArgsConstructor @Accessors(chain = true)
public class BizException extends RuntimeException { /** * 錯(cuò)誤碼 */ protected
Integer errorCode; /** * 錯(cuò)誤信息 */ protected String errorMsg; }
顯而易見(jiàn)，這個(gè)異常繼承了RuntimeException
，屬于運(yùn)行時(shí)異常。細(xì)心的朋友已經(jīng)發(fā)現(xiàn)，我使用了Lombok插件，非常契合今天的主題，給大家簡(jiǎn)單介紹一下：


lombok是一個(gè)可以幫助我們簡(jiǎn)化java代碼編寫(xiě)的工具類(lèi)，尤其是簡(jiǎn)化javabean的編寫(xiě)，即通過(guò)采用注解的方式，消除代碼中的構(gòu)造方法，getter/setter等代碼，使我們寫(xiě)的類(lèi)更加簡(jiǎn)潔（如果使用的IDE是idea，需要安裝插件哈）。

定義過(guò)之后，我們就可以和之前處理NullException方式一樣處理我們自定義的異常。包括處理其他異常，都是這種方式。直接貼代碼。
@Slf4j @RestControllerAdvice public class GlobalExceptionHandler { /** *
處理自定義的業(yè)務(wù)異常 * @param req * @param e * @return */ @ExceptionHandler(value =
BizException.class) public BaseResponseFacade
bizExceptionHandler(HttpServletRequest req, BizException e){
log.error("發(fā)生業(yè)務(wù)異常！原因是：{}",e.getErrorMsg()); return
ResponseUtil.error(e.getErrorCode(),e.getErrorMsg()); } /** * 處理空指針的異常 * @param
req * @param e * @return */ @ExceptionHandler(value
=NullPointerException.class) public BaseResponseFacade
exceptionHandler(HttpServletRequest req, NullPointerException e){
log.error("發(fā)生空指針異常！原因是:",e); return ResponseUtil.error(ResponseCode.ERROR); }
/** * 處理其他異常 * @param req * @param e * @return */ @ExceptionHandler(value
=Exception.class) public BaseResponseFacade exceptionHandler(HttpServletRequest
req, Exception e){ log.error("未知異常！原因是:",e); return
ResponseUtil.error(ResponseCode.INTERNAL_SERVER_ERROR); } }
整個(gè)全局異常處理方式核心就是以上介紹這些。下面用一個(gè)Demo給大家舉個(gè)例子
@GetMapping("/test") public BaseResponseFacade test(){ if(true){ throw new
BizException(1,"error"); } return ResponseUtil.success(); }
地址欄請(qǐng)求，進(jìn)入這個(gè)方法后，會(huì)拋出異常，此時(shí)全局異常生效，就會(huì)返回異常處理過(guò)后的信息
{"errorCode":1,"errorMsg":"error","data":null}

到此整個(gè)流程都然跑通了。當(dāng)然，好多地方都可以根據(jù)我們自身實(shí)際業(yè)務(wù)情況以此為基礎(chǔ)進(jìn)一步豐富，比如返回?cái)?shù)據(jù)可以改成跳轉(zhuǎn)某一個(gè)具體的頁(yè)面。這樣的出場(chǎng)方式是不是都很優(yōu)雅？大家有什么問(wèn)題，期待各位留言。

• ? 上一篇：「玩轉(zhuǎn)Python」打造十萬(wàn)博文爬蟲(chóng)篇
• ? 下一篇：.net持續(xù)集成sonarqube篇之 sonarqube集成單元測(cè)試