Spring Boot 全局异常处理(下)

能够搜索微信公众号【Jet 与编程】查看更多精彩文章spring


背景

在上篇【连接】中介绍了 Spring Boot 全局异常处理的一种方式,但那是一种全局性的容错机制,目的是把 Spring Boot 默认的 ErrorController 替换掉,从而更友好地展现自定义的异常信息给客户端。编程

固然,除了这种全局的容错机制,有时候咱们更但愿对 Controller 层指定的异常进行特殊的处理,更甚至说这是异常处理的一种标准手段,即业务层的异常直接向上抛便可,不用本身处理,而后由 Controller 层进行统一的异常处理。微信

说明:本文的全局异常处理,一样能够抽象地理解成:全局处理 Controller 层抛出的异常spring-boot

实现

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

  • 局部异常处理:@Controller + @ExceptionHandler设计

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

此处的局部和全局的区别在于:code

当代理方法出如今 @Controller 注解的类中时,则此方法会代理此 Controller 中的异常。cdn

当代理方法出如今 @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 捕获处理。

注:局部异常的优先级是高于全局异常的

相关文章
相关标签/搜索