【轉(zhuǎn)載】Java統(tǒng)一異常處理及架構(gòu)實戰(zhàn)

原文地址:https://www.cnblogs.com/jurendage/p/11255197.html

Java生鮮電商平臺-統(tǒng)一異常處理及架構(gòu)實戰(zhàn)

補充說明：本文講得比較細(xì)惹想，所以篇幅較長。請認(rèn)真讀完拴念，希望讀完后能對統(tǒng)一異常處理有一個清晰的認(rèn)識类垦。

背景

軟件開發(fā)過程中，不可避免的是需要處理各種異常蹂匹，就我自己來說碘菜，至少有一半以上的時間都是在處理各種異常情況，所以代碼中就會出現(xiàn)大量的try {...} catch {...} finally {...} 代碼塊限寞，不僅有大量的冗余代碼忍啸，而且還影響代碼的可讀性。比較下面兩張圖履植，看看您現(xiàn)在編寫的代碼屬于哪一種風(fēng)格计雌？然后哪種編碼風(fēng)格您更喜歡？

丑陋的 try catch 代碼塊

優(yōu)雅的Controller

上面的示例玫霎，還只是在Controller層凿滤，如果是在Service層，可能會有更多的try catch代碼塊庶近。這將會嚴(yán)重影響代碼的可讀性翁脆、“美觀性”。

所以如果是我的話鼻种，我肯定偏向于第二種反番，我可以把更多的精力放在業(yè)務(wù)代碼的開發(fā)，同時代碼也會變得更加簡潔叉钥。

既然業(yè)務(wù)代碼不顯式地對異常進(jìn)行捕獲罢缸、處理，而異惩抖樱肯定還是處理的枫疆，不然系統(tǒng)豈不是動不動就崩潰了，所以必須得有其他地方捕獲并處理這些異常蛾洛。

那么問題來了养铸，如何優(yōu)雅的處理各種異常雁芙？

什么是統(tǒng)一異常處理

Spring在3.2版本增加了一個注解@ControllerAdvice，可以與@ExceptionHandler钞螟、@InitBinder兔甘、@ModelAttribute 等注解注解配套使用，對于這幾個注解的作用鳞滨，這里不做過多贅述洞焙，若有不了解的，可以參考Spring3.2新注解@ControllerAdvice拯啦，先大概有個了解澡匪。

不過跟異常處理相關(guān)的只有注解@ExceptionHandler，從字面上看褒链，就是異常處理器的意思唁情，其實際作用也是：若在某個Controller類定義一個異常處理方法，并在方法上添加該注解甫匹，那么當(dāng)出現(xiàn)指定的異常時甸鸟，會執(zhí)行該處理異常的方法，其可以使用springmvc提供的數(shù)據(jù)綁定兵迅，比如注入HttpServletRequest等抢韭，還可以接受一個當(dāng)前拋出的Throwable對象。

但是恍箭，這樣一來，就必須在每一個Controller類都定義一套這樣的異常處理方法扯夭，因為異橱⒓郑可以是各種各樣。這樣一來勉抓，就會造成大量的冗余代碼贾漏，而且若需要新增一種異常的處理邏輯候学，就必須修改所有Controller類了藕筋，很不優(yōu)雅。

當(dāng)然你可能會說梳码，那就定義個類似BaseController的基類隐圾，這樣總行了吧。

這種做法雖然沒錯掰茶，但仍不盡善盡美暇藏，因為這樣的代碼有一定的侵入性和耦合性。簡簡單單的Controller濒蒋，我為啥非得繼承這樣一個類呢盐碱，萬一已經(jīng)繼承其他基類了呢把兔。大家都知道Java只能繼承一個類。

那有沒有一種方案瓮顽，既不需要跟Controller耦合县好，也可以將定義的異常處理器應(yīng)用到所有控制器呢？所以注解@ControllerAdvice出現(xiàn)了暖混，簡單的說缕贡，該注解可以把異常處理器應(yīng)用到所有控制器，而不是單個控制器拣播。借助該注解晾咪，我們可以實現(xiàn)：在獨立的某個地方，比如單獨一個類贮配，定義一套對各種異常的處理機制谍倦，然后在類的簽名加上注解@ControllerAdvice，統(tǒng)一對不同階段的泪勒、不同異常進(jìn)行處理剂跟。這就是統(tǒng)一異常處理的原理。

注意到上面對異常按階段進(jìn)行分類酣藻，大體可以分成：進(jìn)入Controller前的異常和 Service 層異常曹洽，具體可以參考下圖：

