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ì)于用戶來(lái)說(shuō)非常不友好。
本文主要講解如何在SpringBoot應(yīng)用中使用統(tǒng)一異常處理。
實(shí)現(xiàn)方式
- 第一種:使用@ControllerAdvice和@ExceptionHandler注解
- 第二種: 使用ErrorController類來(lái)實(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類來(lái)實(shí)現(xiàn)。
系統(tǒng)默認(rèn)的錯(cuò)誤處理類為BasicErrorController,將會(huì)顯示如上的錯(cuò)誤頁(yè)面。
這里編寫一個(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("訪問(wèn)/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)求,也就是沒(méi)有對(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é)
以上就是這篇文章的全部?jī)?nèi)容了,希望本文的內(nèi)容對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,謝謝大家對(duì)腳本之家的支持。
相關(guān)文章
Java基礎(chǔ)-Java編程語(yǔ)言發(fā)展史
這篇文章主要介紹了Java基礎(chǔ)-Java編程語(yǔ)言發(fā)展簡(jiǎn)史,Java源自Sun公司的一個(gè)叫Green的項(xiàng)目,其原先的目的是為家用電子消費(fèi)產(chǎn)品開(kāi)發(fā)一個(gè)分布式代碼系統(tǒng),這樣就可以將通信和控制信息發(fā)給電冰箱、電視機(jī)、烤面包機(jī)等家用電器,對(duì)它們進(jìn)行控制和信息交流,需要的朋友可以參考一下2022-01-01
Java設(shè)計(jì)模式中的簡(jiǎn)單工廠模式解析
這篇文章主要介紹了Java設(shè)計(jì)模式中的簡(jiǎn)單工廠模式解析,簡(jiǎn)單工廠模式提供一個(gè)創(chuàng)建對(duì)象實(shí)例的功能,而無(wú)須關(guān)心其具體實(shí)現(xiàn),被創(chuàng)建實(shí)例的類型可以是接口、抽象類,也可以是具體的類,需要的朋友可以參考下2023-11-11
SpringSecurity動(dòng)態(tài)加載用戶角色權(quán)限實(shí)現(xiàn)登錄及鑒權(quán)功能
這篇文章主要介紹了SpringSecurity動(dòng)態(tài)加載用戶角色權(quán)限實(shí)現(xiàn)登錄及鑒權(quán)功能,很多朋友感覺(jué)這個(gè)功能很難,今天小編通過(guò)實(shí)例代碼給大家講解,需要的朋友可以參考下2019-11-11
SpringBoot使用Mybatis&Mybatis-plus文件映射配置方法
這篇文章主要介紹了SpringBoot使用Mybatis&Mybatis-plus文件映射配置方法,本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-05-05
Spring IOC的相關(guān)注解運(yùn)用詳解
這篇文章主要介紹了Spring IOC的相關(guān)注解運(yùn)用詳解,純注解實(shí)現(xiàn)IOC需要一個(gè)Java類代替xml文件,這個(gè)Java類上方需要添加@Configuration,表示該類是一個(gè)配置類,作用是代替配置文件,需要的朋友可以參考下2023-08-08
Java畢業(yè)設(shè)計(jì)實(shí)戰(zhàn)之在線高中考試系統(tǒng)的實(shí)現(xiàn)
這是一個(gè)使用了java+SSM+Jsp+Mysql+Maven開(kāi)發(fā)的在線高中考試系統(tǒng),是一個(gè)畢業(yè)設(shè)計(jì)的實(shí)戰(zhàn)練習(xí),具有考試系統(tǒng)該有的所有功能,感興趣的朋友快來(lái)看看吧2022-02-02

