第二十一章:SpringBoot项目中的全局异常处理

全局异常处理不管对于API项目还是普通管理项目都是核心的部分,如果项目中遇到运行时异常,总不能每个异常处理都去添加try catch逻辑。在SpringBoot项目中跟SpringMVC的全局异常配置是一样的,下面我们来为API项目配置全局异常并且返回相同格式的JSON字符串。

免费专题文章汇总

恒宇少年在博客整理出来了SpringBoot、ApiBoot、SpringCloud的文章汇总【SpringBoot基础教程专题】,【SpringCloud基础教程专题】,【ApiBoot组件使用专题

本章目标

基于SpringBoot项目配置全局异常处理并且返回固定的JSON字符串。

构建项目

我们使用IntelliJ IDEA工具创建一个SpringBoot项目,事先添加依赖:Web、FastJson、Tomcat等,pom.xml配置文件内容如下图1所示:

图1

全局异常配置只需要添加一个全局的类即可,下面我们来配置全局异常Handler。

使用@ControllerAdvice

顾名思义,@ControllerAdvice注解是用来配置控制器通知的,我们可以配置过滤拦截具体一种或者多种类型的注解,添加annotations属性即可,因为我们全局返回的都是Json格式的字符串,所以需要再类上配置@ResponseBody注解,该注解熟知SpringMvc的开发人员都知道就不做过多的解释了,RestExceptionHandler全局处理类代码如下图2所示:

图2

我们在上图2内配置了运行时异常的方法处理,@ExceptionHandler注解用来配置需要拦截的异常类型,默认是全局类型。@ResponseStatus注解用于配置遇到该异常后返回数据时的StatusCode的值,我们这里默认使用值500。在类的上方我们配置了@ControllerAdvice的annotations属性值为RestController.class,也就是只有添加了@RestController注解的控制器才会进入全局异常处理,下面我们来添加一个测试控制器。

添加测试控制器

我们创建一个名叫做IndexController的控制器,代码如下图3所示:

图3

可以看到上图3内,我们的请求路径是/index/{number},这个number就是对应int number的值,我们输出20/number时,如果number = 0,那么就会出现RuntimeException。在测试代码之前我们需要添加一个固定返回Json的实体类ApiResult。

统一返回ApiResult实体

我们创建一个名叫ApiResult的实体,代码如下图4所示:

图4

这个只是一个返回对象,我们将这个类的构造函数私有化了,所以我们在外部不能直接使用new的方式创建对象,我们提供了一个newInstace方法来实例化ApiResult并获取对象。下面我们创建一个ApiResultGenerator用来生成ApiResult不同状态的返回内容(成功、失败)。

ApiResultGenerator构建者

该类是用来创建成功、失败返回JSON的工具类,普通消息方法代码如下图5所示:

图5

上图5内的方法是成功、失败共同调用的方法,成功构建ApiResult的方法如下图6所示:

图6

失败构建ApiResult的方法如下图7所示:

图7

运行测试

我们上面关于全局的异常处理已经配置完成,下面我们来运行项目测试全局异常是否生效,我们访问地址:127.0.0.1:8080/index/20,界面输出的效果如下图8所示:

图8

可以看到我们的参数number = 20时界面可以输出内容,那我们再来访问地址:127.0.0.1:8080/index/0,界面输出内容如下图9所示:

图9

上图9的内容是我们格式化ApiResult类后的Json字符串,可以看到给我们返回了错误消息以及对应的参数标识,证明我们配置的全局异常已经生效,当我们传入number = 0时,肯定会出现运行时的被除数不可以为0的异常,所以SpringBoot内置SpringMVC会通过检查是否配置全局异常来处理视图的返回内容。

总结

以上内容就是本章的全部讲解,本章主要讲解了SpringBoot项目如何配置全局异常处理,适应于普通SpringMVC项目以及SpringBoot项目。

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

推荐阅读更多精彩内容