image.png

不同階段的異常

目標(biāo)

消滅95%以上的 try catch 代碼塊，以優(yōu)雅的 Assert(斷言) 方式來校驗業(yè)務(wù)的異常情況辽剧，只關(guān)注業(yè)務(wù)邏輯送淆，而不用花費大量精力寫冗余的 try catch 代碼塊。

統(tǒng)一異常處理實戰(zhàn)

在定義統(tǒng)一異常處理類之前怕轿，先來介紹一下如何優(yōu)雅的判定異常情況并拋異常偷崩。

用 Assert(斷言) 替換 throw exception

想必 Assert(斷言) 大家都很熟悉，比如 Spring 家族的 org.springframework.util.Assert撞羽，在我們寫測試用例的時候經(jīng)常會用到阐斜，使用斷言能讓我們編碼的時候有一種非一般絲滑的感覺，比如：

@Test
public void test1() {
    ...
    User user = userDao.selectById(userId);
    Assert.notNull(user, "用戶不存在.");
    ...
}

@Test
public void test2() {
    // 另一種寫法
    User user = userDao.selectById(userId);
    if (user == null) {
    throw new IllegalArgumentException("用戶不存在.");
    }
}

有沒有感覺第一種判定非空的寫法很優(yōu)雅诀紊，第二種寫法則是相對丑陋的 if {...} 代碼塊谒出。那么

神奇的 Assert.notNull() 背后到底做了什么呢？下面是 Assert 的部分源碼：

public abstract class Assert {

    public Assert() {
    }

    public static void notNull(@Nullable Object object, String message) {
        if (object == null) {
            throw new IllegalArgumentException(message);
        }
    }
}

可以看到邻奠，Assert 其實就是幫我們把 if {...} 封裝了一下笤喳，是不是很神奇。雖然很簡單碌宴，但不可否認(rèn)的是編碼體驗至少提升了一個檔次杀狡。那么我們能不能模仿org.springframework.util.Assert，也寫一個斷言類贰镣，不過斷言失敗后拋出的異常不是IllegalArgumentException 這些內(nèi)置異常呜象，而是我們自己定義的異常膳凝。下面讓我們來嘗試一下。

Assert

public interface Assert {
    /**
    * 創(chuàng)建異常
    * @param args
    * @return
    */
    BaseException newException(Object... args);
    /**
    * 創(chuàng)建異常
    * @param t
    * @param args
    * @return
    */
    BaseException newException(Throwable t, Object... args);
    /**
    * <p>斷言對象<code>obj</code>非空恭陡。如果對象<code>obj</code>為空鸠项，則拋出異常
    *
    * @param obj 待判斷對象
    */
    default void assertNotNull(Object obj) {
        if (obj == null) {
            throw newException(obj);
        }
    }
    /**
    * <p>斷言對象<code>obj</code>非空。如果對象<code>obj</code>為空子姜，則拋出異常
    * <p>異常信息<code>message</code>支持傳遞參數(shù)方式祟绊，避免在判斷之前進(jìn)行字符串拼接操作
    *
    * @param obj 待判斷對象
    * @param args message占位符對應(yīng)的參數(shù)列表
    */
    default void assertNotNull(Object obj, Object... args) {
        if (obj == null) {
            throw newException(args);
        }
    }
}

上面的Assert斷言方法是使用接口的默認(rèn)方法定義的，然后有沒有發(fā)現(xiàn)當(dāng)斷言失敗后哥捕，拋出的異常不是具體的某個異常牧抽，而是交由2個newException接口方法提供。因為業(yè)務(wù)邏輯中出現(xiàn)的異骋Ｗ基本都是對應(yīng)特定的場景扬舒，比如根據(jù)用戶id獲取用戶信息，查詢結(jié)果為null凫佛，此時拋出的異辰部玻可能為UserNotFoundException，并且有特定的異常碼（比如7001）和異常信息“用戶不存在”愧薛。所以具體拋出什么異常晨炕，有Assert的實現(xiàn)類決定。

看到這里毫炉，您可能會有這樣的疑問瓮栗，按照上面的說法，那豈不是有多少異常情況瞄勾，就得有定義等量的斷言類和異常類费奸，這顯然是反人類的，這也沒想象中高明嘛进陡。別急愿阐，且聽我細(xì)細(xì)道來。

善解人意的Enum

