原文:http://u6。gg/kpz4f
軟體開發過程中,不可避免的是需要處理各種異常,就我自己來說,至少有一半以上的時間都是在處理各種異常情況,所以程式碼中就會出現大量的 try {。。。} catch {。。。} finally {。。。} 程式碼塊,不僅有大量的冗餘程式碼,而且還影響程式碼的可讀性。
比較下面兩張圖,看看您現在編寫的程式碼屬於哪一種風格?然後哪種編碼風格您更喜歡?
醜陋的 try catch 程式碼塊:
優雅的 Controller:
上面的示例,還只是在 Controller 層,如果是在 Service 層,可能會有更多的 try catch 程式碼塊。這將會嚴重影響程式碼的可讀性、“美觀性”。
所以如果是我的話,我肯定偏向於第二種,我可以把更多的精力放在業務程式碼的開發,同時代碼也會變得更加簡潔。
既然業務程式碼不顯式地對異常進行捕獲、處理,而異常肯定還是處理的,不然系統豈不是動不動就崩潰了,所以必須得有其他地方捕獲並處理這些異常。
那麼問題來了,如何優雅的處理各種異常?
什麼是統一異常處理
Spring 在 3。2 版本增加了一個註解 @ControllerAdvice,可以與 @ExceptionHandler、@InitBinder、@ModelAttribute 等註解註解配套使用。
對於這幾個註解的作用,這裡不做過多贅述,若有不瞭解的,可以參考 Spring 3。2 新註解 @ControllerAdvice,先大概有個瞭解。
不過跟異常處理相關的只有註解 @ExceptionHandler,從字面上看,就是異常處理器的意思。
其實際作用也是:
若在某個 Controller 類定義一個異常處理方法,並在方法上新增該註解,那麼當出現指定的異常時,會執行該處理異常的方法。
其可以使用 SpringMVC 提供的資料繫結,比如注入 HttpServletRequest 等,還可以接受一個當前丟擲的 Throwable 物件。
但是,這樣一來,就必須在每一個 Controller 類都定義一套這樣的異常處理方法,因為異常可以是各種各樣。這樣一來,就會造成大量的冗餘程式碼,而且若需要新增一種異常的處理邏輯,就必須修改所有 Controller 類了,很不優雅。
當然你可能會說,那就定義個類似 BaseController 的基類,這樣總行了吧。
這種做法雖然沒錯,但仍不盡善盡美,因為這樣的程式碼有一定的侵入性和耦合性。簡簡單單的 Controller,我為啥非得繼承這樣一個類呢,萬一已經繼承其他基類了呢。大家都知道 Java 只能繼承一個類。
那有沒有一種方案,既不需要跟 Controller 耦合,也可以將定義的異常處理器應用到所有控制器呢?
所以註解 @ControllerAdvice 出現了,簡單的說,該註解可以把異常處理器應用到所有控制器,而不是單個控制器。
藉助該註解,我們可以實現:
在獨立的某個地方,比如單獨一個類,定義一套對各種異常的處理機制,然後在類的簽名加上註解 @ControllerAdvice,統一對不同階段的、不同異常進行處理。這就是統一異常處理的原理。
注意到上面對異常按階段進行分類,大體可以分成:進入 Controller 前的異常和 Service 層異常。
具體可以參考下圖:
不同階段的異常
目標
消滅 95% 以上的 try catch 程式碼塊,以優雅的 Assert(斷言)方式來校驗業務的異常情況,只關注業務邏輯,而不用花費大量精力寫冗餘的 try catch 程式碼塊。
統一異常處理實戰
在定義統一異常處理類之前,先來介紹一下如何優雅的判定異常情況並拋異常。
| 用 Assert(斷言)替換 throw exception
使用斷言能讓我們編碼的時候有一種非一般絲滑的感覺,比如:
@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 {。。。} 封裝了一下,是不是很神奇?雖然很簡單,但不可否認的是編碼體驗至少提升了一個檔次。
下面讓我們來嘗試一下:
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 斷言方法是使用介面的預設方法定義的,然後有沒有發現當斷言失敗後,丟擲的異常不是具體的某個異常,而是交由 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(“$”)
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 {}”, e。getClass()。getName(), ServletResponseEnum。class。getName());
}
if (ENV_PROD。equals(profile)) {
// 當為生產環境, 不適合把具體的異常資訊展示給使用者, 比如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());
}
/**
* 引數繫結異常
*
* @param e 異常
* @return 異常結果
*/
@ExceptionHandler(value = BindException。class)
@ResponseBody
public ErrorResponse handleBindException(BindException e) {
log。error(“引數繫結校驗異常”, e);
return wrapperBindingResult(e。getBindingResult());
}
/**
* 引數校驗異常,將校驗失敗的所有異常組合成一條錯誤資訊
*
* @param e 異常
* @return 異常結果
*/
@ExceptionHandler(value = MethodArgumentNotValidException。class)
@ResponseBody
public ErrorResponse handleValidException(MethodArgumentNotValidException e) {
log。error(“引數繫結校驗異常”, e);
return wrapperBindingResult(e。getBindingResult());
}
/**
* 包裝繫結異常結果
*
* @param bindingResult 繫結結果
* @return 異常結果
*/
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 異常結果
*/
@ExceptionHandler(value = Exception。class)
@ResponseBody
public ErrorResponse handleException(Exception e) {
log。error(e。getMessage(), e);
if (ENV_PROD。equals(profile)) {
// 當為生產環境, 不適合把具體的異常資訊展示給使用者, 比如資料庫異常資訊。
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。
還記得上文提到的按階段分類嗎,即對應進入 Controller 前的異常 和 Service 層異常;然後 ServiceException 再分成自定義異常、未知異常。
對應關係如下:
進入 Controller 前的異常:handleServletException、handleBindException、handleValidException
自定義異常:handleBusinessException、handleBaseException
未知異常:handleException
接下來分別對這幾種異常處理器做詳細說明。
異常處理器說明
| handleServletException
一個 http 請求,在到達 Controller 前,會對該請求的請求資訊與目標控制器資訊做一系列校驗。
這裡簡單說一下:
NoHandlerFoundException:
首先根據請求 Url 查詢有沒有對應的控制器,若沒有則會拋該異常,也就是大家非常熟悉的 404 異常。
HttpRequestMethodNotSupportedException:
若匹配到了(匹配結果是一個列表,不同的是 http 方法不同,如:Get、Post 等),則嘗試將請求的 http 方法與列表的控制器做匹配,若沒有對應 http 方法的控制器,則拋該異常。
HttpMediaTypeNotSupportedException:
然後再對請求頭與控制器支援的做比較。
比如 content-type 請求頭,若控制器的引數簽名包含註解 @RequestBody,但是請求的 content-type 請求頭的值沒有包含 application/json,那麼會拋該異常(當然,不止這種情況會拋這個異常)。
MissingPathVariableException:
未檢測到路徑引數。比如 url 為:/licence/,引數簽名包含 @PathVariable(“licenceId”)。
當請求的 url 為 /licence,在沒有明確定義 url 為 /licence 的情況下,會被判定為:缺少路徑引數。
MissingServletRequestParameterException:
缺少請求引數。比如定義了引數 @RequestParam(“licenceId”) String licenceId,但發起請求時,未攜帶該引數,則會拋該異常。
TypeMismatchException:
引數型別匹配失敗。比如:接收引數為 Long 型,但傳入的值確是一個字串,那麼將會出現型別轉換失敗的情況,這時會拋該異常。
HttpMessageNotReadableException:
與上面的 HttpMediaTypeNotSupportedException 舉的例子完全相反。
即請求頭攜帶了“content-type: application/json;charset=UTF-8”,但接收引數卻沒有添加註解 @RequestBody,或者請求體攜帶的 json 串反序列化成 pojo 的過程中失敗了,也會拋該異常。
HttpMessageNotWritableException:
返回的 pojo 在序列化成 json 過程失敗了,那麼拋該異常。
| handleBindException
引數校驗異常,後文詳細說明。
| handleValidException
引數校驗異常,後文詳細說明。
| handleBusinessException、handleBaseException
處理自定義的業務異常,只是 handleBaseException 處理的是除了 BusinessException 意外的所有業務異常。就目前來看,這 2 個是可以合併成一個的。
| handleException
處理所有未知的異常,比如操作資料庫失敗的異常。
注:上面的 handleServletException、handleException 這兩個處理器,返回的異常資訊,不同環境返回的可能不一樣,以為這些異常資訊都是框架自帶的異常資訊,一般都是英文的,不太好直接展示給使用者看,所以統一返回 SERVER_ERROR 代表的異常資訊。
異於常人的404
上文提到,當請求沒有匹配到控制器的情況下,會丟擲 NoHandlerFoundException 異常,但其實預設情況下不是這樣,預設情況下會出現類似如下頁面:
Whitelabel Error Page
這個頁面是如何出現的呢?實際上,當出現 404 的時候,預設是不拋異常的,而是 forward 跳轉到 /error 控制器。
Spring 也提供了預設的 error 控制器,如下:
那麼,如何讓 404 也丟擲異常呢,只需在 properties 檔案中加入如下配置即可:
spring。mvc。throw-exception-if-no-handler-found=true
spring。resources。add-mappings=false
如此,就可以異常處理器中捕獲它了,然後前端只要捕獲到特定的狀態碼,立即跳轉到 404 頁面即可。
捕獲404對應的異常
| 統一返回結果
在驗證統一異常處理器之前,順便說一下統一返回結果。說白了,其實是統一一下返回結果的資料結構。
code、message 是所有返回結果中必有的欄位,而當需要返回資料時,則需要另一個欄位 data 來表示。
所以首先定義一個 BaseResponse 來作為所有返回結果的基類;然後定義一個通用返回結果類 CommonResponse,繼承 BaseResponse,而且多了欄位 data。
為了區分成功和失敗返回結果,於是再定義一個 ErrorResponse。
最後還有一種常見的返回結果,即返回的資料帶有分頁資訊,因為這種介面比較常見,所以有必要單獨定義一個返回結果類 QueryDataResponse。
該類繼承自 CommonResponse,只是把 data 欄位的型別限制為 QueryDdata,QueryDdata中定義了分頁資訊相應的欄位,即 totalCount、pageNo、 pageSize、records。
其中比較常用的只有 CommonResponse 和 QueryDataResponse,但是名字又賊鬼死長,何不定義 2 個名字超簡單的類來替代呢?
於是 R 和 QR 誕生了,以後返回結果的時候只需這樣寫:new R(data)、new QR(queryData)。
所有的返回結果類的定義這裡就不貼出來了。
| 驗證統一異常處理
因為這一套統一異常處理可以說是通用的,所有可以設計成一個 common包,以後每一個新專案/模組只需引入該包即可。所以為了驗證,需要新建一個專案,並引入該 common 包。
下面是用於驗證的主要原始碼:
@Service
public class LicenceService extends ServiceImpl {
@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 分頁查詢引數
* @return
*/
public QueryData getLicences(LicenceParam licenceParam) {
String licenceType = licenceParam。getLicenceType();
LicenceTypeEnum licenceTypeEnum = LicenceTypeEnum。parseOfNullable(licenceType);
// 斷言, 非空
ResponseEnum。BAD_LICENCE_TYPE。assertNotNull(licenceTypeEnum);
LambdaQueryWrapper wrapper = new LambdaQueryWrapper();
wrapper。eq(Licence::getLicenceType, licenceType);
IPage 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。
啟動時,自動插入的資料為:
—— 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
成功響應的請求:
licenceId=1
檢驗非空:
捕獲 Licence not found 異常:
Licence not found:
根據不存在的 licence type 獲取 licence 列表:http://localhost:10000/licence/list?licenceType=ddd。可選的 licence type 為:user、core-prod 。
校驗非空:
捕獲 Bad licence type 異常:
Bad licence type:
| 捕獲進入 Controller 前的異常
訪問不存在的介面:
http://localhost:10000/licence/list/ddd
捕獲 404 異常:
http 方法不支援:
http://localhost:10000/licence
PostMapping:
捕獲 Request method not supported 異常:
Request method not supported:
校驗異常 1:
http://localhost:10000/licence/list?licenceType=
getLicences:
LicenceParam:
捕獲引數繫結校驗異常:
licence type cannot be empty:
校驗異常 2:
post 請求,這裡使用 postman 模擬
addLicence:
LicenceAddRequest:
請求 url 即結果:
捕獲引數繫結校驗異常:
注:
因為引數繫結校驗異常的異常資訊的獲取方式與其它異常不一樣,所以才把這 2 種情況的異常從進入 Controller 前的異常單獨拆出來,下面是異常資訊的收集邏輯。
異常資訊的收集:
| 捕獲未知異常
假設我們現在隨便對 Licence 新增一個欄位 test,但不修改資料庫表結構,然後訪問:http://localhost:10000/licence/1。
增加 test 欄位:
捕獲資料庫異常:
Error querying database:
小結
可以看到,測試的異常都能夠被捕獲,然後以 code、message 的形式返回。
每一個專案/模組,在定義業務異常的時候,只需定義一個列舉類,然後實現介面 BusinessExceptionAssert,最後為每一種業務異常定義對應的列舉例項即可,而不用定義許多異常類。使用的時候也很方便,用法類似斷言。
擴充套件
在生產環境,若捕獲到未知異常或者 ServletException,因為都是一長串的異常資訊,若直接展示給使用者看,顯得不夠專業,於是,我們可以這樣做:當檢測到當前環境是生產環境,那麼直接返回 “網路異常”。
生產環境返回“網路異常”:
可以透過以下方式修改當前環境:
總結
使用斷言和列舉類相結合的方式,再配合統一異常處理,基本大部分的異常都能夠被捕獲。
為什麼說大部分異常,因為當引入 spring cloud security 後,還會有認證/授權異常,閘道器的服務降級異常、跨模組呼叫異常、遠端呼叫第三方服務異常等,這些異常的捕獲方式與本文介紹的不太一樣,不過限於篇幅,這裡不做詳細說明,以後會有單獨的文章介紹。
另外,當需要考慮國際化的時候,捕獲異常後的異常資訊一般不能直接返回,需要轉換成對應的語言,不過本文已考慮到了這個,獲取訊息的時候已經做了國際化對映,邏輯如下:
獲取國際化訊息
最後總結,全域性異常屬於老生長談的話題,希望這次透過手機的專案對大家有點指導性的學習,大家根據實際情況自行修改。
也可以採用以下的 jsonResult 物件的方式進行處理,也貼出來程式碼:
@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;
}
/**
* 業務異常
* @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(“業務異常,請聯絡管理員”);
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(“系統錯誤,請聯絡管理員”);
return jsonResult;
}
}
你在看嗎