springboot實(shí)現(xiàn)全局異常捕獲的使用示例
導(dǎo)言:
為什么要做異常處理:
原因有三:
1、將系統(tǒng)產(chǎn)生的全部異常統(tǒng)一捕獲處理。
2、自定義異常需要由全局異常來捕獲。
3、JSR303規(guī)范的validator參數(shù)校驗(yàn)器、參數(shù)校驗(yàn)不通過、本身無法使用try…catch
其實(shí)對(duì)于前后端分離的項(xiàng)目做異常處理是很有必要的
在不出異常的情況下,后端將數(shù)據(jù)封裝成固定格式(也就是R類)返回給前端,方便前端去解析數(shù)據(jù)
例如如下R類:
@Data
public class R<T> implements Serializable {
private Integer code; //編碼:1成功,0和其它數(shù)字為失敗
private String msg; //錯(cuò)誤信息
private T data; //數(shù)據(jù)
private Map map = new HashMap(); //動(dòng)態(tài)數(shù)據(jù)
public static <T> R<T> success(T object) {
R<T> r = new R<T>();
r.data = object;
r.code = 1;
return r;
}
public static <T> R<T> success(String msg,T object) {
R<T> r = new R<T>();
r.data = object;
r.code = 1;
r.msg = msg;
return r;
}
public static <T> R<T> error(String msg) {
R r = new R();
r.msg = msg;
r.code = 0;
return r;
}
public static <T> R<T> success(String msg) {
R r = new R();
r.msg = msg;
r.code = 1;
return r;
}
public R<T> add(String key, Object value) {
this.map.put(key, value);
return this;
}
}
正常不出異常的情況下根據(jù)controller層返回的數(shù)據(jù):
controller層
//正常情況
@GetMapping("/hhy/1")
public R info(){
int i = 60/1;
return R.success("成功",i);
}
請(qǐng)求成功返回給前端數(shù)據(jù):


在出異常的情況下(模擬除0異常):
controller層:
//空指針異常
@GetMapping("/hhy/2")
public R info2(){
int i = 60/0;
return R.success("成功",i);
}
出現(xiàn)異常前端拿不到數(shù)據(jù),并且后端報(bào)錯(cuò):

前端:

后端:

這樣雖然后端可以知道異常情況,但是前端就難受了,啥也不知道,就知道出錯(cuò)了;
重點(diǎn)來了?。。。?!
這里就可以體現(xiàn)全局異常處理器的重要性了;讓前端的兄弟好受一點(diǎn)。
實(shí)現(xiàn)全局異常處理器捕獲異常
舉例:異常還是除0 異常:
java.lang.ArithmeticException: / by zero
這里的異常就是ArithmeticException,異常信息為/ by zero
編寫全局異常捕獲類:GlobalExceptionHandler
/**
* 全局異常捕獲
*/
@Slf4j
@ControllerAdvice(annotations = {RestController.class, Controller.class})
//只要類的注解上有這些注解。那么發(fā)生的異常都能被捕獲到
@ResponseBody
public class GlobalExceptionHandler {
/**
* 處理除0異常捕獲
* @param exception
* @return
*/
@ExceptionHandler(ArithmeticException.class)//ArithmeticException異常類型通過注解拿到
public R<String> exceptionHandler(ArithmeticException exception){
log.error(exception.getMessage());//在控制臺(tái)打印錯(cuò)誤信息
return R.error(exception.getMessage());
}
}
此時(shí)在controller層出現(xiàn)ArithmeticException(除0)異常時(shí)就會(huì)被全局異常處理器捕獲到:
后端::相比之前一大串報(bào)錯(cuò),是不是很清爽

前端:
在異常處理器里面已將錯(cuò)誤信息封裝成返回類R返回給前端

相比之前返回給前端的一大串雜七雜八的,這個(gè)是不是超級(jí)清爽,并且可以根據(jù)code碼在前端將錯(cuò)誤信息設(shè)置警告框

這樣前端的兄弟看到信息就知道,嗷嗷 后端出問題了 問題是除0異常,這樣就可以安心的去甩鍋給后端的哥們了;
實(shí)現(xiàn)原理:
想必注意到這個(gè)注解:
@ControllerAdvice(annotations = {RestController.class, Controller.class})
意思只要類的注解上有這些注解。那么發(fā)生的異常都能被捕獲到,例如例子中出現(xiàn)的異常的類的注解為:

異常捕獲類的@ResponseBody注解
當(dāng)我們?cè)谌之惓L幚碇惺褂聾ResponseBody注解時(shí),它可以將異常信息序列化為JSON或其他格式的字符串,并作為HTTP響應(yīng)的Body部分返回給客戶端。
這就是為什么前端的兄弟能看到如此清爽的返回?cái)?shù)據(jù)格式:

不加@ResponseBody那就智能看到又臭又長(zhǎng)的這個(gè):

