Spring Boot處理全局統(tǒng)一異常的兩種方法與區(qū)別
前言
在后端發(fā)生異?；蛘呤钦?qǐng)求出錯(cuò)時(shí)，前端通常顯示如下
Whitelabel Error Page
This application has no explicit mapping for /error, so you are seeing this as a fallback.Fri Jun 07 15:38:07 CST 2019
There was an unexpected error (type=Not Found, status=404).
No message available
對(duì)于用戶來說非常不友好。
本文主要講解如何在SpringBoot應(yīng)用中使用統(tǒng)一異常處理。
實(shí)現(xiàn)方式
- 第一種：使用@ControllerAdvice和@ExceptionHandler注解
- 第二種: 使用ErrorController類來實(shí)現(xiàn)。
第一種：使用@ControllerAdvice和@ExceptionHandler注解
@Slf4j
@ControllerAdvice
public class GlobalExceptionHandler {
@ResponseBody
@ExceptionHandler(NullPointerException.class)
public BaseResult globalException(HttpServletResponse response,NullPointerException ex){
log.info("GlobalExceptionHandler...");
log.info("錯(cuò)誤代碼：" + response.getStatus());
BaseResult result = new WebResult(WebResult.RESULT_FAIL,"request error:"+response.getStatus()
,"GlobalExceptionHandler:"+ex.getMessage());
return result;
}
}
注解@ControllerAdvice表示這是一個(gè)控制器增強(qiáng)類，當(dāng)控制器發(fā)生異常且符合類中定義的攔截異常類，將會(huì)被攔截。
可以定義攔截的控制器所在的包路徑
@Target({ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Component
public @interface ControllerAdvice {
@AliasFor("basePackages")
String[] value() default {};
@AliasFor("value")
String[] basePackages() default {};
Class<?>[] basePackageClasses() default {};
Class<?>[] assignableTypes() default {};
Class<? extends Annotation>[] annotations() default {};
}
注解ExceptionHandler定義攔截的異常類
@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
@Documented
public @interface ExceptionHandler {
Class<? extends Throwable>[] value() default {};
}
第二種: 使用ErrorController類來實(shí)現(xiàn)。
系統(tǒng)默認(rèn)的錯(cuò)誤處理類為BasicErrorController，將會(huì)顯示如上的錯(cuò)誤頁面。
這里編寫一個(gè)自己的錯(cuò)誤處理類，上面默認(rèn)的處理類將不會(huì)起作用。
getErrorPath()返回的路徑服務(wù)器將會(huì)重定向到該路徑對(duì)應(yīng)的處理類，本例中為error方法。
@Slf4j
@RestController
public class HttpErrorController implements ErrorController {
private final static String ERROR_PATH = "/error";
@ResponseBody
@RequestMapping(path = ERROR_PATH )
public BaseResult error(HttpServletRequest request, HttpServletResponse response){
log.info("訪問/error" + " 錯(cuò)誤代碼：" + response.getStatus());
BaseResult result = new WebResult(WebResult.RESULT_FAIL,"HttpErrorController error:"+response.getStatus());
return result;
}
@Override
public String getErrorPath() {
return ERROR_PATH;
}
}
測(cè)試
以上定義了一個(gè)統(tǒng)一的返回類BaseResult，方便前端進(jìn)行處理。
package com.microblog.common.result;
import java.io.Serializable;
public class BaseResult implements Serializable {
private static final long serialVersionUID = 1L;
public static final int RESULT_FAIL = 0;
public static final int RESULT_SUCCESS = 1;
//返回代碼
private Integer code;
//返回消息
private String message;
//返回對(duì)象
private Object data;
public BaseResult(Integer code, String message) {
this.code = code;
this.message = message;
}
public BaseResult(Integer code, String message, Object object) {
this.code = code;
this.message = message;
this.data = object;
}
public Integer getCode() {
return code;
}
public void setCode(Integer code) {
this.code = code;
}
public String getMessage() {
return message;
}
public void setMessage(String message) {
this.message = message;
}
public Object getData() {
return data;
}
public void setData(Object data) {
this.data = data;
}
}
編寫一個(gè)測(cè)試控制器
@Slf4j
@RestController
@RequestMapping("/user")
public class TestController {
@RequestMapping("/info1")
public String test(){
log.info("/user/info1");
throw new NullPointerException("TestController have exception");
}
}
1.發(fā)出一個(gè)錯(cuò)誤的請(qǐng)求,也就是沒有對(duì)應(yīng)的處理類。
從返回可以看到是由HttpErrorController類處理
{"code":0,"message":"HttpErrorController error:404","data":null}
2.發(fā)出一個(gè)正常的請(qǐng)求(TestController的test()處理)，處理類中拋出空異樣
從返回中可以看出是由GlobalExceptionHandler類處理
{"code":0,"message":"request error:200","data":"GlobalExceptionHandler:TestController have exception"}
區(qū)別
1.注解@ControllerAdvice方式只能處理控制器拋出的異常。此時(shí)請(qǐng)求已經(jīng)進(jìn)入控制器中。
2.類ErrorController方式可以處理所有的異常，包括未進(jìn)入控制器的錯(cuò)誤，比如404,401等錯(cuò)誤
3.如果應(yīng)用中兩者共同存在，則@ControllerAdvice方式處理控制器拋出的異常，類ErrorController方式未進(jìn)入控制器的異常。
4.@ControllerAdvice方式可以定義多個(gè)攔截方法，攔截不同的異常類，并且可以獲取拋出的異常信息，自由度更大。
總結(jié)
以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，謝謝大家對(duì)腳本之家的支持。
相關(guān)文章
logback FixedWindowRollingPolicy固定窗口算法重命名文件滾動(dòng)策略
這篇文章主要介紹了FixedWindowRollingPolicy根據(jù)logback 固定窗口算法重命名文件滾動(dòng)策略源碼解讀,有需要的朋友可以借鑒參考下,希望能夠有所幫助,祝大家多多進(jìn)步,早日升職加薪2023-11-11
本篇文章是對(duì)在java中解決Eclipse掛掉問題的方法進(jìn)行了詳細(xì)的分析介紹，需要的朋友參考下2013-05-05
淺談Java日志框架slf4j作用及其實(shí)現(xiàn)原理
日志記錄是應(yīng)用程序運(yùn)行中必不可少的一部分。這篇文章主要介紹了淺談Java日志框架slf4j作用及其實(shí)現(xiàn)原理，SLF4J是一個(gè)日志框架抽象層，具有一定的參考價(jià)值，感興趣的小伙伴們可以參考一下2018-03-03
這篇文章主要介紹了Java如何防止JS腳本注入代碼實(shí)例,文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友可以參考下2020-09-09
這篇文章主要為大家簡單介紹了Java中ArrayList的使用方法，針對(duì)ArrayList去重問題進(jìn)行擴(kuò)展分析，感興趣的小伙伴們可以參考一下2016-07-07
遺傳算法（Genetic Algorithm，GA）最早是由美國的John holland于20世紀(jì)70年代提出,該算法是根據(jù)大自然中生物體進(jìn)化規(guī)律而設(shè)計(jì)提出的。本文將利用遺傳算法求解最短路徑問題，需要的可以參考一下2022-06-06
Java中AIO、BIO、NIO應(yīng)用場(chǎng)景及區(qū)別
本文主要介紹了Java中AIO、BIO、NIO應(yīng)用場(chǎng)景及區(qū)別，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧2023-06-06
有這樣一個(gè)需求，需要將原本存儲(chǔ)在數(shù)據(jù)庫中的文檔轉(zhuǎn)存至文件系統(tǒng)中，于是寫了一個(gè)簡單的程序完成此功能2012-11-11
筆者前幾日在開服過程中需要將字符串轉(zhuǎn)化成為16進(jìn)制的字符串,在網(wǎng)上找到了一些方法嘗試之后,均發(fā)現(xiàn)存在一個(gè)問題-->字符串轉(zhuǎn)為16進(jìn)制后再轉(zhuǎn)回來,英文正常,中文出現(xiàn)亂碼2009-05-05
這篇文章主要介紹了spring?jpa審計(jì)功能自定義填充字段方式，具有很好的參考價(jià)值，希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方，望不吝賜教2021-11-11