自定義異常BaseException有2個屬性趾疚，即code缨历、message，這樣一對屬性盗蟆，有沒有想到什么類一般也會定義這2個屬性戈二？沒錯，就是枚舉類喳资。且看我如何將 Enum 和 Assert 結(jié)合起來，相信我一定會讓你眼前一亮腾供。如下：

public interface IResponseEnum {
    int getCode();
    String getMessage();
}
/**
* <p>業(yè)務(wù)異常</p>
* <p>業(yè)務(wù)處理時仆邓，出現(xiàn)異常鲜滩，可以拋出該異常</p>
*/
public class BusinessException extends BaseException {
    private static final long serialVersionUID = 1L;
    public BusinessException(IResponseEnum responseEnum, Object[] args, String message) {
        super(responseEnum, args, message);
    }
    public BusinessException(IResponseEnum responseEnum, Object[] args, String message, Throwable cause) {
        super(responseEnum, args, message, cause);
    }
}
public interface BusinessExceptionAssert extends IResponseEnum, Assert {
    @Override
    default BaseException newException(Object... args) {
        String msg = MessageFormat.format(this.getMessage(), args);
        return new BusinessException(this, args, msg);
    }
    @Override
    default BaseException newException(Throwable t, Object... args) {
        String msg = MessageFormat.format(this.getMessage(), args);
        return new BusinessException(this, args, msg, t);
    }
}
@Getter
@AllArgsConstructor
public enum ResponseEnum implements BusinessExceptionAssert {
/**
* Bad licence type
*/
BAD_LICENCE_TYPE(7001, "Bad licence type."),
/**
* Licence not found
*/
LICENCE_NOT_FOUND(7002, "Licence not found.")
;
/**
* 返回碼
*/
private int code;
/**
* 返回消息
*/
private String message;
}

看到這里，有沒有眼前一亮的感覺节值，代碼示例中定義了兩個枚舉實例：BAD_LICENCE_TYPE徙硅、LICENCE_NOT_FOUND，分別對應(yīng)了BadLicenceTypeException搞疗、LicenceNotFoundException兩種異常嗓蘑。以后每增加一種異常情況，只需增加一個枚舉實例即可匿乃，再也不用每一種異常都定義一個異常類了桩皿。然后再來看下如何使用，假設(shè)LicenceService有校驗Licence是否存在的方法幢炸，如下：

/**
* 校驗{@link Licence}存在
* @param licence
*/
private void checkNotNull(Licence licence) {
    ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence);
}

若不使用斷言泄隔，代碼可能如下：

private void checkNotNull(Licence licence) {
    if (licence == null) {
        throw new LicenceNotFoundException();
        // 或者這樣
        throw new BusinessException(7001, "Bad licence type.");
    }
}

使用枚舉類結(jié)合(繼承)Assert，只需根據(jù)特定的異常情況定義不同的枚舉實例宛徊，如上面的BAD_LICENCE_TYPE佛嬉、LICENCE_NOT_FOUND，就能夠針對不同情況拋出特定的異常（這里指攜帶特定的異常碼和異常消息）闸天，這樣既不用定義大量的異常類暖呕，同時還具備了斷言的良好可讀性，當(dāng)然這種方案的好處遠(yuǎn)不止這些苞氮，請繼續(xù)閱讀后文缰揪，慢慢體會。

注：上面舉的例子是針對特定的業(yè)務(wù)葱淳，而有部分異常情況是通用的钝腺，比如：服務(wù)器繁忙、網(wǎng)絡(luò)異常赞厕、服務(wù)器異常艳狐、參數(shù)校驗異常、404等皿桑，所以有CommonResponseEnum毫目、ArgumentResponseEnum、ServletResponseEnum诲侮，其中 ServletResponseEnum 會在后文詳細(xì)說明镀虐。

定義統(tǒng)一異常處理器類

