使用aop實(shí)現(xiàn)全局異常處理
本文實(shí)例為大家分享了使用aop實(shí)現(xiàn)全局異常處理的具體代碼,供大家參考,具體內(nèi)容如下
日常業(yè)務(wù)中存在的問(wèn)題
- 使用大量的try/catch來(lái)捕獲異常
- 導(dǎo)致整個(gè)控制層代碼可讀性極差,并且此類(lèi)工作重復(fù)枯燥、容易復(fù)制錯(cuò)。
- 一份糟糕的控制器代碼如下:@RequestMapping("test/run/old")
public JsonResponse testRunOld() { ? ? try { ? ? ? ? exampleService.runTest(); ? ? ? ? System.out.println("正常運(yùn)行"); ? ? ? ? return JsonResponse.newOk(); ? ? }catch (DataNotCompleteException e) { ? ? ? ? logger.error("something error occured!"); ? ? ? ? return JsonResponse.newError(ErrorMsgEnum.DATA_NO_COMPLETE); ? ? } catch (Exception e) { ? ? ? ? return JsonResponse.newError(); ? ? } ? }
我們要把代碼變成這樣:
@Controller public class TestController { ? ? ? @Autowired ? ? private IExampleService exampleService; ? ? ? @RequestMapping("test/run/aop") ? ? public JsonResponse testRunAop() throws Exception { ? ? ? ? exampleService.runTest(); ? ? ? ? System.out.println("正常運(yùn)行"); ? ? ? ? return JsonResponse.newOk(); ? ? } }
@Service public class ExampleService implements IExampleService{ ? ? ? @Override ? ? public void runTest() throws Exception { ? ? ? ? ? // do something ? ? ? ? System.out.println("run something"); ? ? ? ? throw new CustomException(ErrorMsgEnum.DATA_NO_COMPLETE); ? ? } ? }
- 這樣做以后,代碼里少了很多try和catch,這些到處復(fù)制的代碼本來(lái)就應(yīng)該統(tǒng)一起來(lái),只是在aop以前沒(méi)有什么更好的處理方式,只能復(fù)制。
- 其次,service拋出異常后,不用再去controller里加一段catch,這種操作每次都要浪費(fèi)5-15秒(如果你不熟悉IDE中的快捷鍵,這就是噩夢(mèng))
- 現(xiàn)在你的異常只要往上拋出去就不管了(throws Exception),可以專(zhuān)心寫(xiě)業(yè)務(wù)代碼
如何完成?其實(shí)原理相當(dāng)簡(jiǎn)單。
把那些煩人的try丟到AOP中處理
- 我們將采用Spring AOP統(tǒng)一處理異常,統(tǒng)一返回后端接口的結(jié)果。
- 使用一個(gè)自定義異常和一個(gè)錯(cuò)誤前端提示枚舉來(lái)逐層傳遞消息
- 一個(gè)錯(cuò)誤枚舉來(lái)代替新建異常信息類(lèi),減少業(yè)務(wù)異常信息文件的數(shù)量
幾個(gè)核心類(lèi)代碼
//正常返回的枚舉 SUCCESS(true, 2000,"正常返回", "操作成功"),? ? ? ? // 系統(tǒng)錯(cuò)誤,50開(kāi)頭 ? ? SYS_ERROR(false, 5000, "系統(tǒng)錯(cuò)誤", "親,系統(tǒng)出錯(cuò)了哦~"), ? ? PARAM_INVILAD(false, 5001, "參數(shù)出現(xiàn)異常", "參數(shù)出現(xiàn)異常"),? ? ? DATA_NO_COMPLETE(false, 5002, "數(shù)據(jù)填寫(xiě)不完整,請(qǐng)檢查", "數(shù)據(jù)填寫(xiě)不完整,請(qǐng)檢查"); ? ? ? private ErrorMsgEnum(boolean ok, int code, String msg ,String userMsg) { ? ? ? ? this.ok = ok; ? ? ? ? this.code = code; ? ? ? ? this.msg = msg; ? ? ? ? this.userMsg = userMsg; ? ? } ? ? ? private boolean ok; ? ? private int code; ? ? private String msg; ? ? private String userMsg; }
控制層返回結(jié)果POJO類(lèi)
public class JsonResponse{ ? ? ? String msg; ? ? Object data; ? ? ? public JsonResponse() { ? ? ? ? msg = ""; ? ? ? ? data = null; ? ? } ? ? ? public static JsonResponse newOk() { ? ? ? ? JsonResponse response = new JsonResponse(); ? ? ? ? response.setState(State.newOk()); ? ? ? ? return response; ? ? } ? ? ? public static JsonResponse newOk(Object data) { ? ? ? ? JsonResponse response = new JsonResponse(); ? ? ? ? response.setData(data); ? ? ? ? response.setState(State.newOk()); ? ? ? ? return response; ? ? } ? ? ? public static JsonResponse newError() { ? ? ? ? JsonResponse response = new JsonResponse(); ? ? ? ? response.setMsg("無(wú)情的系統(tǒng)異常!"); ? ? ? ? return response; ? ? } ? ? ? public static JsonResponse newError(ErrorMsgEnum errorMsgEnum) { ? ? ? ? JsonResponse response = new JsonResponse(); ? ? ? ? state.setMsg(errorMsgEnum.getErrorMsg()); ? ? ? ? return response; ? ? } }
自定義異常類(lèi)
public class CustomException extends Exception {? ? ? private ErrorMsgEnum errorMsgEnum; ? ? ? public CustomException(ErrorMsgEnum errorMsgEnum) { ? ? ? ? this.errorMsgEnum = errorMsgEnum; ? ? } }
AOP捕獲異常處理類(lèi)
@Around("execution(public * com.jason.*.controller..*.*(..))") public JsonResponse serviceAOP(ProceedingJoinPoint pjp) throws Exception { ? ? ? JsonResponse newResultVo = null; ? ? ? try { ? ? ? ? return (JsonResponse) pjp.proceed(); ? ? } catch (CustomException e) { ? ? ? ? logger.info("自定義業(yè)務(wù)異常:" + e.getMessage()); ? ? ? ? ErrorMsgEnum errorMsgEnum = e.getErrorMsgEnum(); ? ? ? ? if (Objects.nonNull(errorMsgEnum)) { ? ? ? ? ? ? newResultVo = JsonResponse.newError(errorMsgEnum); ? ? ? ? } else { ? ? ? ? ? ? newResultVo = JsonResponse.newError(e.getMessage()); ? ? ? ? ? ? } ? ? } catch (Exception e) { ? ? ? ? //可以順便處理你的日志,此處能取到方法名,參數(shù)等等 ? ? ? ? logger.error("出現(xiàn)運(yùn)行時(shí)異常:", e); ? ? ? ? newResultVo = JsonResponse.newError(); ? ? } ? ? ? return newResultVo; ? }
Test && End
至此,我們已經(jīng)可以直接在 Service 或 Controller 中隨意拋出一個(gè)異常,
直接每個(gè)控制器方法拋出的異常定義為 throws Exception 即可
經(jīng)過(guò)這次處理:
- 最大的好處是:沒(méi)有try
- 異常處理和返回結(jié)果得到統(tǒng)一,不怕你的隊(duì)友復(fù)制錯(cuò)了。
以上就是本文的全部?jī)?nèi)容,希望對(duì)大家的學(xué)習(xí)有所幫助,也希望大家多多支持腳本之家。
相關(guān)文章
Java對(duì)數(shù)組實(shí)現(xiàn)選擇排序算法的實(shí)例詳解
這篇文章主要介紹了Java對(duì)數(shù)組實(shí)現(xiàn)選擇排序算法的實(shí)例,選擇排序的比較次數(shù)為 O(N^2)而交換數(shù)為O(N),需要的朋友可以參考下2016-04-04java swing實(shí)現(xiàn)貪吃蛇雙人游戲
這篇文章主要為大家詳細(xì)介紹了java swing實(shí)現(xiàn)貪吃蛇雙人小游戲,文中示例代碼介紹的非常詳細(xì),具有一定的參考價(jià)值,感興趣的小伙伴們可以參考一下2021-01-01詳解Spring中Bean后置處理器(BeanPostProcessor)的使用
BeanPostProcessor 接口也被稱(chēng)為Bean后置處理器,通過(guò)該接口可以自定義調(diào)用初始化前后執(zhí)行的操作方法。本文將詳細(xì)講講它的使用,需要的可以參考一下2022-06-06SpringBoot使用Scheduling實(shí)現(xiàn)定時(shí)任務(wù)的示例代碼
Spring Boot提供了一種方便的方式來(lái)實(shí)現(xiàn)定時(shí)任務(wù),即使用Spring的@Scheduled注解,通過(guò)在方法上添加@Scheduled注解,我們可以指定方法在何時(shí)執(zhí)行,本文我們就給大家介紹一下SpringBoot如何使用Scheduling實(shí)現(xiàn)定時(shí)任務(wù),需要的朋友可以參考下2023-08-08Java Map集合與Collection類(lèi)的使用詳解
這篇文章主要介紹了Java Map集合的使用及Collection工具類(lèi)使用,文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)吧2022-11-11Java中對(duì)List去重 Stream去重的解決方法
這篇文章主要介紹了Java中對(duì)List去重, Stream去重的問(wèn)題解答,文中給大家介紹了Java中List集合去除重復(fù)數(shù)據(jù)的方法,需要的朋友可以參考下2018-04-04Spring?Security配置多個(gè)數(shù)據(jù)源并添加登錄驗(yàn)證碼的實(shí)例代碼
這篇文章主要介紹了Spring?Security配置多個(gè)數(shù)據(jù)源并添加登錄驗(yàn)證碼,本文通過(guò)實(shí)例代碼給大家介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值,需要的朋友可以參考下2022-08-08