• 欢迎访问 winrains 的个人网站!
  • 本网站主要从互联网整理和收集了与Java、网络安全、Linux等技术相关的文章,供学习和研究使用。如有侵权,请留言告知,谢谢!

Spring Boot 全局异常处理(下)

Spring Boot winrains 来源:陈凯凯 11个月前 (10-30) 37次浏览

一、背景

在上篇【链接】中介绍了 Spring Boot 全局异常处理的一种方式,但那是一种全局性的容错机制,目的是把 Spring Boot 默认的 ErrorController 替换掉,从而更友好地展示自定义的异常信息给客户端。
当然,除了这种全局的容错机制,有时候我们更希望对 Controller 层指定的异常进行特殊的处理,更甚至说这是异常处理的一种标准手段,即业务层的异常直接向上抛即可,不用自己处理,然后由 Controller 层进行统一的异常处理。

说明:本文的全局异常处理,同样可以抽象地理解成:全局处理 Controller 层抛出的异常

二、实现

Spring 给我们提供的两种实现的方式:

  • 局部异常处理:@Controller + @ExceptionHandler
  • 全局异常处理:@ControllerAdvice + @ExceptionHandler

此处的局部和全局的区别在于:
当代理方法出现在 @Controller 注解的类中时,则此方法会代理此 Controller 中的异常。
当代理方法出现在 @ControllerAdvice 注解的类中时,则此方法会代理所有 Controller 中的异常。

三、局部异常处理

局部异常处理,我们只需要在 @Controller 注解的类中写一个自定义的异常处理方法,然后给这个方法添加 @ExceptionHandler 注解即可,效果就是当此类中的方法有未捕获的异常抛出时,异常会以参数的形式传递给这个异常处理方法,我们只需要在此方法中进行相关的异常处理即可。

//局部异常处理(ps:对于参数必填的400异常也会被此异常处理器捕获)
@ExceptionHandler(Exception.class)
public String exHandler(Exception e) {
    if(e instanceof ArithmeticException) {
        return "除0异常-局部捕获";
    }
    if(e instanceof STCRException) {
        return "自定义异常-局部捕获";
    }
    // 未知的异常做出响应
    return "未知异常-局部捕获";
}

上述方法会处理所有的异常(因为参数是 Exception),当然,我们也可以根据异常的不同,来编写多个方法分别处理对应的异常(实现的过程只需要参数传递不同的异常类型即可)。
但是我们不可能在所有的类中都写一遍异常的处理方法,所以此处有两个思路:

  • 思路一:抽取异常处理代码做成基类,然后由每个需要异常处理的 Controller 类去继承
    缺点:类的继承机制,其实是一种概念上的属性的继承,此处仅仅是为了获得一个公共方法而去做异常类的继承,显然破坏了代码的优雅性。再言之,类是只能继承一次的,这样做有可能会破坏代码结构的设计。
  • 思路二:抽取代码做成接口,然后由每个需要异常处理的 Controller 类去实现这个接口即可
    这种思路得益于 Java8 的 Functional Interface,即可用在接口中写一个默认方法,此方法中是可以写具体的实现的。
    缺点:对环境的要求有些苛刻,即要求 JDK 的版本至少为 1.8,在某些应用中,显然是不合适的。

最后,无论是哪种抽取基类的实现,都是存在局限性的,因为这都要求我们去继承或实现该基类,显然这不是我们想要的,我们想要的是那种一劳永逸的实现方式。

四、全局异常处理

全局异常处理,其实很简单,我们只需要写一个配置类,在该类上添加注解 @ControllerAdvice,然后在该类中异常处理方法即可,同上文的局部异常处理方法。
效果是该类中的异常处理方法会自动处理所有 Controller 中抛出的异常,这才是满足我们需求的异常处理方式。

@ControllerAdvice
public class GlobalExceptionHandler {
    //处理自定义的异常
    @ExceptionHandler(STCRException.class)
    @ResponseBody
    public Object customHandler(STCRException e) {
        return "自定义异常-全局";
    }
    //其他未处理的异常
    @ExceptionHandler(Exception.class)
    @ResponseBody
    public Object exceptionHandler(Exception e) {
        return "其它异常-全局";
        }
}

五、总结

好了,我们先整理一下异常的处理流程,最外层的异常处理由 Spring 的全局异常 ErrorController 来接管,这其实是在过滤器层面进行的异常处理,内层由 @ExceptionHandler 处理所有 Controller 抛出的异常。
比如 404 异常,尚未进入 Controller 层,所以异常由 ErrorController 捕获处理。
比如 必填的参数缺失(400)异常,因为已经进入了 Controller 层,所有异常由 ExceptionHandler 捕获处理。
注:局部异常的优先级是高于全局异常的

作者:陈凯凯

来源:http://www.jetchen.cn/spring-boot-error-2/


版权声明:文末如注明作者和来源,则表示本文系转载,版权为原作者所有 | 本文如有侵权,请及时联系,承诺在收到消息后第一时间删除 | 如转载本文,请注明原文链接。
喜欢 (0)