Spring Boot處理全局統(tǒng)一異常的兩種方法與區(qū)別
前言
在后端發(fā)生異常或者是請求出錯時，前端通常顯示如下
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
對于用戶來說非常不友好。
本文主要講解如何在SpringBoot應用中使用統(tǒng)一異常處理。
實現(xiàn)方式
- 第一種：使用@ControllerAdvice和@ExceptionHandler注解
- 第二種: 使用ErrorController類來實現(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("錯誤代碼：" + response.getStatus());
BaseResult result = new WebResult(WebResult.RESULT_FAIL,"request error:"+response.getStatus()
,"GlobalExceptionHandler:"+ex.getMessage());
return result;
}
}
注解@ControllerAdvice表示這是一個控制器增強類，當控制器發(fā)生異常且符合類中定義的攔截異常類，將會被攔截。
可以定義攔截的控制器所在的包路徑
@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類來實現(xiàn)。
系統(tǒng)默認的錯誤處理類為BasicErrorController，將會顯示如上的錯誤頁面。
這里編寫一個自己的錯誤處理類，上面默認的處理類將不會起作用。
getErrorPath()返回的路徑服務器將會重定向到該路徑對應的處理類，本例中為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" + " 錯誤代碼：" + response.getStatus());
BaseResult result = new WebResult(WebResult.RESULT_FAIL,"HttpErrorController error:"+response.getStatus());
return result;
}
@Override
public String getErrorPath() {
return ERROR_PATH;
}
}
測試
以上定義了一個統(tǒng)一的返回類BaseResult，方便前端進行處理。
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;
//返回對象
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;
}
}
編寫一個測試控制器
@Slf4j
@RestController
@RequestMapping("/user")
public class TestController {
@RequestMapping("/info1")
public String test(){
log.info("/user/info1");
throw new NullPointerException("TestController have exception");
}
}
1.發(fā)出一個錯誤的請求,也就是沒有對應的處理類。
從返回可以看到是由HttpErrorController類處理
{"code":0,"message":"HttpErrorController error:404","data":null}
2.發(fā)出一個正常的請求(TestController的test()處理)，處理類中拋出空異樣
從返回中可以看出是由GlobalExceptionHandler類處理
{"code":0,"message":"request error:200","data":"GlobalExceptionHandler:TestController have exception"}
區(qū)別
1.注解@ControllerAdvice方式只能處理控制器拋出的異常。此時請求已經進入控制器中。
2.類ErrorController方式可以處理所有的異常，包括未進入控制器的錯誤，比如404,401等錯誤
3.如果應用中兩者共同存在，則@ControllerAdvice方式處理控制器拋出的異常，類ErrorController方式未進入控制器的異常。
4.@ControllerAdvice方式可以定義多個攔截方法，攔截不同的異常類，并且可以獲取拋出的異常信息，自由度更大。
總結
以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，謝謝大家對腳本之家的支持。
相關文章
這篇文章主要介紹了Java基礎-Java編程語言發(fā)展簡史,Java源自Sun公司的一個叫Green的項目,其原先的目的是為家用電子消費產品開發(fā)一個分布式代碼系統(tǒng),這樣就可以將通信和控制信息發(fā)給電冰箱、電視機、烤面包機等家用電器,對它們進行控制和信息交流,需要的朋友可以參考一下2022-01-01
這篇文章主要介紹了Java設計模式中的簡單工廠模式解析,簡單工廠模式提供一個創(chuàng)建對象實例的功能,而無須關心其具體實現(xiàn),被創(chuàng)建實例的類型可以是接口、抽象類,也可以是具體的類,需要的朋友可以參考下2023-11-11
SpringSecurity動態(tài)加載用戶角色權限實現(xiàn)登錄及鑒權功能
這篇文章主要介紹了SpringSecurity動態(tài)加載用戶角色權限實現(xiàn)登錄及鑒權功能，很多朋友感覺這個功能很難，今天小編通過實例代碼給大家講解,需要的朋友可以參考下2019-11-11
這篇文章主要介紹了Java設計模式中的外觀模式詳解，外觀模式也叫“過程模式，外觀模式為子系統(tǒng)中的一組接口提供一個一致的界面，此模式定義了一個高層接口，這個接口使得這一子系統(tǒng)更加容易使用2022-07-07
這篇文章主要介紹了Springboot如何集成websocket問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-07-07
這篇文章主要介紹了解析Java 泛型什么情況下不能使用，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2020-05-05
轉換流可以將一個字節(jié)流包裝成字符流,或者將一個字符流包裝成字節(jié)流,本文主要介紹了java IO流之轉換流的具體使用,具有一定的參考價值,感興趣的可以了解一下2024-01-01
SpringBoot使用Mybatis&Mybatis-plus文件映射配置方法
這篇文章主要介紹了SpringBoot使用Mybatis&Mybatis-plus文件映射配置方法,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-05-05
這篇文章主要介紹了Spring IOC的相關注解運用詳解,純注解實現(xiàn)IOC需要一個Java類代替xml文件,這個Java類上方需要添加@Configuration，表示該類是一個配置類，作用是代替配置文件,需要的朋友可以參考下2023-08-08
Java畢業(yè)設計實戰(zhàn)之在線高中考試系統(tǒng)的實現(xiàn)
這是一個使用了java+SSM+Jsp+Mysql+Maven開發(fā)的在線高中考試系統(tǒng)，是一個畢業(yè)設計的實戰(zhàn)練習，具有考試系統(tǒng)該有的所有功能，感興趣的朋友快來看看吧2022-02-02