Spring Boot 全局异常处理(下)


背景

在上篇【链接】中介绍了 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 捕获处理。

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

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 162,306评论 4 370
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 68,657评论 2 307
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 111,928评论 0 254
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,688评论 0 220
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 53,105评论 3 295
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 41,024评论 1 225
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 32,159评论 2 318
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,937评论 0 212
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,689评论 1 250
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,851评论 2 254
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,325评论 1 265
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,651评论 3 263
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,364评论 3 244
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,192评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,985评论 0 201
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 36,154评论 2 285
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,955评论 2 279

推荐阅读更多精彩内容