예외를 포착하도록 SpringBoot 전역 예외 처리기를 구성하는 방법

1. 머리말

어떤 시스템에서든 모든 곳에서 예외를 어리석게 포착하고 처리하지는 않습니다. 일반적으로 스프링 부트의 전역 예외 처리는

매우 간단합니다. End-end 분리 후, Back-end API는 일반적으로 예외 처리를 위해

2가지만 하면 됩니다. 1. 로그와 그에 따른 알림 처리를 기록하는 것이 내부

2. 입니다. API 호출자에게 반환 결과를 제공하는 것은 외부입니다

API 호출자의 경우 반환 결과(오류 코드, 프롬프트 정보 포함)만 필요하고 다른 결과는 신경 쓰지 않습니다.

백엔드의 경우에만 관련 문제를 처리하려면 해당 메시지를 기록하고 다른 대기열에 게시해야 합니다.

그래서 많은 사용자 정의 예외 클래스를 캡슐화하는 사람들을 많이 보았습니다. 실제로 모든 것을 처리하는 데는 하나의 예외 처리기가 필요합니다. 예, 그런 다음 오류 식별 코드 열거와 API 호출자에게 반환되는 메시지를 캡슐화하면 모든 백엔드 처리를 예외 처리 방법에서 직접 처리할 수 있습니다.

이상에 대한 생각과 이해

모든 이상은 시스템의 이상 징후이고 결함이며 BUG임을 인식해야 합니다. 해야 할 일은 시스템 개선을 위해 예외 처리 개선에만 의존하기보다는 시스템 가용성을 향상하고 예외 발생을 최대한 방지하는 것입니다.

예외 처리는 예외 발생이 불가피한 시스템을 위한 긴급 조치입니다.

시스템에 예외가 너무 많으면 예외 처리 메커니즘을 개선하는 것이 아니라 시스템 아키텍처 설계가 합리적인지, 시스템 논리 설계가 합리적인지 반성해야 합니다.

2. 전역 예외 및 처리 방법 1(@ControllerAdvice 및 @ExceptionHandler)

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

개발 중에 다음과 같은 시나리오가 발생합니다. 특정 인터페이스에 몇 가지 비즈니스 예외가 있습니다. 예를 들어, 사용자가 입력한 매개변수가 확인되지 않거나 사용자 이름과 비밀번호가 존재하지 않는 경우 등이 있습니다. 이러한 비즈니스 예외가 트리거되면 이러한 사용자 지정 비즈니스 예외를 발생시키고 처리해야 합니다. 일반적으로 이러한 예외 정보의 상태 코드와 예외 설명을 호출자에게 친근한 방식으로 반환해야 하며 호출자는 상태 코드 및 기타 정보를 사용하여 예외의 특정 상황을 결정합니다.

과거에는 컨트롤러 계층에서 try/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에서는 @ExceptionHandler, @InitBinder, @ModelAttribute를 정의하는 데 사용할 수 있는 @ControllerAdvice 주석이 추가되었으며 모든 @RequestMapping에 적용됩니다. 간단히 말하면, @ControllerAdvice 주석을 통해 전역 예외 처리 클래스를 구성하여 컨트롤러 계층에서 예외를 균일하게 처리하는 동시에 컨트롤러에 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의 값은 처리해야 하는 예외 클래스의 클래스 파일입니다. 이 예에서는 메소드가 두 개의 매개변수로 전달됩니다. 하나는 해당 Exception 예외 클래스이고, 다른 하나는 HttpServletRequest 클래스입니다. 물론, 이 두 매개변수 외에도 일부 다른 매개변수도 지원됩니다. 이러한 방식으로 다양한 예외를 균일하게 처리할 수 있습니다. 일반적으로 컨트롤러에서 try/catch를 사용하지 않기 위해 GlobalExceptionHandler에서 Exception을 균일하게 처리할 수도 있습니다. 이런 방식으로 @ExceptionHandler로 구성되지 않은 다른 예외는 균일하게 처리됩니다.

예외가 발생하면 예외를 발생시키세요

비즈니스에서 비즈니스 예외가 발생하면 throw를 사용하여 해당 비즈니스 예외를 발생시키세요. 예를 들어 Controller에

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

를 작성하는 방법은 다음과 같습니다.

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 중국어 웹사이트의 기타 관련 기사를 참조하세요!