異常處理
通常一個web程序在運行過程中,由于用戶的操作不當(dāng),或者程序的bug,有大量需要處理的異常。其中有些異常是需要暴露給用戶的,比如登陸超時,權(quán)限不足等等??梢酝ㄟ^彈出提示信息的方式告訴用戶出了什么錯誤。
而這就表示在程序中需要一個機制,去處理這些異常,將程序的異常轉(zhuǎn)換為用戶可讀的異常。而且最重要的,是要將這個機制統(tǒng)一,提供統(tǒng)一的異常處理。因為我設(shè)計這個結(jié)構(gòu)的主要目的是為了簡化代碼。
在探尋spring的異常處理機制的時候,我分別使用了三種方式。三種方式都是使用的@ExceptionHandler注解。
當(dāng)一個Controller中有方法加了@ExceptionHandler之后,這個Controller其他方法中沒有捕獲的異常就會以參數(shù)的形式傳入加了@ExceptionHandler注解的那個方法中。
首先需要為自己的系統(tǒng)設(shè)計一個自定義的異常類,通過它來傳遞狀態(tài)碼。
/** * Created by liuruijie.
* 自定義異常
*/
public class SystemException extends RuntimeException{
private String code;//狀態(tài)碼
public SystemException(String message, String code) {
super(message);
this.code = code;
}
public String getCode() {
return code;
}
}
第一種思路,設(shè)計一個基類。
/**
* Created by liuruijie.
* 處理異常的類,需要處理異常的Controller直接繼承這個類
*/
public class BaseController {
/**
* 處理Controller拋出的異常
* @param e 異常實例
* @return Controller層的返回值
*/
@ExceptionHandler
@ResponseBody
public Object expHandler(Exception e){
if(e instanceof SystemException){
SystemException ex= (SystemException) e;
return WebResult.buildResult().status(ex.getCode())
.msg(ex.getMessage());
}else{
e.printStackTrace();
return WebResult.buildResult().status(Config.FAIL)
.msg("系統(tǒng)錯誤");
}
}
}
之后所有需要異常處理的Controller都繼承這個類,從而獲取到異常處理的方法。
雖然這種方式可以解決問題,但是極其不靈活,因為動用了繼承機制就只為獲取一個默認(rèn)的方法,這顯然是不好的。
第二種思路,將這個基類變?yōu)榻涌?,提供此方法的默認(rèn)實現(xiàn)(也就是接口中的default方法,java8開始支持接口方法的默認(rèn)實現(xiàn))
/**
* Created by liuruijie.
* 接口形式的異常處理
*/
public interface DataExceptionSolver {
@ExceptionHandler
@ResponseBody
default Object exceptionHandler(Exception e){
try {
throw e;
} catch (SystemException systemException) {
systemException.printStackTrace();
return WebResult.buildResult().status(systemException.getCode())
.msg(systemException.getMessage());
} catch (Exception e1){
e1.printStackTrace();
return WebResult.buildResult().status(Config.FAIL)
.msg("系統(tǒng)錯誤");
}
}
}
這種方式雖然沒有占用繼承,但是也不是很優(yōu)雅,因為幾乎所有的Controller都需要進行異常處理,于是我每個Controller都需要去寫implement DataExceptionSolver,這顯然不是我真正想要的。況且這種方式依賴java8才有的語法,這是一個很大的局限。
第三種思路,使用加強Controller做全局異常處理。
所謂加強Controller就是@ControllerAdvice注解,有這個注解的類中的方法的某些注解會應(yīng)用到所有的Controller里,其中就包括@ExceptionHandler注解。
于是可以寫一個全局的異常處理類:
/**
* Created by liuruijie on 2016/12/28.
* 全局異常處理,捕獲所有Controller中拋出的異常。
*/
@ControllerAdvice
public class GlobalExceptionHandler {
//處理自定義的異常
@ExceptionHandler(SystemException.class)
@ResponseBody
public Object customHandler(SystemException e){
e.printStackTrace();
return WebResult.buildResult().status(e.getCode()).msg(e.getMessage());
}
//其他未處理的異常
@ExceptionHandler(Exception.class)
@ResponseBody
public Object exceptionHandler(Exception e){
e.printStackTrace();
return WebResult.buildResult().status(Config.FAIL).msg("系統(tǒng)錯誤");
}
}
這個類中只處理了兩個異常,但是已經(jīng)滿足了大部分需要,如果還有需要特殊處理的地方,可以再加上處理的方法就行了。第三種實現(xiàn)方式是目前我知道的最優(yōu)雅的方式了。
如此,我們現(xiàn)在的Controller中的方法就可以很簡潔了,比如處理登陸的邏輯就可以這樣簡單的寫:
/**
* Created by liuruijie on 2016/12/28.
* 賬號
*/
@RestController
@RequestMapping("passport")
public class PassportController {
PassportService passportService;
@RequestMapping("login")
public Object doLogin(HttpSession session, String username, String password){
User user = passportService.doLogin(username, password);
session.setAttribute("user", user);
return WebResult.buildResult().redirectUrl("/student/index");
}
}
而在passprotService的doLogin方法中,可能會拋出用戶名或密碼錯誤等異常,然后就會交由GlobalExceptionHandler去處理,直接返回異常信息給前端,然后前端也不需要關(guān)心是否返回了異常,因為這些都已經(jīng)定義好了。
前端js代碼只需要這樣寫:
//登陸
AJAX.POST("/passport/login", {
username:name,
password:psw
})
一個異常在其中流轉(zhuǎn)的過程為:
比如doLogin方法拋出了自定義異常,其code為:FAIL,message為:用戶名或密碼錯誤,由于在controller的方法中沒有捕獲這個異常,所以會將異常拋給GlobalExceptionHandler,然后GlobalExceptionHandler通過WebResult將狀態(tài)碼和提示信息返回給前端,前端通過默認(rèn)的處理函數(shù),彈框提示用戶“用戶名或密碼錯誤”。而對于這樣的一次交互,我們根本不用編寫異常處理部分的邏輯。
到這里,代碼已經(jīng)簡潔了很多,而且重用性大大提高。