@Slf4j
@Component
@ControllerAdvice
@ConditionalOnWebApplication
@ConditionalOnMissingBean(UnifiedExceptionHandler.class)
public class UnifiedExceptionHandler {
/**
* 生產(chǎn)環(huán)境
*/
private final static String ENV_PROD = "prod";
@Autowired
private UnifiedMessageSource unifiedMessageSource;
/**
* 當(dāng)前環(huán)境
*/
@Value("${spring.profiles.active}")
private String profile;
/**
* 獲取國際化消息
*
* @param e 異常
* @return
*/
public String getMessage(BaseException e) {
    String code = "response." + e.getResponseEnum().toString();
    String message = unifiedMessageSource.getMessage(code, e.getArgs());
    if (message == null || message.isEmpty()) {
        return e.getMessage();
    }
    return message;
}
/**
* 業(yè)務(wù)異常
*
* @param e 異常
* @return 異常結(jié)果
*/
@ExceptionHandler(value = BusinessException.class)
@ResponseBody
public ErrorResponse handleBusinessException(BaseException e) {
    log.error(e.getMessage(), e);
    return new ErrorResponse(e.getResponseEnum().getCode(), getMessage(e));
}
/**
* 自定義異常
*
* @param e 異常
* @return 異常結(jié)果
*/
@ExceptionHandler(value = BaseException.class)
@ResponseBody
public ErrorResponse handleBaseException(BaseException e) {
    log.error(e.getMessage(), e);
    return new ErrorResponse(e.getResponseEnum().getCode(), getMessage(e));
}
/**
* Controller上一層相關(guān)異常
*
* @param e 異常
* @return 異常結(jié)果
*/
@ExceptionHandler({
    NoHandlerFoundException.class,
    HttpRequestMethodNotSupportedException.class,
    HttpMediaTypeNotSupportedException.class,
    MissingPathVariableException.class,
    MissingServletRequestParameterException.class,
    TypeMismatchException.class,
    HttpMessageNotReadableException.class,
    HttpMessageNotWritableException.class,
// BindException.class,
// MethodArgumentNotValidException.class
    HttpMediaTypeNotAcceptableException.class,
    ServletRequestBindingException.class,
    ConversionNotSupportedException.class,
    MissingServletRequestPartException.class,
    AsyncRequestTimeoutException.class
})
@ResponseBody
public ErrorResponse handleServletException(Exception e) {
    log.error(e.getMessage(), e);
    int code = CommonResponseEnum.SERVER_ERROR.getCode();
    try {
        ServletResponseEnum servletExceptionEnum = ServletResponseEnum.valueOf(e.getClass().getSimpleName());
        code = servletExceptionEnum.getCode();
    } catch (IllegalArgumentException e1) {
        log.error("class [{}] not defined in enum {}", e.getClass().getName(), ServletResponseEnum.class.getName());
    }
    if (ENV_PROD.equals(profile)) {
// 當(dāng)為生產(chǎn)環(huán)境, 不適合把具體的異常信息展示給用戶, 比如404.
        code = CommonResponseEnum.SERVER_ERROR.getCode();
        BaseException baseException = new BaseException(CommonResponseEnum.SERVER_ERROR);
        String message = getMessage(baseException);
        return new ErrorResponse(code, message);
    }
    return new ErrorResponse(code, e.getMessage());
}
/**
* 參數(shù)綁定異常
*
* @param e 異常
* @return 異常結(jié)果
*/
@ExceptionHandler(value = BindException.class)
@ResponseBody
public ErrorResponse handleBindException(BindException e) {
    log.error("參數(shù)綁定校驗異常", e);
    return wrapperBindingResult(e.getBindingResult());
}
/**
* 參數(shù)校驗異常，將校驗失敗的所有異常組合成一條錯誤信息
*
* @param e 異常
* @return 異常結(jié)果
*/
@ExceptionHandler(value = MethodArgumentNotValidException.class)
@ResponseBody
public ErrorResponse handleValidException(MethodArgumentNotValidException e) {
    log.error("參數(shù)綁定校驗異常", e);
    return wrapperBindingResult(e.getBindingResult());
}
/**
* 包裝綁定異常結(jié)果
*
* @param bindingResult 綁定結(jié)果
* @return 異常結(jié)果
*/
private ErrorResponse wrapperBindingResult(BindingResult bindingResult) {
    StringBuilder msg = new StringBuilder();
    for (ObjectError error : bindingResult.getAllErrors()) {
        msg.append(", ");
        if (error instanceof FieldError) {
            msg.append(((FieldError) error).getField()).append(": ");
        }
        msg.append(error.getDefaultMessage() == null ? "" : error.getDefaultMessage());
    }
    return new ErrorResponse(ArgumentResponseEnum.VALID_ERROR.getCode(), msg.substring(2));
}
/**
* 未定義異常
*
* @param e 異常
* @return 異常結(jié)果
*/
@ExceptionHandler(value = Exception.class)
@ResponseBody
public ErrorResponse handleException(Exception e) {
    log.error(e.getMessage(), e);
    if (ENV_PROD.equals(profile)) {
// 當(dāng)為生產(chǎn)環(huán)境, 不適合把具體的異常信息展示給用戶, 比如數(shù)據(jù)庫異常信息.
        int code = CommonResponseEnum.SERVER_ERROR.getCode();
        BaseException baseException = new BaseException(CommonResponseEnum.SERVER_ERROR);
        String message = getMessage(baseException);
        return new ErrorResponse(code, message);
    }
    return new ErrorResponse(CommonResponseEnum.SERVER_ERROR.getCode(), e.getMessage());
}
}

