异常处理java后端项目比较重要的一点

  • Z时代
  • 2024-01-10
  • 分类：综合

编程

一、Controller局部异常处理

1.1. 使用示例

这种异常处理只局部于某个Controller内，如：

@Controller
@Slf4j
@RequestMapping("/api/demo")
public class DemoController {
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public ResponseDTO<?> exceptionHandler(Exception e) {
        log.error("[{}] system error", e);
        return ResponseDTO.builder()
        .errorCode(ErrorCode.SYSTEM_ERROR)
        .build();
    }
}

  • 所有Controller方法（即被RequestMapping注解的方法）抛出的异常，会被该异常处理方法处理。

  • 使用上，在Controller内部，用@ExceptionHandler注解的方法，就会作为该Controller内部的异常处理方法。

  • 并且，它的参数中可以注入如WebRequest、NativeWebRequest等，用来拿到请求相关的数据。

  • 它可以返回String代表一个view名称，也可以返回一个对象并且用@ResponseBody修饰，由框架的其它机制帮你序列化。

此外，它还能够对异常类型进行细粒度的控制，通过注解可以有选择的指定异常处理方法应用的异常类型：

@ExceptionHandler({BusinessException.class, DataBaseError.class })

虽然说全局异常处理HandlerExceptionResolver通过条件判断也能做到，

但是使用这种注解方式明显更具有可读性。

二、ControllerAdvice

2.1 使用示例

刚才介绍的是Controller局部的异常处理，用于处理该Controller内部的特有的异常处理十分有用。

首先，定义一个存放异常处理函数的类，并使用@ControllerAdvice修饰。

@ControllerAdvice(assignableTypes = {GlobalExceptionHandlerMixin.class})
public class ExceptionAdvice {
    @ExceptionHandler(ErrorCodeWrapperException.class)
    @ResponseBody
    public ResponseDTO<?> exceptionHandler(ErrorCodeWrapperException e) {
        if ((errCodeException.getErrorCode().equals(ErrorCode.SYSTEM_ERROR))) {
            log.error(e);
        }
        return ResponseDTO.ofErroCodeWrapperException(errCodeException);
    }
}

@ExceptionHanlder修饰的方法的写法和Controller内的异常处理函数写法是一样的。

2.2 控制生效的Controller范围

注意到，我是这样编写注解的：

@ControllerAdvice(assignableTypes = {GlobalExceptionHandlerMixin.class})

它用来限定这些异常处理函数起作用的Controller的范围。如果不写，则默认对所有Controller有效。

这也是ControllerAdvice进行统一异常处理的优点，它能够细粒度的控制该异常处理器针对哪些Controller有效，这样的好处是：

  • 一个系统里就能够存在不同的异常处理器，Controller也可以有选择的决定使用哪个，更加灵活。

  • 不同的业务模块可能对异常处理的方式不同，通过该机制就能做到。

  • 设想一个一开始并未使用全局异常处理的系统，如果直接引入全局范围内生效的全局异常处理，势必可能会改变已有Controller的行为，有侵入性。也就是说，如果不控制生效范围，即默认对所有Controller生效。如果控制生效范围，则默认对所有Controller不生效，降低侵入性。

如刚才示例中的例子，只针对实现了GlobalExceptionHandlerMixin接口的类有效：

@Controller
@Slf4j
@RequestMapping("/api/demo")
public class DemoController implements GlobalExceptionHandlerMixin {
}

ControllerAdvice支持的限定范围：

  • 按注解：@ControllerAdvice(annotations = RestController.class)

  • 按包名：@ControllerAdvice("org.example.controllers")

  • 按类型：@ControllerAdvice(assignableTypes = {ControllerInterface.class, AbstractController.class})

三、总结

以上几种方式是Spring专门为异常处理设计的机制。

就我个人而言，由于ControllerAdvice具有更细粒度的控制能力，所以我更偏爱于在系统中使用ControllerAdvice进行统一异常处理。

除了用异常来传递系统中的意外错误，也会用它来传递处于接口行为一部分的业务错误。

这也是异常的优点之一，如果接口的实现比较复杂，分多层函数实现，如果直接传递错误码，那么到Controller的路径上的每一层函数都需要检查错误码，退回到了C语言那种可怕的“写一行语句检查一下错误码”的模式。

当然，理论上，任何能够给Controller加切面的机制都能变相的进行统一异常处理。比如：

  • 在拦截器内捕获Controller的异常，做统一异常处理。

  • 使用Spring的AOP机制，做统一异常处理。

以上是 异常处理java后端项目比较重要的一点 的全部内容， 来源链接： utcz.com/z/510385.html

回到顶部