Spring Boot与Kotlin Web应用的统一异常处理

做Web应用,请求处理过程中发生错误是非常常见的。 提供了一个默认的映射: ,当处理中抛出异常之后,会转到该请求中处理,并且该请求有一个全局的错误页面用来展示异常内容。

选择一个之前实现过的Web应用(chapter11-5-1)为基础,启动该应用,访问一个不存在的URL,或是修改处理内容,直接抛出异常,如:

注意版本实例修改默认端口,现在为8083,如果想修改为默认的,请修改application.yml文件

此时,可以看到类似下面的报错页面,该页面就是 提供的默认 映射页面。

统一异常处理

虽然,Spring Boot中实现了默认的 映射,但是在实际应用中,上面你的错误页面对用户来说并不够友好,我们通常需要去实现我们自己的异常提示。

下面我们以之前的Web应用例子为基础(chapter11-5-1),进行统一异常处理的改造。

创建全局异常处理类:通过使用 定义统一的异常处理类,而不是在每个 中逐个定义。 用来定义函数针对的异常类型,最后将 对象和请求URL映射到 中

@ControllerAdvice 注解的类需要增加 @RestController //springboot1.5.7版本,如果不加 这个会报错 jsonErrorHandler

实现 页面展示:在 目录下创建 ,将请求的URL和 对象的 输出。

启动该应用,访问:http://localhost:8083/hello,可以看到如下错误提示页面。

通过实现上述内容之后,我们只需要在 中抛出Exception,当然我们可能会有多种不同的Exception。然后在 类中,根据抛出的具体Exception类型匹配 中配置的异常类型来匹配错误映射和处理。

返回JSON格式

在上述例子中,通过 统一定义不同Exception映射到不同错误处理页面。而当我们要实现RESTful API时,返回的错误是JSON格式的数据,而不是HTML页面,这时候我们也能轻松支持。

本质上,只需在 之后加入 ,就能让处理函数return的内容转换为JSON格式。

下面以一个具体示例来实现返回JSON格式的异常处理。

创建统一的JSON返回对象,code:消息类型,message:消息内容,url:请求的url,data:请求返回的数据

创建一个自定义异常,用来实验捕获该异常,并返回json

Controller中增加json映射,抛出QkException异常

为QkException异常创建对应的处理

启动应用,访问:http://localhost:8083/json,可以得到如下返回内容:

至此,已完成在Spring Boot中创建统一的异常处理,实际实现还是依靠Spring MVC的注解,更多更深入的使用可参考[Spring MVC]的文档。

参考

https://spring.io/guides/gs/serving-web-content/

源码

https://github.com/quanke/spring-boot-with-kotlin-in-action/chapter11-5-3

《Spring Boot 与 kotlin 实战》欢迎关注

全科龙婷升职加薪

  • 发表于:
  • 原文链接http://kuaibao.qq.com/s/20180119G08MXX00?refer=cp_1026
  • 腾讯「云+社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。

扫码关注云+社区

领取腾讯云代金券