可以看到沟绪，上面將異常分成幾類刮便，實際上只有兩大類，一類是ServletException绽慈、ServiceException恨旱，還記得上文提到的按階段分類嗎辈毯，即對應(yīng) 進(jìn)入Controller前的異常和 Service 層異常；然后 ServiceException 再分成自定義異常搜贤、未知異常谆沃。對應(yīng)關(guān)系如下：

進(jìn)入Controller前的異常: handleServletException、handleBindException仪芒、handleValidException
自定義異常: handleBusinessException唁影、handleBaseException
未知異常: handleException

接下來分別對這幾種異常處理器做詳細(xì)說明。

異常處理器說明

handleServletException

一個http請求掂名，在到達(dá)Controller前言津，會對該請求的請求信息與目標(biāo)控制器信息做一系列校驗友鼻。這里簡單說一下：

NoHandlerFoundException：首先根據(jù)請求Url查找有沒有對應(yīng)的控制器，若沒有則會拋該異常，也就是大家非常熟悉的404異常均蜜；
HttpRequestMethodNotSupportedException：若匹配到了（匹配結(jié)果是一個列表耗跛，不同的是http方法不同杖刷，如：Get竹勉、Post等），則嘗試將請求的http方法與列表的控制器做匹配肿嘲，若沒有對應(yīng)http方法的控制器融击，則拋該異常；
HttpMediaTypeNotSupportedException：然后再對請求頭與控制器支持的做比較雳窟，比如content-type請求頭尊浪，若控制器的參數(shù)簽名包含注解@RequestBody，但是請求的content-type請求頭的值沒有包含application/json封救，那么會拋該異常（當(dāng)然拇涤，不止這種情況會拋這個異常）；
MissingPathVariableException：未檢測到路徑參數(shù)誉结。比如url為：/licence/{licenceId}鹅士，參數(shù)簽名包含@PathVariable("licenceId")，當(dāng)請求的url為/licence惩坑，在沒有明確定義url為/licence的情況下掉盅，會被判定為：缺少路徑參數(shù)；
MissingServletRequestParameterException：缺少請求參數(shù)以舒。比如定義了參數(shù)@RequestParam("licenceId") String licenceId趾痘，但發(fā)起請求時，未攜帶該參數(shù)蔓钟，則會拋該異常永票；
TypeMismatchException: 參數(shù)類型匹配失敗。比如：接收參數(shù)為Long型，但傳入的值確是一個字符串瓦侮，那么將會出現(xiàn)類型轉(zhuǎn)換失敗的情況艰赞，這時會拋該異常佣谐；
HttpMessageNotReadableException：與上面的HttpMediaTypeNotSupportedException舉的例子完全相反肚吏，即請求頭攜帶了"content-type: application/json;charset=UTF-8"，但接收參數(shù)卻沒有添加注解@RequestBody狭魂，或者請求體攜帶的 json 串反序列化成 pojo 的過程中失敗了罚攀，也會拋該異常；
HttpMessageNotWritableException：返回的 pojo 在序列化成 json 過程失敗了雌澄，那么拋該異常斋泄；
HttpMediaTypeNotAcceptableException：未知；
ServletRequestBindingException：未知镐牺；
ConversionNotSupportedException：未知炫掐；
MissingServletRequestPartException：未知；
AsyncRequestTimeoutException：未知睬涧；

handleBindException

參數(shù)校驗異常募胃，后文詳細(xì)說明。

handleValidException

參數(shù)校驗異常畦浓，后文詳細(xì)說明痹束。

handleBusinessException、handleBaseException

處理自定義的業(yè)務(wù)異常讶请，只是handleBaseException處理的是除了 BusinessException 意外的所有業(yè)務(wù)異常祷嘶。就目前來看，這2個是可以合并成一個的夺溢。

handleException

處理所有未知的異常论巍，比如操作數(shù)據(jù)庫失敗的異常。

