SpringBoot自定義錯誤處理邏輯詳解

第SpringBoot自定義錯誤處理邏輯詳解目錄1.自定義錯誤頁面2.@ControllerAdvice+@ExceptionHandler3.使用@ResponseStatus處理自定義異常4.框架底層異常5.自定義異常解析器6.ErrorViewResolver實現(xiàn)自定義處理異常

1.自定義錯誤頁面

將自定義錯誤頁面放在templates的error文件夾下，SpringBoot精確匹配錯誤信息，使用4xx.html或者5xx.html頁面可以打印錯誤信息

4xx打印status及message信息

h2th:text="${status}"pagenotfound/h2

h3th:text="${#message}"WeCouldn'tFindThisPage/h3

5xx打印message及trace信息

h3th:text="${message}"Somethingwentwrong./h3

pth:text="${trace}"WhynottryrefreshingyoupageOryoucanahref="#"rel="externalnofollow"contactoursupport/aiftheproblempersists./p

2.@ControllerAdvice+@ExceptionHandler

自定義全局異常處理類，處理ArithmeticException及NullPointerException異常

packagecom.wanqing.admin.exception;

importlombok.extern.slf4j.Slf4j;

importorg.springframework.web.bind.annotation.ControllerAdvice;

importorg.springframework.web.bind.annotation.ExceptionHandler;

@Slf4j

@ControllerAdvice//使用此注釋

publicclassGlobalExceptionHandler{

@ExceptionHandler({ArithmeticException.class,NullPointerException.class

})//使用此注釋，大括號內為可以處理的異常信息

publicStringhandleArithException(Exceptione){

("異常是："+e);

return"login";//返回一個視圖地址（ModelAndView）

}

原理：

使用ExceptionHandlerExceptionResolver異常處理器處理用@ExceptionHandler注釋的異常

3.使用@ResponseStatus處理自定義異常

自定義異常類示例代碼：

importorg.springframework.http.HttpStatus;

importorg.springframework.web.bind.annotation.ResponseStatus;

@ResponseStatus(value=HttpStatus.FORBIDDEN,reason="用戶數(shù)量太多~~")//異?？梢苑祷貭顟B(tài)碼信息

publicclassuserToManyextendsRuntimeException{

//有參構造器

publicuserToMany(Stringmessage){

super(message);

publicuserToMany(){

}

原理：

ResponseStatusExceptionResolver處理器可以處理@ResponseStatus注解的異常，得到@ResponseStatus注解的信息，調用response.sendError(statusCode)方法將錯誤信息返回，并發(fā)送/error請求，交由底層處理

sendError表示此次請求立刻結束，發(fā)出/error請求，SpringBoot找誰能處理，都不能處理返回默認的錯誤頁

protectedModelAndViewapplyStatusAndReason(intstatusCode,@NullableStringreason,HttpServletResponseresponse)throwsIOException{

if(!StringUtils.hasLength(reason)){

response.sendError(statusCode);

}else{

StringresolvedReason=this.messageSource!=nullthis.messageSource.getMessage(reason,(Object[])null,reason,LocaleContextHolder.getLocale()):reason;

response.sendError(statusCode,resolvedReason);

returnnewModelAndView();

}

4.框架底層異常

使用DefaultHandlerExceptionResolver異常處理器能處理SpringMVC底層異常，其能處理我異常種類如下

protectedModelAndViewdoResolveException(HttpServletRequestrequest,HttpServletResponseresponse,@NullableObjecthandler,Exceptionex){

try{

if(exinstanceofHttpRequestMethodNotSupportedException){

returnthis.handleHttpRequestMethodNotSupported((HttpRequestMethodNotSupportedException)ex,request,response,handler);

//此處省略

if(exinstanceofHttpMessageNotWritableException){

returnthis.handleHttpMessageNotWritable((HttpMessageNotWritableException)ex,request,response,handler);

if(exinstanceofMethodArgumentNotValidException){

returnthis.handleMethodArgumentNotValidException((MethodArgumentNotValidException)ex,request,response,handler);

}catch(Exceptionvar6){

if(this.logger.isWarnEnabled()){

this.logger.warn("Failurewhiletryingtoresolveexception["+ex.getClass().getName()+"]",var6);

returnnull;

}

5.自定義異常解析器

自定義異常解析器需要滿足以下：

實現(xiàn)HandlerExceptionResolver接口并注冊到容器中（@Component）在自定義解析器中實現(xiàn)resolveException方法，方法內可通過sendError方法返回錯誤信息并返回一空視圖，交給底層將錯誤信息解析拼接為最終頁面可以通過@Order注釋調整自定義異常解析器的優(yōu)先級，value越小優(yōu)先級越高

自定義異常解析器示例代碼：

importjavax.servlet.http.HttpServletResponse;

importjava.io.IOException;

@Order(value=Ordered.HIGHEST_PRECEDENCE)//優(yōu)先級數(shù)字越小，優(yōu)先級越高

@Component//注冊到容器中

publicclassCustomerHandlerResolverimplementsHandlerExceptionResolver{

@Override

publicModelAndViewresolveException(HttpServletRequesthttpServletRequest,HttpServletResponsehttpServletResponse,Objecto,Exceptione){

try{

httpServletResponse.sendError(511,"我不喜歡的錯誤");

}catch(IOExceptione1){

e1.printStackTrace();

returnnewModelAndView();

}

自定義異常處理器被加入（未調整優(yōu)先級時，默認加到最后）：

6.ErrorViewResolver實現(xiàn)自定義處理異常

交由ErrorViewResolver的情況：

情況一：response.se