SpringBoot怎麼配置全域異常處理器擷取異常

1.前言

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

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

1.是記錄日誌及相應通知處理，這是對內的

2.是給予回傳結果給API呼叫者，這是對外的

對API呼叫者來說，他只需要一個回傳結果（包含錯誤代碼、提示訊息），其他的他不關心

對後端來說，他只需要記錄日誌，通知或給發布對應訊息給其他佇列處理相關事項；

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

關於異常的思想認知

我們應該要認識到，一切異常，對系統來說，都是不正常的表現，都是屬於缺陷，都屬於BUG，儘管有些異常是我們主動拋出的；

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

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

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

如果系統異常過多，那麼你要做的不是去完善異常處理機制，而是要好好去反思：系統架構設計是否合理，系統邏輯設計是否合理；

2.全域例外並處理的方法一（@ControllerAdvice 和@ExceptionHandler）

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

在開發中，我們會有如下的場景：某個介面中，存在一些業務異常。例如使用者輸入的參數校驗失敗、使用者名稱密碼不存在等。當觸發這些業務異常時，我們需要拋出這些自訂的業務異常，並對其進行處理。一般我們要把這些異常訊息的狀態碼和異常描述，友善地回傳給呼叫者，呼叫者則利用狀態碼等資訊判斷異常的具體情況。

過去，我們可能需要在 controller 層透過 try/catch 處理。首先 catch 自訂異常，然後 catch 其它異常。對於不同的異常，我們需要在 catch 的同時封裝將要傳回的物件。然而，這麼做的弊端就是程式碼會變得冗長。每個介面都需要做try/catch 處理，而且一旦需要調整，所有的介面都需要修改一遍，非常不利於程式碼的維護，如下段程式碼所示

@RequestMapping (value = "/test")
public ResponseEntity test() {
    ResponseEntity re = new ResponseEntity();
    // 业务处理
    // ...
    try {
        // 业务
    } catch (BusinessException e) {
        logger.info("业务发生异常，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 註解配置一個全域異常處理類，來統一處理 controller 層中的異常，於此同時 controller 中可以不用再寫 try/catch，這使得程式碼既整潔又便於維護。

使用方法

定義自訂異常

#有關自訂異常相關知識點這裡就不詳細說明了，如果不了解的話自行搜尋一下。這裡貼上一個簡單的自訂業務異常類別。

/**
 * 自定义业务异常类
 *
 * @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("业务异常。code:" + e.getCode() + "msg:" + e.getMsg());
        return new ResponseEntity(e.getCode(), e.getMsg());
    }
}

@ControllerAdvice

## 定義該類別為全域例外處理類。

@ExceptionHandler

定義此方法為例外處理方法。 value 的值為需要處理的異常類別的 class 檔案。在例子中，方法傳入兩個參數。一個是對應的 Exception 異常類，一個是 HttpServletRequest 類別。當然，除了這兩種參數，也支援傳入一些其他參數。

這樣，就可以對不同的異常進行統一處理了。通常，為了讓 controller 中不再使用任何 try/catch，也可以在 GlobalExceptionHandler 中對 Exception 做統一處理。這樣其他沒有用 @ExceptionHandler 配置的例外狀況就會統一處理。

遇到異常時拋出異常即可

在業務中，遇到業務例外的地方，直接使用 throw 拋出對應的業務例外。例如

throw new BusinessException("3000", "账户密码错误");

在 Controller 中的寫法

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

@RequestMapping(value = "/test")
public ResponseEntity test() {
    ResponseEntity re = new ResponseEntity();
    // 业务处理
    // ...
    return re;
}

结果展示

异常抛出后，返回如下结果。

{
    "code": "3000",
    "msg": "账户密码错误",
    "data": null
}

注意 不一定必须在 controller 层本身抛出异常才能被 GlobalExceptionHandler 处理，只要异常最后是从 contoller 层抛出去的就可以被全局异常处理器处理。异步方法中的异常不会被全局异常处理。抛出的异常如果被代码内的 try/catch 捕获了，就不会被 GlobalExceptionHandler 处理了。总结

本文介绍了在 SpringBoot 中，通过配置全局异常处理器统一处理 Controller 层引发的异常。

优点

减少代码冗余，代码便于维护

缺点

只能处理 controller 层抛出的异常，对例如 Interceptor（拦截器）层的异常、定时任务中的异常、异步方法中的异常，不会进行处理。

3.全局异常并处理的方法二 (AOP)

虽然@ControllerAdvice注解通常和@ExceptionHandler注解用于全局异常的处理。

但是这种方式有个缺点就是，只是对控制层进行了异常拦截，比如像工具类中或者其他类中的异常，并不会拦截。

由于业务执行时不能保证程序不出错,所以写代码必须添加try-catch,但是如果频繁的添加try-catch则必然导致代码结构混乱.所以需要进行优化.

原则:如果出现了问题一般将检查异常,转化为运行时异常.

核心原理: 代理动态思想------->AOP操作

采用自定义AOP的方式可以实现拦截。

有几个关键点

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("系统错误:{}", e.getMessage());
            // todo 想要执行的操作
        }
 
    }

aop中相关概念

Aspect（切面）： Aspect 声明类似于 Java 中的类声明，在 Aspect 中会包含着一些 Pointcut 以及相应的 Advice。* Joint point（连接点）：表示在程序中明确定义的点，典型的包括方法调用，对类成员的访问以及异常处理程序块的执行等等，它自身还可以嵌套其它

joint point。* Pointcut（切点）：表示一组 joint point，这些 joint point 或是通过逻辑关系组合起来，或是通过通配、正则表达式等方式集中起来，它定义了相应的 Advice 将要发生的地方。* Advice（增强）：Advice 定义了在 Pointcut 里面定义的程序点具体要做的操作，它通过 before、after 和 around 来区别是在每个 joint point 之前、之后还是代替执行的代码。* Target（目标对象）：织入 Advice 的目标对象.。 Weaving（织入）：将 Aspect 和其他对象连接起来, 并创建 Adviced object 的过程

Advice（增强）的类型

before advice, 在 join point 前被执行的 advice. 虽然 before advice 是在 join point 前被执行, 但是它并不能够阻止 join point 的执行, 除非发生了异常(即我们在 before advice 代码中,不能人为地决定是否继续执行 join point 中的代码)* after return advice, 在一个 join point 正常返回后执行的 advice* after throwing advice, 当一个 join point 抛出异常后执行的 advice* after(final) advice, 无论一个 join point 是正常退出还是发生了异常, 都会被执行的 advice.* around advice, 在 join point 前和 joint point 退出后都执行的 advice. 这个是最常用的 advice.* introduction，introduction可以为原有的对象增加新的属性和方法。

注意

spring AOP中的AfterThrowing增强处理可以对目标方法的异常进行处理，但这种处理与直接使用catch捕捉处理异常的方式不同，catch捕捉意味着能完全处理异常，即只要catch块本身不抛出新的异常，则被处理的异常不会往上级调用者进一步传播下去；但是如果使用了AfterThrowing增强处理用于对异常进行处理，处理后异常仍然会往上一级调用者传播，如果是在main中调用的目标方法，那么异常会直接传到JVM，如下截图所示：

SpringBoot 之配置全局异常处理器捕获异常

另外要注意， 如果目標方法中出現異常，並由catch捕捉處理且catch又沒有拋出新的異常，那麼針對該目標方法的AfterThrowing增強處理將不會被執行。

以上是SpringBoot怎麼配置全域異常處理器擷取異常的詳細內容。更多資訊請關注PHP中文網其他相關文章！