注：上面的handleServletException风响、handleException 這兩個處理器嘉汰，返回的異常信息，不同環(huán)境返回的可能不一樣钞诡，以為這些異常信息都是框架自帶的異常信息郑现，一般都是英文的，不太好直接展示給用戶看荧降，所以統(tǒng)一返回SERVER_ERROR代表的異常信息接箫。

異于常人的404

上文提到，當(dāng)請求沒有匹配到控制器的情況下朵诫，會拋出NoHandlerFoundException異常辛友，但其實默認(rèn)情況下不是這樣，默認(rèn)情況下會出現(xiàn)類似如下頁面：

image.png

Whitelabel Error Page

這個頁面是如何出現(xiàn)的呢？實際上废累，當(dāng)出現(xiàn)404的時候邓梅，默認(rèn)是不拋異常的，而是 forward跳轉(zhuǎn)到/error控制器邑滨，spring也提供了默認(rèn)的error控制器日缨，如下：

image.png

BasicErrorController

那么，如何讓404也拋出異常呢掖看，只需在properties文件中加入如下配置即可：

spring.mvc.throw-exception-if-no-handler-found=true

spring.resources.add-mappings=false

如此匣距，就可以異常處理器中捕獲它了，然后前端只要捕獲到特定的狀態(tài)碼哎壳，立即跳轉(zhuǎn)到404頁面即可

image.png

捕獲404對應(yīng)的異常

統(tǒng)一返回結(jié)果

在驗證統(tǒng)一異常處理器之前毅待，順便說一下統(tǒng)一返回結(jié)果。說白了归榕，其實是統(tǒng)一一下返回結(jié)果的數(shù)據(jù)結(jié)構(gòu)尸红。code、message 是所有返回結(jié)果中必有的字段刹泄，而當(dāng)需要返回數(shù)據(jù)時外里，則需要另一個字段 data 來表示。

所以首先定義一個 BaseResponse 來作為所有返回結(jié)果的基類循签；

然后定義一個通用返回結(jié)果類CommonResponse级乐，繼承 BaseResponse，而且多了字段 data县匠；

為了區(qū)分成功和失敗返回結(jié)果风科，于是再定義一個 ErrorResponse；

最后還有一種常見的返回結(jié)果乞旦，即返回的數(shù)據(jù)帶有分頁信息贼穆，因為這種接口比較常見，所以有必要單獨定義一個返回結(jié)果類 QueryDataResponse兰粉，該類繼承自 CommonResponse故痊，只是把 data 字段的類型限制為 QueryDdata，QueryDdata中定義了分頁信息相應(yīng)的字段玖姑，即totalCount愕秫、pageNo、 pageSize焰络、records戴甩。

其中比較常用的只有 CommonResponse 和 QueryDataResponse，但是名字又賊鬼死長闪彼，何不定義2個名字超簡單的類來替代呢甜孤？于是 R 和 QR 誕生了，以后返回結(jié)果的時候只需這樣寫：new R<>(data)、new QR<>(queryData)缴川。

所有的返回結(jié)果類的定義這里就不貼出來了

驗證統(tǒng)一異常處理

因為這一套統(tǒng)一異常處理可以說是通用的茉稠，所有可以設(shè)計成一個 common包，以后每一個新項目/模塊只需引入該包即可把夸。所以為了驗證而线，需要新建一個項目，并引入該 common包扎即。項目結(jié)構(gòu)如下：

image.png

項目結(jié)構(gòu)

以后只需這樣引入即可

image.png

引入common包

主要代碼

下面是用于驗證的主要源碼：

