點(diǎn)擊上方 "程序員小樂"關(guān)注, 星標(biāo)或置頂一起成長

每天凌晨00點(diǎn)00分, 第一時(shí)間與你相約

每日英文

Don’t let anyone steal your dreams. Follow your heart, no matter what.

不論做什么事，相信你自己，別讓別人的一句話將你擊倒。

每日掏心話

睡的時(shí)候，不辜負(fù)床，忙的時(shí)候，不辜負(fù)路，愛的時(shí)候，不辜負(fù)人，餓的時(shí)候，不辜負(fù)胃。

來自：sprinkle_liz | 責(zé)編：樂樂

鏈接：jianshu.com/p/3f3d9e8d1efa

程序員小樂(ID:study_tech)第 811 次推文 圖片來自百度

往日回顧：三分鐘基礎(chǔ)：CPU 到底是怎么認(rèn)識(shí)代碼的？

正文

背景

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

丑陋的 try catch 代碼塊

優(yōu)雅的Controller

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

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

既然業(yè)務(wù)代碼不顯式地對(duì)異常進(jìn)行捕獲、處理，而異?？隙ㄟ€是處理的，不然系統(tǒng)豈不是動(dòng)不動(dòng)就崩潰了，所以必須得有其他地方捕獲并處理這些異常。

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

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

Spring在3.2版本增加了一個(gè)注解@ControllerAdvice，可以與@ExceptionHandler、@InitBinder、@ModelAttribute 等注解注解配套使用，對(duì)于這幾個(gè)注解的作用，這里不做過多贅述。

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

但是，這樣一來，就必須在每一個(gè)Controller類都定義一套這樣的異常處理方法，因?yàn)楫惓？梢允歉鞣N各樣。這樣一來，就會(huì)造成大量的冗余代碼，而且若需要新增一種異常的處理邏輯，就必須修改所有Controller類了，很不優(yōu)雅。

當(dāng)然你可能會(huì)說，那就定義個(gè)類似BaseController的基類，這樣總行了吧。

這種做法雖然沒錯(cuò)，但仍不盡善盡美，因?yàn)檫@樣的代碼有一定的侵入性和耦合性。簡簡單單的Controller，我為啥非得繼承這樣一個(gè)類呢，萬一已經(jīng)繼承其他基類了呢。大家都知道Java只能繼承一個(gè)類。

那有沒有一種方案，既不需要跟Controller耦合，也可以將定義的 異常處理器 應(yīng)用到所有控制器呢？所以注解@ControllerAdvice出現(xiàn)了，簡單的說，該注解可以把異常處理器應(yīng)用到所有控制器，而不是單個(gè)控制器。借助該注解，我們可以實(shí)現(xiàn)：在獨(dú)立的某個(gè)地方，比如單獨(dú)一個(gè)類，定義一套對(duì)各種異常的處理機(jī)制，然后在類的簽名加上注解@ControllerAdvice，統(tǒng)一對(duì) 不同階段的、不同異常 進(jìn)行處理。這就是統(tǒng)一異常處理的原理。

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

不同階段的異常

目標(biāo)

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

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

注：因?yàn)檎麄€(gè)統(tǒng)一異常處理方案涉及的代碼比較多，這里不方便貼出所有代碼，只會(huì)貼出關(guān)鍵部分，所以建議將源碼clone到本地方便查看。源碼地址：https://github.com/sprainkle/spring-cloud-advance，涉及到的項(xiàng)目包括：spring-cloud-advance-common、unified-exception-handling。

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

用 Assert(斷言) 替換 throw exception

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

@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)雅，第二種寫法則是相對(duì)丑陋的 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 其實(shí)就是幫我們把 if {...} 封裝了一下，是不是很神奇。雖然很簡單，但不可否認(rèn)的是編碼體驗(yàn)至少提升了一個(gè)檔次。那么我們能不能模仿org.springframework.util.Assert，也寫一個(gè)斷言類，不過斷言失敗后拋出的異常不是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);
/**
*

斷言對(duì)象obj非空。如果對(duì)象obj為空，則拋出異常
*
* @param obj 待判斷對(duì)象
*/
default void assertNotNull(Object obj) {
if (obj == null) {
throw newException(obj);
}
}
/**
*

斷言對(duì)象obj非空。如果對(duì)象obj為空，則拋出異常
*

異常信息message支持傳遞參數(shù)方式，避免在判斷之前進(jìn)行字符串拼接操作
*
* @param obj 待判斷對(duì)象
* @param args message占位符對(duì)應(yīng)的參數(shù)列表
*/
default void assertNotNull(Object obj, Object... args) {
if (obj == null) {
throw newException(args);
}
}
}

注：

• 這里只給出Assert接口的部分源碼，更多斷言方法請參考源碼。

• BaseException 是所有自定義異常的基類。

• 在接口中定義默認(rèn)方法是Java8的新語法。

上面的Assert斷言方法是使用接口的默認(rèn)方法定義的，然后有沒有發(fā)現(xiàn)當(dāng)斷言失敗后，拋出的異常不是具體的某個(gè)異常，而是交由2個(gè)newException接口方法提供。因?yàn)闃I(yè)務(wù)邏輯中出現(xiàn)的異?；径际菍?duì)應(yīng)特定的場景，比如根據(jù)用戶id獲取用戶信息，查詢結(jié)果為null，此時(shí)拋出的異?？赡転閁serNotFoundException，并且有特定的異常碼(比如7001)和異常信息“用戶不存在”。所以具體拋出什么異常，有Assert的實(shí)現(xiàn)類決定。

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

善解人意的Enum

自定義異常BaseException有2個(gè)屬性，即code、message，這樣一對(duì)屬性，有沒有想到什么類一般也會(huì)定義這2個(gè)屬性？沒錯(cuò)，就是枚舉類。且看我如何將 Enum 和 Assert 結(jié)合起來，相信我一定會(huì)讓你眼前一亮。如下：

public interface IResponseEnum {
int getCode();
String getMessage();
}

/**
*

業(yè)務(wù)異常

*

業(yè)務(wù)處理時(shí)，出現(xiàn)異常，可以拋出該異常

*/
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;
}

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

/**
* 校驗(yàn){@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ù)特定的異常情況定義不同的枚舉實(shí)例，如上面的BAD_LICENCE_TYPE、LICENCE_NOT_FOUND，就能夠針對(duì)不同情況拋出特定的異常(這里指攜帶特定的異常碼和異常消息)，這樣既不用定義大量的異常類，同時(shí)還具備了斷言的良好可讀性，當(dāng)然這種方案的好處遠(yuǎn)不止這些，請繼續(xù)閱讀后文，慢慢體會(huì)。

注：上面舉的例子是針對(duì)特定的業(yè)務(wù)，而有部分異常情況是通用的，比如：服務(wù)器繁忙、網(wǎng)絡(luò)異常、服務(wù)器異常、參數(shù)校驗(yàn)異常、404等，所以有CommonResponseEnum、ArgumentResponseEnum、ServletResponseEnum，其中 ServletResponseEnum 會(huì)在后文詳細(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 {}

與50位技術(shù)專家面對(duì)面20年技術(shù)見證，附贈(zèng)技術(shù)全景圖

總結(jié)

以上是生活随笔為你收集整理的ssm 异常捕获 统一处理_统一异常处理介绍及实战，看这篇就对了的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。