@RestControllerAdvice与@ExceptionHandler实现全局异常处理

最新推荐文章于 2024-08-15 10:16:53 发布

Lysssyo

最新推荐文章于 2024-08-15 10:16:53 发布

阅读量386

点赞数 5

文章标签：开发语言 java spring 后端

本文链接：https://blog.csdn.net/Lysmua/article/details/141143760

版权

@RestControllerAdvice与@ExceptionHandler实现全局异常处理

@RestControllerAdvice

@RestControllerAdvice = @ControllerAdvice + @ResponseBody
@ControllerAdvice

@ControllerAdvice 是一个全局增强注解，用于定义全局的异常处理、数据绑定、以及预处理功能。它可以在整个应用程序范围内捕获异常，并对特定控制器或者请求进行统一处理。
@ResponseBody

@ResponseBody注解用于将控制器的方法返回值直接写入 HTTP 响应体中，而不是解析为视图。这意味着方法返回的对象会自动转换为 JSON 或 XML 格式并返回给客户端。
@ExceptionHandler

@ExceptionHandler 是 Spring Framework 中用于处理异常的注解，它允许你在特定的控制器类或全局范围内捕获和处理异常。它通常与 @ControllerAdvice 或 @RestControllerAdvice 结合使用，以便全局处理控制器中的异常。

本文主要介绍@RestControllerAdvice与@ExceptionHandler注解实现全局异常处理。

实现步骤

自定义异常类

CommonException

@Getter
public class CommonException extends RuntimeException{
    private int code;

    public CommonException(String message, int code) {
        super(message);
        this.code = code;
    }

    public CommonException(String message, Throwable cause, int code) {
        super(message, cause);
        this.code = code;
    }

    public CommonException(Throwable cause, int code) {
        super(cause);
        this.code = code;
    }
}

BadRequestException

public class BadRequestException extends CommonException{

    public BadRequestException(String message) {
        super(message, 400);
    }

    public BadRequestException(String message, Throwable cause) {
        super(message, cause, 400);
    }

    public BadRequestException(Throwable cause) {
        super(cause, 400);
    }
}

BizIllegalException

public class BizIllegalException extends CommonException{

    public BizIllegalException(String message) {
        super(message, 500);
    }

    public BizIllegalException(String message, Throwable cause) {
        super(message, cause, 500);
    }

    public BizIllegalException(Throwable cause) {
        super(cause, 500);
    }
}

创建全局异常处理器

@RestControllerAdvice
@Slf4j
public class CommonExceptionAdvice {

    @ExceptionHandler(CommonException.class)
    public Object handleBadRequestException(CommonException e) {
        log.error("自定义异常 -> {} , 异常原因：{}  ",e.getClass().getName(), e.getMessage());
        log.debug("详细信息：", e); //为了当log.level为debug级别时在控制台输出堆栈详细信息。
        return processResponse(e);
    }

    @ExceptionHandler(MethodArgumentNotValidException.class)
    public Object handleMethodArgumentNotValidException(MethodArgumentNotValidException e) {
        String msg = e.getBindingResult().getAllErrors()
                .stream().map(ObjectError::getDefaultMessage)
                .collect(Collectors.joining("|"));
        log.error("请求参数校验异常 -> {}", msg);
        log.debug("", e);
        return processResponse(new BadRequestException(msg));
    }

    @ExceptionHandler(BindException.class)
    public Object handleBindException(BindException e) {
        log.error("请求参数绑定异常 ->BindException， {}", e.getMessage());
        log.debug("", e);
        return processResponse(new BadRequestException("请求参数格式错误"));
    }

    @ExceptionHandler(NestedServletException.class)
    public Object handleNestedServletException(NestedServletException e) {
        log.error("参数异常 -> NestedServletException，{}", e.getMessage());
        log.debug("", e);
        return processResponse(new BadRequestException("请求参数处理异常"));
    }

    @ExceptionHandler(Exception.class)
    public Object handleRuntimeException(Exception e) {
        log.error("其他异常 uri : {} -> ", WebUtils.getRequest().getRequestURI(), e);
        return processResponse(new CommonException("服务器内部异常", 500));
    }

    private ResponseEntity<R<Void>> processResponse(CommonException e){
        return ResponseEntity.status(e.getCode()).body(R.error(e));
    }
}

注意全局异常处理器要放在启动类所在包或其子包下，如果不在启动类所在包或启动类所在包的子包，需要声明包扫描。

例如，CommonExceptionAdvice在com.hmall.advice下，而启动类在com.hmall.cart下，所以启动类需要声明包扫描：
@SpringBootApplication
@MapperScan("com.hmall.cart.mapper")
@ComponentScan(basePackages = {"com.hmall.advice","com.hmall.cart"})//声明包扫描
@EnableFeignClients(basePackages = "com.hmall.api.clients",defaultConfiguration = DefaultFeignConfig.class)
public class CartServiceApplication {

 public static void main(String[] args) {
     SpringApplication.run(CartServiceApplication.class, args);
 }

}

假设业务代码中抛出错误

    private void checkCartsFull(Long userId) {
        int count = lambdaQuery().eq(Cart::getUserId, userId).count();
        if (count >= cartProperties.getMaxAmount()) {
            throw new BizIllegalException(StrUtil.format("用户购物车课程不能超过{}", cartProperties.getMaxAmount()));
        }
    }