转载

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

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

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

@RequestMapping("/hello")
@Throws(Exception::class)
fun hello() {
 throw Exception("发生错误")
}

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

server:
 port: 8080

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

Whitelabel Error Page
This application has no explicit mapping for /error, so you are seeing this as a fallback.

Fri Jan 19 10:01:32 CST 2018
There was an unexpected error (type=Internal Server Error, status=500).
????

统一异常处理

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

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

创建全局异常处理类：通过使用 @ControllerAdvice 定义统一的异常处理类，而不是在每个 Controller 中逐个定义。 @ExceptionHandler 用来定义函数针对的异常类型，最后将 Exception 对象和请求URL映射到 error.html 中

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

import org.springframework.web.bind.annotation.ControllerAdvice
import org.springframework.web.bind.annotation.ExceptionHandler
import org.springframework.web.bind.annotation.RestController
import org.springframework.web.servlet.ModelAndView
import javax.servlet.http.HttpServletRequest


/**
 * Created by http://quanke.name on 2018/1/10.
 */
@ControllerAdvice
@RestController //springboot1.5.7版本,如果不加 这个会报错 jsonErrorHandler
class GlobalExceptionHandler {

 @ExceptionHandler(value = Exception::class)
 @Throws(Exception::class)
 fun defaultErrorHandler(req: HttpServletRequest, e: Exception): ModelAndView {
 val mav = ModelAndView()
 mav.addObject("exception", e)
 mav.addObject("url", req.requestURL)
 mav.viewName = "error"
 return mav
 }

}

实现 error.html 页面展示：在 templates 目录下创建 error.html ，将请求的URL和 Exception 对象的 message 输出。

<!DOCTYPE html>
<html xmlns:th="http://www.w3.org/1999/xhtml">
<head lang="en">
 <meta charset="UTF-8" />
 <title>统一异常处理</title>
</head>
<body>
<h1>http://quanke.name Error Handler</h1>
<div th:text="${url}"></div>
<div th:text="${exception.message}"></div>
</body>
</html>

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

http://quanke.name Error Handler
http://127.0.0.1:8083/hello
发生错误

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

返回JSON格式

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

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

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

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

data class ErrorInfo<T>(var code: Int? = null,
 var message: String? = "",
 var url: String? = "",
 var data: T? = null
)

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

/**
 * Created by http://quanke.name on 2018/1/11.
 */

class QkException(message: String) : Exception(message)

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

import name.quanke.kotlin.chaper11_5_3.exception.QkException
import org.springframework.stereotype.Controller
import org.springframework.web.bind.annotation.RequestMapping


/**
 * Created by http://quanke.name on 2018/1/10.
 */
@Controller
class UserController {


 @RequestMapping("/json")
 @Throws(QkException::class)
 fun json(): String {
 throw QkException("发生错误 json")
 }

}

为QkException异常创建对应的处理

import name.quanke.kotlin.chaper11_5_3.entity.ErrorInfo
import org.springframework.web.bind.annotation.ControllerAdvice
import org.springframework.web.bind.annotation.ExceptionHandler
import org.springframework.web.bind.annotation.RestController
import javax.servlet.http.HttpServletRequest


/**
 * Created by http://quanke.name on 2018/1/10.
 */
@ControllerAdvice
@RestController //springboot1.5.7版本,如果不加 这个会报错 jsonErrorHandler
class GlobalExceptionHandler {
 
 @ExceptionHandler(value = QkException::class)
 @Throws(QkException::class)
 fun jsonErrorHandler(req: HttpServletRequest, e: QkException): ErrorInfo<String> {
 val r = ErrorInfo<String>()
 r.message = e.message
 r.code = 1
 r.data = "Some Data"
 r.url = req.requestURL.toString()
 return r
 }

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

{
 "code": 1,
 "message": "发生错误 json",
 "url": "http://127.0.0.1:8083/json",
 "data": "Some Data"
}

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

原文 http://quanke.name/posts/44428/

正文到此结束

所属分类： Spring 编程技术

本文标签： 数据 value 本质端口配置 XML springboot web map json Spring Boot java cat 实例 IO spring HTML message 目录 js App http https API entity servlet RESTful REST
版权声明： 本文为互联网转载文章，出处已在文章中说明(部分除外)。如果侵权，请联系本站长删除，谢谢。
本文海报： 生成海报一生成海报二

其他链接

关于本站

本站定位：个人技术类博客

本站作用：写博客、记日志、闲聊扯淡鼓捣技术。

问题交流

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

统一异常处理

返回JSON格式

热门推荐

相关文章

说给你听

本文目录

随机标签

书籍教程

近期评论

网站信息

其他链接

关于本站

问题交流