So konfigurieren Sie den globalen Ausnahmehandler von SpringBoot, um Ausnahmen abzufangen

1. Vorwort

In jedem System werden wir Ausnahmen nicht an jeder Stelle abfangen und behandeln. Im Allgemeinen ist die globale Ausnahmebehandlung von Spring Boot sehr einfach End-End-Trennung, Back-End-API, im Allgemeinen sind für die Ausnahmebehandlung nur zwei Dinge zu tun:

1 Es handelt sich um die Aufzeichnung von Protokollen und die entsprechende Benachrichtigungsverarbeitung, die intern erfolgt

2. Es ist zu tun Geben Sie das Rückgabeergebnis an den API-Aufrufer weiter, dies ist extern

Für den API-Aufrufer benötigt er nur ein Rückgabeergebnis (einschließlich Fehlercode, Eingabeaufforderungsinformationen), die anderen sind ihm egal. Für das Backend benötigt er nur Zum Aufzeichnen, Benachrichtigen oder Veröffentlichen entsprechender Nachrichten an andere Warteschlangen.

Also: Ich habe viele Leute gesehen, die viele benutzerdefinierte Ausnahmeklassen kapseln. Tatsächlich ist nur ein Ausnahmehandler erforderlich, um alle Ausnahmen zu behandeln Ja, und kapseln Sie dann eine Aufzählung von Fehleridentifikationscodes und fordern Sie die Rückgabe von Nachrichten an den API-Aufrufer auf. Es ist nicht erforderlich, N mehrere benutzerdefinierte Ausnahmen zu kapseln. das macht keinen Sinn;

Gedanken und Verständnis über Anomalien

Wir sollten erkennen, dass alle Anomalien abnormale Manifestationen des Systems sind, Defekte und Fehler, obwohl einige Ausnahmen aktiv sind. Was wir haben Dies ist zu versuchen, die Systemverfügbarkeit zu verbessern und das Auftreten von Ausnahmen weitestgehend zu vermeiden, anstatt sich auf die Verbesserung der Ausnahmebehandlung zu verlassen, um das System zu verbessern.

Die Ausnahmebehandlung ist das unvermeidliche Auftreten von Ausnahmen. Eine Notfallmaßnahme für das System Fehler wischen den Hintern ab;

Wenn das System zu viele Ausnahmen hat, müssen Sie nicht den Ausnahmebehandlungsmechanismus verbessern, sondern darüber nachdenken, ob das Design der Systemarchitektur angemessen ist und ob das Design der Systemlogik angemessen ist.

2. Globale Ausnahmen und Verarbeitungsmethode eins (@ControllerAdvice und @ExceptionHandler)

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

Während der Entwicklung werden wir die folgenden Szenarien haben: Es gibt einige Geschäftsausnahmen in einer bestimmten Schnittstelle. Beispielsweise können die vom Benutzer eingegebenen Parameter nicht überprüft werden, der Benutzername und das Passwort sind nicht vorhanden usw. Wenn diese Geschäftsausnahmen ausgelöst werden, müssen wir diese benutzerdefinierten Geschäftsausnahmen auslösen und sie behandeln. Im Allgemeinen müssen wir den Statuscode und die Ausnahmebeschreibung dieser Ausnahmeinformationen auf freundliche Weise an den Anrufer zurückgeben, und der Anrufer verwendet den Statuscode und andere Informationen, um die spezifischen Umstände der Ausnahme zu ermitteln.

In der Vergangenheit mussten wir es möglicherweise durch Try/Catch auf der Controller-Ebene handhaben. Fangen Sie zuerst benutzerdefinierte Ausnahmen ab, dann andere Ausnahmen. Für verschiedene Ausnahmen müssen wir das Objekt kapseln, das beim Abfangen zurückgegeben werden soll. Der Nachteil dabei ist jedoch, dass der Code ausführlicher wird. Jede Schnittstelle erfordert eine Try/Catch-Verarbeitung, und sobald sie angepasst werden muss, müssen alle Schnittstellen geändert werden, was sich sehr nachteilig auf die Codepflege auswirkt, wie im folgenden Codeabschnitt gezeigt wird

@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;
}

Gibt es also eine Möglichkeit, damit umzugehen? leicht? Was ist mit Ausnahmeinformationen? Die Antwort ist ja. In Spring 3.2 wurde die Annotation @ControllerAdvice hinzugefügt, die zum Definieren von @ExceptionHandler, @InitBinder und @ModelAttribute verwendet werden kann und auf alle @RequestMapping angewendet wird. Vereinfacht ausgedrückt können Sie über die Annotation @ControllerAdvice eine globale Ausnahmebehandlungsklasse konfigurieren, um Ausnahmen in der Controller-Ebene einheitlich zu behandeln. Gleichzeitig ist es nicht erforderlich, Try/Catch in den Controller zu schreiben, wodurch der Code sauber wird und pflegeleicht.

So verwenden Sie

Benutzerdefinierte Ausnahmen definieren

Das relevante Wissen über benutzerdefinierte Ausnahmen wird hier nicht im Detail erläutert. Wenn Sie es nicht verstehen, suchen Sie es selbst. Fügen Sie hier eine einfache benutzerdefinierte Business-Ausnahmeklasse ein.

/**
 * 自定义业务异常类
 *
 * @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;
    }
}

Hinweis: @Data ist ein Lombok-Plug-in. Set/Get-Methoden automatisch generieren. Die spezifische Verwendungsmethode wird hier nicht vorgestellt.

@ControllerAdvice + @ExceptionHand` Konfigurieren Sie die globale Ausnahmebehandlungsklasse.

/**
 * 全局异常处理器
 *
 * @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

Definieren Sie diese Klasse als globale Ausnahmebehandlungsklasse.

@ExceptionHandler

Definieren Sie diese Methode als Ausnahmebehandlungsmethode. Der Wert von value ist die Klassendatei der Ausnahmeklasse, die behandelt werden muss. Im Beispiel wird die Methode in zwei Parametern übergeben. Eine davon ist die entsprechende Exception-Ausnahmeklasse und die andere ist die HttpServletRequest-Klasse. Zusätzlich zu diesen beiden Parametern werden natürlich auch einige andere Parameter unterstützt.

Auf diese Weise können unterschiedliche Ausnahmen einheitlich behandelt werden. Um die Verwendung von Try/Catch im Controller zu vermeiden, kann die Ausnahme normalerweise auch einheitlich im GlobalExceptionHandler verarbeitet werden. Auf diese Weise werden andere Ausnahmen, die nicht mit @ExceptionHandler konfiguriert sind, einheitlich behandelt.

Wirf einfach eine Ausnahme, wenn du auf eine Ausnahme stößt.

Wenn du im Geschäftsleben auf eine Geschäftsausnahme stößt, verwende einfach throw, um die entsprechende Geschäftsausnahme auszulösen. Zum Beispiel, wie man

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

in Controller

schreibt

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 之配置全局异常处理器捕获异常

Beachten Sie außerdem, dass die AfterThrowing-Erweiterungsverarbeitung für die Zielmethode nicht ausgeführt wird, wenn in der Zielmethode eine Ausnahme auftritt und von „catch“ abgefangen und behandelt wird und „catch“ keine neue Ausnahme auslöst.

Das obige ist der detaillierte Inhalt vonSo konfigurieren Sie den globalen Ausnahmehandler von SpringBoot, um Ausnahmen abzufangen. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!