摘要:首先,定義一個(gè)存放異常處理函數(shù)的類,并使用修飾。修飾的方法的寫(xiě)法和內(nèi)的異常處理函數(shù)寫(xiě)法是一樣的。控制生效的范圍注意到,我是這樣編寫(xiě)注解的它用來(lái)限定這些異常處理函數(shù)起作用的的范圍。使用的機(jī)制,做統(tǒng)一異常處理。
在具體的SSM項(xiàng)目開(kāi)發(fā)中,由于Controller層為處于請(qǐng)求處理的最頂層,再往上就是框架代碼的。
因此,肯定需要在Controller捕獲所有異常,并且做適當(dāng)處理,返回給前端一個(gè)友好的錯(cuò)誤碼。
不過(guò),Controller一多,我們發(fā)現(xiàn)每個(gè)Controller里都有大量重復(fù)的、冗余的異常處理代碼,很是啰嗦。
能否將這些重復(fù)的部分抽取出來(lái),這樣保證Controller層更專注于業(yè)務(wù)邏輯的處理,
同時(shí)能夠使得異常的處理有一個(gè)統(tǒng)一的控制中心點(diǎn)。
public interface HandlerExceptionResolver { /** * Try to resolve the given exception that got thrown during on handler execution, * returning a ModelAndView that represents a specific error page if appropriate. *The returned ModelAndView may be {@linkplain ModelAndView#isEmpty() empty} * to indicate that the exception has been resolved successfully but that no view * should be rendered, for instance by setting a status code. * @param request current HTTP request * @param response current HTTP response * @param handler the executed handler, or {@code null} if none chosen at the * time of the exception (for example, if multipart resolution failed) * @param ex the exception that got thrown during handler execution * @return a corresponding ModelAndView to forward to, * or {@code null} for default processing */ ModelAndView resolveException( HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex); }
使用全局異常處理器只需要兩步:
實(shí)現(xiàn)HandlerExceptionResolver接口。
將實(shí)現(xiàn)類作為Spring Bean,這樣Spring就能掃描到它并作為全局異常處理器加載。
在resolveException中實(shí)現(xiàn)異常處理邏輯。
從參數(shù)上,可以看到,不僅能夠拿到發(fā)生異常的函數(shù)和異常對(duì)象,還能夠拿到HttpServletResponse對(duì)象,從而控制本次請(qǐng)求返回給前端的行為。
此外,函數(shù)還可以返回一個(gè)ModelAndView對(duì)象,表示渲染一個(gè)視圖,比方說(shuō)錯(cuò)誤頁(yè)面。
不過(guò),在前后端分離為主流架構(gòu)的今天,這個(gè)很少用了。如果函數(shù)返回的視圖為空,則表示不需要視圖。
來(lái)看一個(gè)例子:
@Component @Slf4j public class CustomHandlerExceptionResolver implements HandlerExceptionResolver { @Override public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) { Method method = null; if (handler != null && handler instanceof HandlerMethod) { method = ((HandlerMethod) handler).getMethod(); } log.error("[{}] system error", method, ex); ResponseDTO response = ResponseDTO.builder() .errorCode(ErrorCode.SYSTEM_ERROR) .build(); byte[] bytes = JSON.toJSONString(response).getBytes(StandardCharsets.UTF_8)); try { FileCopyUtils.copy(bytes, response.getOutputStream()); } catch (IOException e) { log.error("error", e); throw new RuntimeException(e); } return new ModelAndView(); } }
邏輯很顯然,在發(fā)生異常時(shí),將ResponseDTO序列化為json給前端。
Controller局部異常處理 使用示例這種異常處理只局部于某個(gè)Controller內(nèi),如:
@Controller @Slf4j @RequestMapping("/api/demo") public class DemoController { @ExceptionHandler(Exception.class) @ResponseBody public ResponseDTO> exceptionHandler(Exception e) { log.error("[{}] system error", e); return ResponseDTO.builder() .errorCode(ErrorCode.SYSTEM_ERROR) .build(); } }
所有Controller方法(即被RequestMapping注解的方法)拋出的異常,會(huì)被該異常處理方法處理。
使用上,在Controller內(nèi)部,用@ExceptionHandler注解的方法,就會(huì)作為該Controller內(nèi)部的異常處理方法。
并且,它的參數(shù)中可以注入如WebRequest、NativeWebRequest等,用來(lái)拿到請(qǐng)求相關(guān)的數(shù)據(jù)。
它可以返回String代表一個(gè)view名稱,也可以返回一個(gè)對(duì)象并且用@ResponseBody修飾,由框架的其它機(jī)制幫你序列化。
此外,它還能夠?qū)Ξ惓n愋瓦M(jìn)行細(xì)粒度的控制,通過(guò)注解可以有選擇的指定異常處理方法應(yīng)用的異常類型:
@ExceptionHandler({BusinessException.class, DataBaseError.class })
雖然說(shuō)全局異常處理HandlerExceptionResolver通過(guò)條件判斷也能做到,
但是使用這種注解方式明顯更具有可讀性。
剛才說(shuō)到異常處理函數(shù)可以用@ResponseBody修飾,就像一般的Controller方法一樣。
然而,非常遺憾的是,如果使用自定義的HandlerMethodReturnValueHandler,卻不生效。
比如:
@ExceptionHandler(Exception.class) @JsonResponse public ResponseDTO> exceptionHandler(Exception e) { log.error("[{}] system error", e); return ResponseDTO.builder() .errorCode(ErrorCode.SYSTEM_ERROR) .build(); }
不知道是我的使用姿勢(shì)不對(duì),還是什么情況?各種google后無(wú)果。
所以,目前的解決方案是,如果能夠控制@JsonResponse注解相關(guān)的定義代碼,將處理返回值這部分邏輯抽取出來(lái),然后在異常處理函數(shù)中手動(dòng)調(diào)用。
ControllerAdvice 使用示例剛才介紹的是Controller局部的異常處理,用于處理該Controller內(nèi)部的特有的異常處理十分有用。
首先,定義一個(gè)存放異常處理函數(shù)的類,并使用@ControllerAdvice修飾。
@ControllerAdvice(assignableTypes = {GlobalExceptionHandlerMixin.class}) public class ExceptionAdvice { @ExceptionHandler(ErrorCodeWrapperException.class) @ResponseBody public ResponseDTO> exceptionHandler(ErrorCodeWrapperException e) { if ((errCodeException.getErrorCode().equals(ErrorCode.SYSTEM_ERROR))) { log.error(e); } return ResponseDTO.ofErroCodeWrapperException(errCodeException); } }
@ExceptionHanlder修飾的方法的寫(xiě)法和Controller內(nèi)的異常處理函數(shù)寫(xiě)法是一樣的。
控制生效的Controller范圍注意到,我是這樣編寫(xiě)注解的:
@ControllerAdvice(assignableTypes = {GlobalExceptionHandlerMixin.class})
它用來(lái)限定這些異常處理函數(shù)起作用的Controller的范圍。如果不寫(xiě),則默認(rèn)對(duì)所有Controller有效。
這也是ControllerAdvice進(jìn)行統(tǒng)一異常處理的優(yōu)點(diǎn),它能夠細(xì)粒度的控制該異常處理器針對(duì)哪些Controller有效,這樣的好處是:
一個(gè)系統(tǒng)里就能夠存在不同的異常處理器,Controller也可以有選擇的決定使用哪個(gè),更加靈活。
不同的業(yè)務(wù)模塊可能對(duì)異常處理的方式不同,通過(guò)該機(jī)制就能做到。
設(shè)想一個(gè)一開(kāi)始并未使用全局異常處理的系統(tǒng),如果直接引入全局范圍內(nèi)生效的全局異常處理,勢(shì)必可能會(huì)改變已有Controller的行為,有侵入性。
也就是說(shuō),如果不控制生效范圍,即默認(rèn)對(duì)所有Controller生效。如果控制生效范圍,則默認(rèn)對(duì)所有Controller不生效,降低侵入性。
如剛才示例中的例子,只針對(duì)實(shí)現(xiàn)了GlobalExceptionHandlerMixin接口的類有效:
@Controller @Slf4j @RequestMapping("/api/demo") public class DemoController implements GlobalExceptionHandlerMixin { }
ControllerAdvice支持的限定范圍:
按注解:@ControllerAdvice(annotations = RestController.class)
按包名:@ControllerAdvice("org.example.controllers")
按類型:@ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class})
總結(jié)以上幾種方式是Spring專門(mén)為異常處理設(shè)計(jì)的機(jī)制。
就我個(gè)人而言,由于ControllerAdvice具有更細(xì)粒度的控制能力,所以我更偏愛(ài)于在系統(tǒng)中使用ControllerAdvice進(jìn)行統(tǒng)一異常處理。
除了用異常來(lái)傳遞系統(tǒng)中的意外錯(cuò)誤,也會(huì)用它來(lái)傳遞處于接口行為一部分的業(yè)務(wù)錯(cuò)誤。
這也是異常的優(yōu)點(diǎn)之一,如果接口的實(shí)現(xiàn)比較復(fù)雜,分多層函數(shù)實(shí)現(xiàn),如果直接傳遞錯(cuò)誤碼,那么到Controller的路徑上的每一層函數(shù)都需要檢查錯(cuò)誤碼,退回到了C語(yǔ)言那種可怕的“寫(xiě)一行語(yǔ)句檢查一下錯(cuò)誤碼”的模式。
當(dāng)然,理論上,任何能夠給Controller加切面的機(jī)制都能變相的進(jìn)行統(tǒng)一異常處理。比如:
在攔截器內(nèi)捕獲Controller的異常,做統(tǒng)一異常處理。
使用Spring的AOP機(jī)制,做統(tǒng)一異常處理。
文章版權(quán)歸作者所有,未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址:http://systransis.cn/yun/76948.html
摘要: SpringBoot異常處理。 原文:Spring MVC/Boot 統(tǒng)一異常處理最佳實(shí)踐 作者:趙俊 前言 在 Web 開(kāi)發(fā)中, 我們經(jīng)常會(huì)需要處理各種異常, 這是一件棘手的事情, 對(duì)于很多人來(lái)說(shuō), 可能對(duì)異常處理有以下幾個(gè)問(wèn)題: 什么時(shí)候需要捕獲(try-catch)異常, 什么時(shí)候需要拋出(throws)異常到上層. 在 dao 層捕獲還是在 service 捕獲, 還是在...
摘要:對(duì)的配置和行為進(jìn)行定制修改匹配路由請(qǐng)求規(guī)則注冊(cè)自定義的和添加靜態(tài)資源處理器添加自定義視圖控制器添加自定義方法參數(shù)處理器配置消息轉(zhuǎn)換器清空所有轉(zhuǎn)換器做一個(gè)好人。博客園掘金簡(jiǎn)書(shū)頭條知乎 一個(gè)大的系統(tǒng),在代碼的復(fù)用肯定是必不可少的,它能解決: 統(tǒng)一的響應(yīng)處理(可以對(duì)外提供統(tǒng)一的響應(yīng)對(duì)象包裝) showImg(https://segmentfault.com/img/remote/146000...
摘要:前言最近在優(yōu)化自己之前基于的統(tǒng)一響應(yīng)體的實(shí)現(xiàn)方案。但是的狀態(tài)碼數(shù)量有限,而隨著業(yè)務(wù)的增長(zhǎng),狀態(tài)碼無(wú)法很好地表示業(yè)務(wù)中遇到的異常情況。 前言 最近在優(yōu)化自己之前基于Spring AOP的統(tǒng)一響應(yīng)體的實(shí)現(xiàn)方案。 什么是統(tǒng)一響應(yīng)體呢?在目前的前后端分離架構(gòu)下,后端主要是一個(gè)RESTful API的數(shù)據(jù)接口。 但是HTTP的狀態(tài)碼數(shù)量有限,而隨著業(yè)務(wù)的增長(zhǎng),HTTP狀態(tài)碼無(wú)法很好地表示業(yè)務(wù)中遇...
摘要:挺多人咨詢的,異常處理用切面注解去實(shí)現(xiàn)去全局異常處理。全局異常處理類,代碼如下代碼解析如下抽象類是用來(lái)處理全局錯(cuò)誤時(shí)進(jìn)行擴(kuò)展和實(shí)現(xiàn)注解標(biāo)記的切面排序,值越小擁有越高的優(yōu)先級(jí),這里設(shè)置優(yōu)先級(jí)偏高。 本文內(nèi)容 為什么要全局異常處理? WebFlux REST 全局異常處理實(shí)戰(zhàn) 小結(jié) 摘錄:只有不斷培養(yǎng)好習(xí)慣,同時(shí)不斷打破壞習(xí)慣,我們的行為舉止才能夠自始至終都是正確的。 一、為什么要全局...
摘要:下面我們來(lái)測(cè)試一下,訪問(wèn)我們經(jīng)過(guò)修改后的編寫(xiě)的接口這里我將返回值統(tǒng)一為,以便數(shù)據(jù)存入,實(shí)際類型應(yīng)是接口的返回類型。如果沒(méi)有返回值的話,那就可以一個(gè)對(duì)象直接通過(guò)構(gòu)造方法賦值即可。 為什么要統(tǒng)一返回值 在我們做后端應(yīng)用的時(shí)候,前后端分離的情況下,我們經(jīng)常會(huì)定義一個(gè)數(shù)據(jù)格式,通常會(huì)包含code,message,data這三個(gè)必不可少的信息來(lái)方便我們的交流,下面我們直接來(lái)看代碼 ReturnV...
閱讀 3315·2021-11-23 09:51
閱讀 2943·2021-10-28 09:33
閱讀 902·2021-10-08 10:04
閱讀 3706·2021-09-22 15:13
閱讀 1031·2019-08-30 15:55
閱讀 2919·2019-08-30 15:44
閱讀 581·2019-08-30 13:04
閱讀 2949·2019-08-30 12:56