SpringBoot怎么配置全局異常處理器捕獲異常

本篇內(nèi)容主要講解“SpringBoot怎么配置全局異常處理器捕獲異?！?，感興趣的朋友不妨來看看。本文介紹的方法操作簡單快捷，實用性強。下面就讓小編來帶大家學習“SpringBoot怎么配置全局異常處理器捕獲異?！卑?

1.前言

任何系統(tǒng)，我們不會傻傻的在每一個地方進行異常捕獲和處理，整個系統(tǒng)一般我們會在一個的地方統(tǒng)一進行異常處理，spring boot全局異常處理很簡單；

前后端分離，后端API，一般對于異常處理，要做得無非兩件事，

1.是記錄日志及相應通知處理，這是對內(nèi)的

2.是給出返回結(jié)果給API調(diào)用者，這是對外的

對API調(diào)用者來說，他只需要一個返回結(jié)果（包含錯誤代碼、提示信息），其他的他不關(guān)心

對后端來說，他只需要記錄日志，通知或者給發(fā)布相應消息給其他隊列處理相關(guān)事項；

所以：看到過不少人封裝了很多個自定義異常類，其實，完全沒有必要，只需要一個異常處理來處理所有異常即可，然后封裝一個錯誤識別碼和提示消息的枚舉，用于返回給API調(diào)用者；然后后端的處理，直接在一個異常處理方法中全部處理就行了，完全沒必要封裝N多個自定義異常，那沒有任何意義；

關(guān)于異常的思想認識

我們應該認識到，一切異常，對系統(tǒng)來說，都是不正常的表現(xiàn)，都是屬于缺陷，都屬于BUG，盡管有些異常是我們主動拋出的；

我們要做的，是應該盡量提高系統(tǒng)可用性，最大限度避免任何異常的出現(xiàn)，而不是去指望完善異常處理來完善系統(tǒng)；

異常處理，是異常無法避免的出現(xiàn)了而采取的一種應急措施，主要目的是對外增加友好性，對內(nèi)提供補救線索；

不要認為完善的異常處理是系統(tǒng)核心，他不是，不要指望異常處理盡善盡美，不要指望異常處理來給系統(tǒng)缺陷擦屁股；

如果系統(tǒng)異常過多，那么你要做的不是去完善異常處理機制，而是要好好去反思：系統(tǒng)架構(gòu)設(shè)計是否合理，系統(tǒng)邏輯設(shè)計是否合理；

2.全局異常并處理的方法一（@ControllerAdvice 和 @ExceptionHandler）

=================================================

在開發(fā)中，我們會有如下的場景：某個接口中，存在一些業(yè)務異常。例如用戶輸入的參數(shù)校驗失敗、用戶名密碼不存在等。當觸發(fā)這些業(yè)務異常時，我們需要拋出這些自定義的業(yè)務異常，并對其進行處理。一般我們要把這些異常信息的狀態(tài)碼和異常描述，友好地返回給調(diào)用者，調(diào)用者則利用狀態(tài)碼等信息判斷異常的具體情況。

過去，我們可能需要在 controller 層通過 try/catch 處理。首先 catch 自定義異常，然后 catch 其它異常。對于不同的異常，我們需要在 catch 的同時封裝將要返回的對象。然而，這么做的弊端就是代碼會變得冗長。每個接口都需要做 try/catch 處理，而且一旦需要調(diào)整，所有的接口都需要修改一遍，非常不利于代碼的維護，如下段代碼所示

@RequestMapping (value = "/test")
public ResponseEntity test() {
    ResponseEntity re = new ResponseEntity();
    // 業(yè)務處理
    // ...
    try {
        // 業(yè)務
    } catch (BusinessException e) {
        logger.info("業(yè)務發(fā)生異常，code:" + e.getCode() + "msg:" + e.getMsg());
        re.setCode(e.getCode());
        re.setMsg(e.getMsg());
        return re;
    } catch (Exception e) {
        logger.error("服務錯誤:", e);
        re.setCode("xxxxx");
        re.setMsg("服務錯誤");
        return re;
    }
    return re;
}

那么，有沒有什么方法可以簡便地處理這些異常信息呢？答案是肯定的。Spring 3.2 中，新增了 @ControllerAdvice 注解，可以用于定義 @ExceptionHandler 、 @InitBinder 、@ModelAttribute ，并應用到所有 @RequestMapping 中。簡單來說就是，可以通過@ControllerAdvice 注解配置一個全局異常處理類，來統(tǒng)一處理 controller 層中的異常，于此同時 controller 中可以不用再寫 try/catch，這使得代碼既整潔又便于維護。

