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

Stella981
• 阅读 702

做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]的文档。

参考

源码

关注《Spring Boot 与 kotlin 实战》

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

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
Stella981 Stella981
3年前
SpringBoot项目中自定义404页面
1错误处理有原理分析使用SpringBoot创建的web项目中,当我们请求的页面不存在(http状态码为404),或者服务器发生异常(http状态码一般为500)时,SpringBoot就会给我们返回错误信息。也就是说,在SpringBoot的web项目中,会自动创建一个/error的错误接口,来返回错误信息。但是针对不同的访问方式,会有以下两种
Easter79 Easter79
3年前
SpringMVC源码(五)
SpringMVC除了对请求URL的路由处理特别方便外,还支持对异常的统一处理机制,可以对业务操作时抛出的异常,unchecked异常以及状态码的异常进行统一处理。SpringMVC既提供简单的配置类,也提供了细粒度的异常控制机制。SpringMVC中所有的异常处理通过接口HandlerExceptionResolver来实现,接口中只定义了一个方法
Stella981 Stella981
3年前
Spring Boot 异常处理
默认异常处理机制SpringBoot根据发送请求头中的accept是否包含text/html来分别返回不同的响应信息。当从浏览器地址栏中访问应用接口时,请求头中的accept便会包含text/html信息,产生异常时,SpringBoot通过org.springframework.web.servlet.ModelAndView对象
Wesley13 Wesley13
3年前
03.Android崩溃Crash库之ExceptionHandler分析
目录总结00.异常处理几个常用api01.UncaughtExceptionHandler02.Java线程处理异常分析03.Android中线程处理异常分析04.为何使用setDefaultUncaughtExceptionHandler前沿上一篇整体介绍了crash崩溃
Wesley13 Wesley13
3年前
Java异常
异常分为两种:Exception、ErrorException:异常,可以捕捉到,进行处理以后可以让程序继续正常执行Error:错误,不能捕捉,只能修改代码,重新执行ThrowableException(RuntimeException非运行时异常)throw:抛出指定的异常throws:用在方法声明处,声明该方法可能发生
Easter79 Easter79
3年前
SpringBoot项目中自定义404页面
1错误处理有原理分析使用SpringBoot创建的web项目中,当我们请求的页面不存在(http状态码为404),或者服务器发生异常(http状态码一般为500)时,SpringBoot就会给我们返回错误信息。也就是说,在SpringBoot的web项目中,会自动创建一个/error的错误接口,来返回错误信息。但是针对不同的访问方式,会有以下两种
Stella981 Stella981
3年前
SpringBoot2 全局异常处理
参考这篇文章里面的几种异常形式:全局异常处理是个比较重要的功能,一般在项目里都会用到。 大概把一次请求分成三个阶段,来分别进行全局的异常处理。 一:在进入Controller之前,譬如请求一个不存在的地址,404错误。 二:在执行@RequestMapping时,进入逻辑处理阶段前。譬如传的参数类型错误。 
Easter79 Easter79
3年前
SpringBoot2 全局异常处理
参考这篇文章里面的几种异常形式:全局异常处理是个比较重要的功能,一般在项目里都会用到。 大概把一次请求分成三个阶段,来分别进行全局的异常处理。 一:在进入Controller之前,譬如请求一个不存在的地址,404错误。 二:在执行@RequestMapping时,进入逻辑处理阶段前。譬如传的参数类型错误。 
小万哥 小万哥
1年前
C++异常和错误处理机制:如何使您的程序更加稳定和可靠
在C编程中,异常处理和错误处理机制是非常重要的。它们可以帮助程序员有效地处理运行时错误和异常情况。本文将介绍C中的异常处理和错误处理机制。什么是异常处理?异常处理是指在程序执行过程中发生异常或错误时,程序能够捕获并处理这些异常或错误的机制。例如,当