SpringBoot 工程中的異常處理方式
背景分析
在項(xiàng)目的開發(fā)中,不管是對(duì)底層的數(shù)據(jù)邏輯操作過(guò)程,還是業(yè)務(wù)邏輯的處理過(guò)程,還是控制邏輯的處理過(guò)程,都不可避免會(huì)遇到各種可預(yù)知的、不可預(yù)知的異常。處理好異常對(duì)系統(tǒng)有很好的保護(hù)作用,同時(shí)會(huì)大大提高用戶的體驗(yàn)。
異常處理分析
概述
Java項(xiàng)目中處理異常方式無(wú)非兩種,要么執(zhí)行trycatch操作,要么執(zhí)行throw操作(拋給其它對(duì)象處理),無(wú)論采用哪種方式,其目的是讓我們的系統(tǒng)對(duì)異常要有反饋。但現(xiàn)在的問(wèn)題是我們?nèi)绾巫屵@種反饋代碼的編寫即簡(jiǎn)單又直觀、友好。
處理規(guī)范
我們?cè)谔幚懋惓5倪^(guò)程中通常要遵循一定的設(shè)計(jì)規(guī)范,例如:
- 捕獲異常時(shí)與拋出的異常必須完全匹配,或者捕獲異常是拋出異常的父類類型。
- 避免直接拋出RuntimeException,更不允許拋出Exception或者Throwable,應(yīng)使用有業(yè)務(wù)含義的自定義異常(例如ServiceException)。
- 捕獲異常后必須進(jìn)行處理(例如記錄日志)。如果不想處理它,需要將異常拋給它的調(diào)用者。
- 最外層的邏輯必須處理異常,將其轉(zhuǎn)化成用戶可以理解的內(nèi)容。
- 避免出現(xiàn)重復(fù)的代碼(Don't Repeat Yourself),即DAY原則。
SpringBoot 工程下的異常處理
準(zhǔn)備工作
第一步:創(chuàng)建項(xiàng)目或module,并添加web依賴,代碼如下:
<dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency>
第二步:修改項(xiàng)目訪問(wèn)端口為80,例如
server.port=80
第三步:定義Controller類,代碼如下:
package com.cy.pj.arithmetic.controller; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.PathVariable; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.ResponseBody; @Controller public class ArithmeticController { @RequestMapping("doCompute/{n1}/{n2}") @ResponseBody public String doCompute(@PathVariable Integer n1, @PathVariable Integer n2){ Integer result=n1/n2; return "Result is "+result; } }
第四步啟動(dòng)項(xiàng)目進(jìn)行訪問(wèn)測(cè)試
在瀏覽器地址欄輸入http://localhost/doCompute/10/2,檢測(cè)輸出結(jié)果。
Result is 5
默認(rèn)異常處理
在瀏覽器地址欄輸入http://localhost/doCompute/10/0,檢測(cè)輸出結(jié)果。
對(duì)于這樣的默認(rèn)異常處理(spring boot提供),用戶體驗(yàn)不太友好,為了呈現(xiàn)更加友好的異常信息,我們通常要對(duì)異常進(jìn)行自定義處理。
自己try異常處理
在控制層方法中,我們可以進(jìn)行try catch處理,例如:
@RequestMapping("doCompute/{n1}/{n2}") @ResponseBody public String doCompute(@PathVariable Integer n1, @PathVariable Integer n2){ try{ Integer result=n1/n2; return "Result is "+result; }catch(ArithmeticException e){ return "exception is "+e.getMessage(); } }
一個(gè)Controller類中通常會(huì)有多個(gè)方法,這樣多個(gè)方法中都寫try語(yǔ)句進(jìn)行異常處理會(huì)帶來(lái)大量重復(fù)代碼的編寫,不易維護(hù)。
Controller內(nèi)部定義異常處理方法
在Controller類中添加異常處理方法,代碼如下:
@ExceptionHandler(ArithmeticException.class) @ResponseBody public String doHandleArithmeticException(ArithmeticException e){ e.printStackTrace(); return "計(jì)算過(guò)程中出現(xiàn)了異常,異常信息為"+e.getMessage(); }
@ExceptionHandler注解描述的方法為異常處理方法(注解中的異常類型為可處理的異常類型),假如Controller類中的邏輯方法中出現(xiàn)異常后沒有處理異常,則會(huì)查找Controller類中有沒有定義異常處理方法,假如定義了,且可以處理拋出的異常類型,則由異常處理方法處理異常。
控制層中的全局異常處理類及方法定義
當(dāng)項(xiàng)目由多個(gè)控制層類中有多個(gè)共性異常的處理方法定義時(shí),我們可以將這些方法提取到公共的父類對(duì)象中,但是這種方式是一種強(qiáng)耦合的實(shí)現(xiàn),不利于代碼的維護(hù)。我們還可以借助spring框架中web模塊定義的全局異常處理規(guī)范進(jìn)行實(shí)現(xiàn),例如定義全局異常處理類,代碼如下:
package com.cy.pj.common.web; @RestControllerAdvice public class GlobalExceptionHandler { @ExceptionHandler(ArithmeticException.class) public String doHandleArithmeticException(ArithmeticException e){ e.printStackTrace(); return "計(jì)算過(guò)程中出現(xiàn)了異常,異常信息為"+e.getMessage(); } }
其中,@RestControllerAdvice 注解描述的類為全局異常處理類,當(dāng)控制層方法中的異常沒有自己捕獲,也沒有定義其內(nèi)部的異常處理方法,底層默認(rèn)會(huì)查找全局異常處理類,調(diào)用對(duì)應(yīng)的異常處理方法進(jìn)行異常處理。如圖所示:
總結(jié)(Summary)
本小節(jié)主要是對(duì)springboot中的異常處理機(jī)制進(jìn)行了簡(jiǎn)單分析和講解。目的是掌握springboot工程下的異常處理方式,并基于業(yè)務(wù)的不同進(jìn)行響應(yīng)的異常處理。從而有效提高其用戶體驗(yàn),加強(qiáng)系統(tǒng)的容錯(cuò)能力。
以上就是SpringBoot 工程中的異常處理方式的詳細(xì)內(nèi)容,更多關(guān)于SpringBoot 異常處理的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章!
相關(guān)文章
Java與Oracle實(shí)現(xiàn)事務(wù)(JDBC事務(wù))實(shí)例詳解
這篇文章主要介紹了Java與Oracle實(shí)現(xiàn)事務(wù)(JDBC事務(wù))實(shí)例詳解的相關(guān)資料,需要的朋友可以參考下2017-05-05Java反射獲取所有Controller和RestController類的方法
這篇文章給大家分享了Java反射獲取所有Controller和RestController類的方法,文中有詳細(xì)的代碼示例講解,具有一定的參考價(jià)值,需要的朋友可以參考下2023-08-08Springboot四種事件監(jiān)聽的實(shí)現(xiàn)方式詳解
這篇文章主要介紹了Springboot四種事件監(jiān)聽的實(shí)現(xiàn)方式,事件監(jiān)聽是一種機(jī)制,可以定義和觸發(fā)自定義的事件,以及在應(yīng)用程序中注冊(cè)監(jiān)聽器來(lái)響應(yīng)這些事件,需要的朋友可以參考下2022-06-06SpringBoot線程池ThreadPoolTaskExecutor異步處理百萬(wàn)級(jí)數(shù)據(jù)
本文主要介紹了SpringBoot線程池ThreadPoolTaskExecutor異步處理百萬(wàn)級(jí)數(shù)據(jù),文中通過(guò)示例代碼介紹的非常詳細(xì),對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值,需要的朋友們下面隨著小編來(lái)一起學(xué)習(xí)學(xué)習(xí)吧2024-03-03Springboot集成Actuator監(jiān)控功能詳解
這篇文章主要介紹了Springboot集成Actuator監(jiān)控功能詳解,有時(shí)候我們想要實(shí)時(shí)監(jiān)控我們的應(yīng)用程序的運(yùn)行狀態(tài),比如實(shí)時(shí)顯示一些指標(biāo)數(shù)據(jù),觀察每時(shí)每刻訪問(wèn)的流量,或者是我們數(shù)據(jù)庫(kù)的訪問(wèn)狀態(tài)等等,這時(shí)候就需要Actuator了,需要的朋友可以參考下2023-09-09