ssm 异常捕获 统一处理_统一异常处理介绍及实战，看这篇就对了
點擊上方 "程序員小樂"關注, 星標或置頂一起成長
每天凌晨00點00分, 第一時間與你相約
每日英文
Don’t let anyone steal your dreams. Follow your heart, no matter what.
不論做什么事，相信你自己，別讓別人的一句話將你擊倒。
每日掏心話
睡的時候，不辜負床，忙的時候，不辜負路，愛的時候，不辜負人，餓的時候，不辜負胃。
來自：sprinkle_liz | 責編：樂樂
鏈接：jianshu.com/p/3f3d9e8d1efa
程序員小樂(ID:study_tech)第 811 次推文 圖片來自百度
往日回顧：三分鐘基礎：CPU 到底是怎么認識代碼的？
正文
背景
軟件開發過程中，不可避免的是需要處理各種異常，就我自己來說，至少有一半以上的時間都是在處理各種異常情況，所以代碼中就會出現大量的try {...} catch {...} finally {...} 代碼塊，不僅有大量的冗余代碼，而且還影響代碼的可讀性。比較下面兩張圖，看看您現在編寫的代碼屬于哪一種風格？然后哪種編碼風格您更喜歡？
丑陋的 try catch 代碼塊
優雅的Controller
上面的示例，還只是在Controller層，如果是在Service層，可能會有更多的try catch代碼塊。這將會嚴重影響代碼的可讀性、“美觀性”。
所以如果是我的話，我肯定偏向于第二種，我可以把更多的精力放在業務代碼的開發，同時代碼也會變得更加簡潔。
既然業務代碼不顯式地對異常進行捕獲、處理，而異常肯定還是處理的，不然系統豈不是動不動就崩潰了，所以必須得有其他地方捕獲并處理這些異常。
那么問題來了，如何優雅的處理各種異常？
什么是統一異常處理
Spring在3.2版本增加了一個注解@ControllerAdvice，可以與@ExceptionHandler、@InitBinder、@ModelAttribute 等注解注解配套使用，對于這幾個注解的作用，這里不做過多贅述。
不過跟異常處理相關的只有注解@ExceptionHandler，從字面上看，就是 異常處理器 的意思，其實際作用也是：若在某個Controller類定義一個異常處理方法，并在方法上添加該注解，那么當出現指定的異常時，會執行該處理異常的方法，其可以使用springmvc提供的數據綁定，比如注入HttpServletRequest等，還可以接受一個當前拋出的Throwable對象。
但是，這樣一來，就必須在每一個Controller類都定義一套這樣的異常處理方法，因為異常可以是各種各樣。這樣一來，就會造成大量的冗余代碼，而且若需要新增一種異常的處理邏輯，就必須修改所有Controller類了，很不優雅。
當然你可能會說，那就定義個類似BaseController的基類，這樣總行了吧。
這種做法雖然沒錯，但仍不盡善盡美，因為這樣的代碼有一定的侵入性和耦合性。簡簡單單的Controller，我為啥非得繼承這樣一個類呢，萬一已經繼承其他基類了呢。大家都知道Java只能繼承一個類。
那有沒有一種方案，既不需要跟Controller耦合，也可以將定義的 異常處理器 應用到所有控制器呢？所以注解@ControllerAdvice出現了，簡單的說，該注解可以把異常處理器應用到所有控制器，而不是單個控制器。借助該注解，我們可以實現：在獨立的某個地方，比如單獨一個類，定義一套對各種異常的處理機制，然后在類的簽名加上注解@ControllerAdvice，統一對 不同階段的、不同異常 進行處理。這就是統一異常處理的原理。
注意到上面對異常按階段進行分類，大體可以分成：進入Controller前的異常 和 Service 層異常，具體可以參考下圖：
不同階段的異常
目標
消滅95%以上的 try catch 代碼塊，以優雅的 Assert(斷言) 方式來校驗業務的異常情況，只關注業務邏輯，而不用花費大量精力寫冗余的 try catch 代碼塊。
統一異常處理實戰
注：因為整個統一異常處理方案涉及的代碼比較多，這里不方便貼出所有代碼，只會貼出關鍵部分，所以建議將源碼clone到本地方便查看。源碼地址：https://github.com/sprainkle/spring-cloud-advance，涉及到的項目包括：spring-cloud-advance-common、unified-exception-handling。
在定義統一異常處理類之前，先來介紹一下如何優雅的判定異常情況并拋異常。
用 Assert(斷言) 替換 throw exception
想必 Assert(斷言) 大家都很熟悉，比如 Spring 家族的 org.springframework.util.Assert，在我們寫測試用例的時候經常會用到，使用斷言能讓我們編碼的時候有一種非一般絲滑的感覺，比如：
@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("用戶不存在.");
}
}
有沒有感覺第一種判定非空的寫法很優雅，第二種寫法則是相對丑陋的 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 {...} 封裝了一下，是不是很神奇。雖然很簡單，但不可否認的是編碼體驗至少提升了一個檔次。那么我們能不能模仿org.springframework.util.Assert，也寫一個斷言類，不過斷言失敗后拋出的異常不是IllegalArgumentException 這些內置異常，而是我們自己定義的異常。下面讓我們來嘗試一下。
Assert
public interface Assert {
/**
* 創建異常
* @param args
* @return
*/
BaseException newException(Object... args);
/**
* 創建異常
* @param t
* @param args
* @return
*/
BaseException newException(Throwable t, Object... args);
/**
*
斷言對象obj非空。如果對象obj為空，則拋出異常
*
* @param obj 待判斷對象
*/
default void assertNotNull(Object obj) {
if (obj == null) {
throw newException(obj);
}
}
/**
*
斷言對象obj非空。如果對象obj為空，則拋出異常
*
異常信息message支持傳遞參數方式，避免在判斷之前進行字符串拼接操作
*
* @param obj 待判斷對象
* @param args message占位符對應的參數列表
*/
default void assertNotNull(Object obj, Object... args) {
if (obj == null) {
throw newException(args);
}
}
}
注：
這里只給出Assert接口的部分源碼，更多斷言方法請參考源碼。
BaseException 是所有自定義異常的基類。
在接口中定義默認方法是Java8的新語法。
上面的Assert斷言方法是使用接口的默認方法定義的，然后有沒有發現當斷言失敗后，拋出的異常不是具體的某個異常，而是交由2個newException接口方法提供。因為業務邏輯中出現的異常基本都是對應特定的場景，比如根據用戶id獲取用戶信息，查詢結果為null，此時拋出的異常可能為UserNotFoundException，并且有特定的異常碼(比如7001)和異常信息“用戶不存在”。所以具體拋出什么異常，有Assert的實現類決定。
看到這里，您可能會有這樣的疑問，按照上面的說法，那豈不是有多少異常情況，就得有定義等量的斷言類和異常類，這顯然是反人類的，這也沒想象中高明嘛。別急，且聽我細細道來。
善解人意的Enum
自定義異常BaseException有2個屬性，即code、message，這樣一對屬性，有沒有想到什么類一般也會定義這2個屬性？沒錯，就是枚舉類。且看我如何將 Enum 和 Assert 結合起來，相信我一定會讓你眼前一亮。如下：
public interface IResponseEnum {
int getCode();
String getMessage();
}
/**
*
業務異常
*
業務處理時，出現異常，可以拋出該異常
*/
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，分別對應了BadLicenceTypeException、LicenceNotFoundException兩種異常。以后每增加一種異常情況，只需增加一個枚舉實例即可，再也不用每一種異常都定義一個異常類了。然后再來看下如何使用，假設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.");
}
}
使用枚舉類結合(繼承)Assert，只需根據特定的異常情況定義不同的枚舉實例，如上面的BAD_LICENCE_TYPE、LICENCE_NOT_FOUND，就能夠針對不同情況拋出特定的異常(這里指攜帶特定的異常碼和異常消息)，這樣既不用定義大量的異常類，同時還具備了斷言的良好可讀性，當然這種方案的好處遠不止這些，請繼續閱讀后文，慢慢體會。
注：上面舉的例子是針對特定的業務，而有部分異常情況是通用的，比如：服務器繁忙、網絡異常、服務器異常、參數校驗異常、404等，所以有CommonResponseEnum、ArgumentResponseEnum、ServletResponseEnum，其中 ServletResponseEnum 會在后文詳細說明。
定義統一異常處理器類
@Slf4j
@Component
@ControllerAdvice
@ConditionalOnWebApplication
@ConditionalOnMissingBean(UnifiedExceptionHandler.class)
public class UnifiedExceptionHandler {
/**
* 生產環境
*/
private final static String ENV_PROD = "prod";
@Autowired
private UnifiedMessageSource unifiedMessageSource;
/**
* 當前環境
*/
@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;
}
/**
* 業務異常
*
* @param e 異常
* @return 異常結果
*/
@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 異常結果
*/
@ExceptionHandler(value = BaseException.class)
@ResponseBody
public ErrorResponse handleBaseException(BaseException e) {
log.error(e.getMessage(), e);
return new ErrorResponse(e.getResponseEnum().getCode(), getMessage(e));
}
/**
* Controller上一層相關異常
*
* @param e 異常
* @return 異常結果
*/
@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 {}
總結
以上是生活随笔為你收集整理的ssm 异常捕获 统一处理_统一异常处理介绍及实战，看这篇就对了的全部內容，希望文章能夠幫你解決所遇到的問題。
- 上一篇： ospf 环回口的路由条目_【网络工程师
- 下一篇： 拷贝文件不移动_在不使用 mv 命令的情