使用方法

定義自定義異常

有關(guān)自定義異常相關(guān)知識點這里就不詳細說明了，如果不了解的話自行搜索一下。這里貼上一個簡單的自定義業(yè)務異常類。

/**
 * 自定義業(yè)務異常類
 *
 * @author Yuzhe Ma
 * @date 2018/11/28
 */
@Data
public class BusinessException extends RuntimeException {
    private String code;
    private String msg;
 
    public BusinessException(String code, String msg) {
        this.code = code;
        this.msg = msg;
    }
}

注： @Data 為 Lombok 插件。自動生成 set/get 方法。具體使用方法這里就不展開介紹了。

@ControllerAdvice + @ExceptionHand` 配置全局異常處理類

/**
 * 全局異常處理器
 *
 * @author Yuzhe Ma
 * @date 2018/11/12
 */
@ControllerAdvice
public class GlobalExceptionHandler {
    private static final Logger logger = LoggerFactory.getLogger(GlobalExceptionHandler.class);
 
    /**
     * 處理 Exception 異常
     *
     * @param httpServletRequest httpServletRequest
     * @param e                  異常
     * @return
     */
    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public ResponseEntity exceptionHandler(HttpServletRequest httpServletRequest, Exception e) {
        logger.error("服務錯誤:", e);
        return new ResponseEntity("xxx", "服務出錯");
    }
 
    /**
     * 處理 BusinessException 異常
     *
     * @param httpServletRequest httpServletRequest
     * @param e                  異常
     * @return
     */
    @ResponseBody
    @ExceptionHandler(value = BusinessException.class)
    public ResponseEntity businessExceptionHandler(HttpServletRequest httpServletRequest, BusinessException e) {
        logger.info("業(yè)務異常。code:" + e.getCode() + "msg:" + e.getMsg());
        return new ResponseEntity(e.getCode(), e.getMsg());
    }
}

@ControllerAdvice

定義該類為全局異常處理類。

@ExceptionHandler

定義該方法為異常處理方法。value 的值為需要處理的異常類的 class 文件。在例子中，方法傳入兩個參數(shù)。一個是對應的 Exception 異常類，一個是 HttpServletRequest 類。當然，除了這兩種參數(shù)，還支持傳入一些其他參數(shù)。

這樣，就可以對不同的異常進行統(tǒng)一處理了。通常，為了使 controller 中不再使用任何 try/catch，也可以在 GlobalExceptionHandler 中對 Exception 做統(tǒng)一處理。這樣其他沒有用 @ExceptionHandler 配置的異常就都會統(tǒng)一被處理。

遇到異常時拋出異常即可

在業(yè)務中，遇到業(yè)務異常的地方，直接使用 throw 拋出對應的業(yè)務異常即可。例如

throw new BusinessException("3000", "賬戶密碼錯誤");

在 Controller 中的寫法

Controller 中，不需要再寫 try/catch，除非特殊用途。

@RequestMapping(value = "/test")
public ResponseEntity test() {
    ResponseEntity re = new ResponseEntity();
    // 業(yè)務處理
    // ...
    return re;
}

結(jié)果展示

異常拋出后，返回如下結(jié)果。

{
    "code": "3000",
    "msg": "賬戶密碼錯誤",
    "data": null
}

注意 不一定必須在 controller 層本身拋出異常才能被 GlobalExceptionHandler 處理，只要異常最后是從 contoller 層拋出去的就可以被全局異常處理器處理。異步方法中的異常不會被全局異常處理。拋出的異常如果被代碼內(nèi)的 try/catch 捕獲了，就不會被 GlobalExceptionHandler 處理了。總結(jié)

本文介紹了在 SpringBoot 中，通過配置全局異常處理器統(tǒng)一處理 Controller 層引發(fā)的異常。

優(yōu)點

減少代碼冗余，代碼便于維護

缺點

只能處理 controller 層拋出的異常，對例如 Interceptor（攔截器）層的異常、定時任務中的異常、異步方法中的異常，不會進行處理。

以上就是用 @ControllerAdvice + @ExceptionHand 實現(xiàn) SpringBoot 中捕獲 controller 層全局異常并處理的方法。

3.全局異常并處理的方法二 (AOP)

雖然@ControllerAdvice注解通常和@ExceptionHandler注解用于全局異常的處理。

但是這種方式有個缺點就是，只是對控制層進行了異常攔截，比如像工具類中或者其他類中的異常，并不會攔截。

由于業(yè)務執(zhí)行時不能保證程序不出錯,所以寫代碼必須添加try-catch,但是如果頻繁的添加try-catch則必然導致代碼結(jié)構(gòu)混亂.所以需要進行優(yōu)化.

原則:如果出現(xiàn)了問題一般將檢查異常,轉(zhuǎn)化為運行時異常.

核心原理: 代理動態(tài)思想------->AOP操作

采用自定義AOP的方式可以實現(xiàn)攔截。

有幾個關(guān)鍵點

1. 定義切入點為最大項目包

2. 采用AOP的@AfterThrowing注解獲取到全局異常捕獲一個例子package com.example.promethuesdemo.exception; import lombok.extern.slf4j.Slf4j; import org.aspectj.lang.JoinPoint; import org.aspectj.lang.annotation.AfterThrowing; import org.aspectj.lang.annotation.Aspect; import org.aspectj.lang.annotation.Pointcut; import org.springframework.stereotype.Component; /** * @author chenzhen * Created by chenzhen on 2020/7/20.

*/
    @Aspect
    @Slf4j
    @Component
    public class GlobalExceptionAspect {
        @Pointcut("execution(* com.example..*.*(..))")
        public void pointcut(){
 
        }
 
        @AfterThrowing(pointcut = "pointcut()",throwing = "e")
        public void afterThrowing(JoinPoint joinPoint,Throwable e){
            log.error("全局捕獲到異常了..............");
            //紀錄錯誤信息
            log.error("系統(tǒng)錯誤:{}", e.getMessage());
            // todo 想要執(zhí)行的操作
        }
 
    }

aop中相關(guān)概念

Aspect（切面）： Aspect 聲明類似于 Java 中的類聲明，在 Aspect 中會包含著一些 Pointcut 以及相應的 Advice。* Joint point（連接點）：表示在程序中明確定義的點，典型的包括方法調(diào)用，對類成員的訪問以及異常處理程序塊的執(zhí)行等等，它自身還可以嵌套其它

joint point。* Pointcut（切點）：表示一組 joint point，這些 joint point 或是通過邏輯關(guān)系組合起來，或是通過通配、正則表達式等方式集中起來，它定義了相應的 Advice 將要發(fā)生的地方。* Advice（增強）：Advice 定義了在 Pointcut 里面定義的程序點具體要做的操作，它通過 before、after 和 around 來區(qū)別是在每個 joint point 之前、之后還是代替執(zhí)行的代碼。* Target（目標對象）：織入 Advice 的目標對象.。 Weaving（織入）：將 Aspect 和其他對象連接起來, 并創(chuàng)建 Adviced object 的過程

Advice（增強）的類型

before advice, 在 join point 前被執(zhí)行的 advice. 雖然 before advice 是在 join point 前被執(zhí)行, 但是它并不能夠阻止 join point 的執(zhí)行, 除非發(fā)生了異常(即我們在 before advice 代碼中,不能人為地決定是否繼續(xù)執(zhí)行 join point 中的代碼)* after return advice, 在一個 join point 正常返回后執(zhí)行的 advice* after throwing advice, 當一個 join point 拋出異常后執(zhí)行的 advice* after(final) advice, 無論一個 join point 是正常退出還是發(fā)生了異常, 都會被執(zhí)行的 advice.* around advice, 在 join point 前和 joint point 退出后都執(zhí)行的 advice. 這個是最常用的 advice.* introduction，introduction可以為原有的對象增加新的屬性和方法。

注意

spring AOP中的AfterThrowing增強處理可以對目標方法的異常進行處理，但這種處理與直接使用catch捕捉處理異常的方式不同，catch捕捉意味著能完全處理異常，即只要catch塊本身不拋出新的異常，則被處理的異常不會往上級調(diào)用者進一步傳播下去；但是如果使用了AfterThrowing增強處理用于對異常進行處理，處理后異常仍然會往上一級調(diào)用者傳播，如果是在main中調(diào)用的目標方法，那么異常會直接傳到JVM，如下截圖所示：

SpringBoot 之配置全局異常處理器捕獲異常

另外需要注意， 如果目標方法中出現(xiàn)異常，并由catch捕捉處理且catch又沒有拋出新的異常，那么針對該目標方法的AfterThrowing增強處理將不會被執(zhí)行。

到此，相信大家對“SpringBoot怎么配置全局異常處理器捕獲異?！庇辛烁畹牧私?，不妨來實際操作一番吧！這里是億速云網(wǎng)站，更多相關(guān)內(nèi)容可以進入相關(guān)頻道進行查詢，關(guān)注我們，繼續(xù)學習！