@Service
public class LicenceService extends ServiceImpl<LicenceMapper, Licence> {
    @Autowired
    private OrganizationClient organizationClient;
/**
* 查詢{@link Licence} 詳情
* @param licenceId
* @return
*/
public LicenceDTO queryDetail(Long licenceId) {
    Licence licence = this.getById(licenceId);
    checkNotNull(licence);
    OrganizationDTO org = ClientUtil.execute(() -> organizationClient.getOrganization(licence.getOrganizationId()));
    return toLicenceDTO(licence, org);
}
/**
* 分頁獲取
* @param licenceParam 分頁查詢參數(shù)
* @return
*/
public QueryData<SimpleLicenceDTO> getLicences(LicenceParam licenceParam) {
    String licenceType = licenceParam.getLicenceType();
    LicenceTypeEnum licenceTypeEnum = LicenceTypeEnum.parseOfNullable(licenceType);
// 斷言, 非空
    ResponseEnum.BAD_LICENCE_TYPE.assertNotNull(licenceTypeEnum);
    LambdaQueryWrapper<Licence> wrapper = new LambdaQueryWrapper<>();
    wrapper.eq(Licence::getLicenceType, licenceType);
    IPage<Licence> page = this.page(new QueryPage<>(licenceParam), wrapper);
    return new QueryData<>(page, this::toSimpleLicenceDTO);
}
/**
* 新增{@link Licence}
* @param request 請求體
* @return
*/
@Transactional(rollbackFor = Throwable.class)
public LicenceAddRespData addLicence(LicenceAddRequest request) {
    Licence licence = new Licence();
    licence.setOrganizationId(request.getOrganizationId());
    licence.setLicenceType(request.getLicenceType());
    licence.setProductName(request.getProductName());
    licence.setLicenceMax(request.getLicenceMax());
    licence.setLicenceAllocated(request.getLicenceAllocated());
    licence.setComment(request.getComment());
    this.save(licence);
    return new LicenceAddRespData(licence.getLicenceId());
}
/**
* entity -> simple dto
* @param licence {@link Licence} entity
* @return {@link SimpleLicenceDTO}
*/
private SimpleLicenceDTO toSimpleLicenceDTO(Licence licence) {
// 省略
}
/**
* entity -> dto
* @param licence {@link Licence} entity
* @param org {@link OrganizationDTO}
* @return {@link LicenceDTO}
*/
private LicenceDTO toLicenceDTO(Licence licence, OrganizationDTO org) {
// 省略
}
/**
* 校驗{@link Licence}存在
* @param licence
*/
private void checkNotNull(Licence licence) {
    ResponseEnum.LICENCE_NOT_FOUND.assertNotNull(licence);
}
}
> ps: 這里使用的DAO框架是mybatis-plus吞获。
> 
> 啟動時况凉，自動插入的數(shù)據(jù)為：
-- licence
INSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)
VALUES (1, 1, 'user','CustomerPro', 100,5);
INSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)
VALUES (2, 1, 'user','suitability-plus', 200,189);
INSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)
VALUES (3, 2, 'user','HR-PowerSuite', 100,4);
INSERT INTO licence (licence_id, organization_id, licence_type, product_name, licence_max, licence_allocated)
VALUES (4, 2, 'core-prod','WildCat Application Gateway', 16,16);
-- organizations
INSERT INTO organization (id, name, contact_name, contact_email, contact_phone)
VALUES (1, 'customer-crm-co', 'Mark Balster', 'mark.balster@custcrmco.com', '823-555-1212');
INSERT INTO organization (id, name, contact_name, contact_email, contact_phone)
VALUES (2, 'HR-PowerSuite', 'Doug Drewry','doug.drewry@hr.com', '920-555-1212');

開始驗證

捕獲自定義異常

獲取不存在的 licence 詳情：http://localhost:10000/licence/5谚鄙。成功響應(yīng)的請求：licenceId=1

image.png

校驗非空

image.png

捕獲 Licence not found 異常

image.png

Licence not found
根據(jù)不存在的 licence type 獲取 licence 列表：http://localhost:10000/licence/list?licenceType=ddd〉笕蓿可選的 licence type 為：user闷营、core-prod 。

image.png

校驗非空

image.png

捕獲 Bad licence type 異常

image.png

Bad licence type

捕獲進(jìn)入 Controller 前的異常

訪問不存在的接口：http://localhost:10000/licence/list/ddd

image.png

捕獲404異常
http 方法不支持：http://localhost:10000/licence

image.png

PostMapping

image.png

捕獲 Request method not supported 異常

image.png

Request method not supported
校驗異常1：http://localhost:10000/licence/list?licenceType=

image.png

getLicences

image.png

LicenceParam

image.png

捕獲參數(shù)綁定校驗異常

image.png

licence type cannot be empty
校驗異常2：post 請求知市，這里使用postman模擬傻盟。

image.png

addLicence

image.png

LicenceAddRequest

image.png

請求url即結(jié)果

image.png

捕獲參數(shù)綁定校驗異常

注：因為參數(shù)綁定校驗異常的異常信息的獲取方式與其它異常不一樣，所以才把這2種情況的異常從進(jìn)入 Controller 前的異常單獨拆出來嫂丙，下面是異常信息的收集邏輯：

image.png

異常信息的收集

捕獲未知異常

假設(shè)我們現(xiàn)在隨便對 Licence 新增一個字段 test娘赴，但不修改數(shù)據(jù)庫表結(jié)構(gòu)，然后訪問：http://localhost:10000/licence/1跟啤。