@ExceptionHandler(ArithmeticException.class)
具體攔截類上的@ExceptionHandler注解主要是指定去捕獲哪一種異常,這個(gè)很好理解
需要攔截捕獲哪一類異常就去指定具體的類異常,捕獲原理如上;
but··························
那么如果用戶在操作的時(shí)候,出現(xiàn)一些有違背業(yè)務(wù)邏輯的情況下,我們也視為操作異常,拋出自定義的異常,返回給前端,然后告訴用戶不能這么操作
自定義異常處理
1、首先要編寫異常自定義處理類:
CustomException
public class CustomException extends RuntimeException{
/**
* 自定義業(yè)務(wù)異常類
* @param message
*/
public CustomException(String message){
super(message);
log.info(message.toString());
}
}
這里將業(yè)務(wù)層拋出的異常信息捕獲到,然后歸類為runtime運(yùn)行時(shí)異常,
然后交給全局異常處理器去處理,給前端提供錯(cuò)誤信息
2、在全局異常類里面去捕獲自定義異常CustomException
/**
* 將業(yè)務(wù)層拋出的異常信息捕獲到,然后交給全局異常處理器去處理,給前端提供錯(cuò)誤信息
* @param exception
* @return
*/
@ExceptionHandler(CustomException.class)//RuntimeException異常類型通過注解拿到
public R<String> exceptionCategoryDelete(CustomException exception){
log.error(exception.getMessage());//在控制臺(tái)打印錯(cuò)誤信息
return R.error(exception.getMessage());
}
原理上面已經(jīng)講過了,不在贅述
那我們來測(cè)試一下,在業(yè)務(wù)層拋出一個(gè)CustomException ,看能不能被全局異常類捕獲到:
后端:


前端:


這樣我們就可以愉快的解決異常問題了
這里稍稍解釋下@ControllerAdvice注解
@ControllerAdvice注解是基于Spring框架的AOP(面向切面編程)實(shí)現(xiàn)的。AOP是一種編程范式,它通過在應(yīng)用程序運(yùn)行時(shí),將橫跨多個(gè)組件的行為進(jìn)行分離和管理。
在Spring框架中,通過AOP可以將一些通用的橫切關(guān)注點(diǎn)(比如異常處理、日志記錄等)從業(yè)務(wù)邏輯中剝離出來,并以聲明的方式進(jìn)行集中管理。@ControllerAdvice注解就是利用了AOP的機(jī)制,在應(yīng)用程序的控制器層進(jìn)行統(tǒng)一的全局異常處理和數(shù)據(jù)綁定。
底層實(shí)現(xiàn)上,@ControllerAdvice注解使用了Spring的核心功能之一:切面(Aspect)和增強(qiáng)(Advice)。通過定義一個(gè)帶有@ControllerAdvice注解的類,并在其中定義不同類型的增強(qiáng)(比如@ExceptionHandler注解用于異常處理),Spring會(huì)在運(yùn)行時(shí)動(dòng)態(tài)生成代理對(duì)象,將增強(qiáng)邏輯織入到目標(biāo)控制器的方法調(diào)用中。
總結(jié)來說,@ControllerAdvice注解的底層實(shí)現(xiàn)基于Spring框架的AOP機(jī)制,通過切面和增強(qiáng)的方式,實(shí)現(xiàn)了全局異常處理和數(shù)據(jù)綁定的功能。
到此這篇關(guān)于springboot實(shí)現(xiàn)全局異常捕獲的使用示例的文章就介紹到這了,更多相關(guān)springboot 全局異常捕獲內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家!
相關(guān)文章
SpringDataJPA實(shí)體類關(guān)系映射配置方式
這篇文章主要介紹了SpringDataJPA實(shí)體類關(guān)系映射配置方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。如有錯(cuò)誤或未考慮完全的地方,望不吝賜教2021-12-12
基于java SSM springboot實(shí)現(xiàn)抗疫物質(zhì)信息管理系統(tǒng)
這篇文章主要介紹了基于JAVA SSM springboot實(shí)現(xiàn)的抗疫物質(zhì)信息管理系統(tǒng),本文給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2021-08-08
詳解spring中使用solr的代碼實(shí)現(xiàn)
本篇文章主要介紹了詳解spring中使用solr的代碼實(shí)現(xiàn),小編覺得挺不錯(cuò)的,現(xiàn)在分享給大家,也給大家做個(gè)參考。一起跟隨小編過來看看吧2017-05-05
JAVA JSP頁(yè)面技術(shù)之EL表達(dá)式整理歸納總結(jié)
這篇文章主要介紹了java中JSP頁(yè)面技術(shù)之EL表達(dá)式概念作用以及語(yǔ)法等的使用,需要的朋友可以參考2017-04-04
Java利用HttpClient模擬POST表單操作應(yīng)用及注意事項(xiàng)
本文主要介紹JAVA中利用HttpClient模擬POST表單操作,希望對(duì)大家有所幫助。2016-04-04
java代碼獲取jenkins數(shù)據(jù),構(gòu)建歷史等信息方式
這篇文章主要介紹了java代碼獲取jenkins數(shù)據(jù),構(gòu)建歷史等信息方式,具有很好的參考價(jià)值,希望對(duì)大家有所幫助。一起跟隨小編過來看看吧2020-05-05