image.png

增加test字段

image.png

捕獲數(shù)據(jù)庫異常

image.png

Error querying database

小結(jié)

可以看到诽表，測試的異常都能夠被捕獲，然后以 code隅肥、message 的形式返回竿奏。每一個項目/模塊，在定義業(yè)務(wù)異常的時候腥放，只需定義一個枚舉類泛啸，然后實現(xiàn)接口 BusinessExceptionAssert，最后為每一種業(yè)務(wù)異常定義對應(yīng)的枚舉實例即可秃症，而不用定義許多異常類候址。使用的時候也很方便，用法類似斷言种柑。

擴展

在生產(chǎn)環(huán)境岗仑，若捕獲到未知異常或者 ServletException，因為都是一長串的異常信息莹规，若直接展示給用戶看赔蒲，顯得不夠?qū)I(yè)，于是，我們可以這樣做：當(dāng)檢測到當(dāng)前環(huán)境是生產(chǎn)環(huán)境舞虱，那么直接返回 "網(wǎng)絡(luò)異常"欢际。

image.png

生產(chǎn)環(huán)境返回“網(wǎng)絡(luò)異常”

可以通過以下方式修改當(dāng)前環(huán)境：

image.png

修改當(dāng)前環(huán)境為生產(chǎn)環(huán)境

總結(jié)

使用斷言和枚舉類相結(jié)合的方式矾兜，再配合統(tǒng)一異常處理损趋，基本大部分的異常都能夠被捕獲。為什么說大部分異常椅寺，因為當(dāng)引入 spring cloud security 后浑槽，還會有認(rèn)證/授權(quán)異常，網(wǎng)關(guān)的服務(wù)降級異常返帕、跨模塊調(diào)用異常桐玻、遠(yuǎn)程調(diào)用第三方服務(wù)異常等，這些異常的捕獲方式與本文介紹的不太一樣荆萤，不過限于篇幅镊靴，這里不做詳細(xì)說明，以后會有單獨的文章介紹链韭。

另外偏竟，當(dāng)需要考慮國際化的時候，捕獲異常后的異常信息一般不能直接返回敞峭，需要轉(zhuǎn)換成對應(yīng)的語言踊谋，不過本文已考慮到了這個，獲取消息的時候已經(jīng)做了國際化映射旋讹，邏輯如下：

image.png

獲取國際化消息

最后總結(jié)殖蚕，全局異常屬于老生長談的話題，希望這次通過手機的項目對大家有點指導(dǎo)性的學(xué)習(xí)骗村。大家根據(jù)實際情況自行修改嫌褪。

也可以采用以下的jsonResult對象的方式進(jìn)行處理，也貼出來代碼.

@Slf4j
@RestControllerAdvice
public class GlobalExceptionHandler {
/**
* 沒有登錄
* @param request
* @param response
* @param e
* @return
*/
@ExceptionHandler(NoLoginException.class)
public Object noLoginExceptionHandler(HttpServletRequest request,HttpServletResponse response,Exception e)
{
    log.error("[GlobalExceptionHandler][noLoginExceptionHandler] exception",e);
    JsonResult jsonResult = new JsonResult();
    jsonResult.setCode(JsonResultCode.NO_LOGIN);
    jsonResult.setMessage("用戶登錄失效或者登錄超時,請先登錄");
    return jsonResult;
}
/**
* 業(yè)務(wù)異常
* @param request
* @param response
* @param e
* @return
*/
@ExceptionHandler(ServiceException.class)
public Object businessExceptionHandler(HttpServletRequest request,HttpServletResponse response,Exception e)
{
    log.error("[GlobalExceptionHandler][businessExceptionHandler] exception",e);
    JsonResult jsonResult = new JsonResult();
    jsonResult.setCode(JsonResultCode.FAILURE);
    jsonResult.setMessage("業(yè)務(wù)異常,請聯(lián)系管理員");
    return jsonResult;
}
/**
* 全局異常處理
* @param request
* @param response
* @param e
* @return
*/
@ExceptionHandler(Exception.class)
public Object exceptionHandler(HttpServletRequest request,HttpServletResponse response,Exception e)
{
    log.error("[GlobalExceptionHandler][exceptionHandler] exception",e);
    JsonResult jsonResult = new JsonResult();
    jsonResult.setCode(JsonResultCode.FAILURE);
    jsonResult.setMessage("系統(tǒng)錯誤,請聯(lián)系管理員");
    return jsonResult;
}
}