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

原创 2018-04-03 宗野 Spring Boot

我们在做Web应用的时候，请求处理过程中发生错误是非常常见的情况。Spring Boot提供了一个默认的映射：

/error

，当处理中抛出异常之后，会转到该请求中处理，并且该请求有一个全局的错误页面用来展示异常内容。选择一个之前实现过的Web应用为基础，启动该应用，访问一个不存在的URL，或是修改处理内容，直接抛出异常，如：
此时，可以看到类似下面的报错页面，该页面就是Spring Boot提供的默认error映射页面。 alt=默认的错误页面

统一异常处理

虽然，Spring Boot中实现了默认的error映射，但是在实际应用中，上面你的错误页面对用户来说并不够友好，我们通常需要去实现我们自己的异常提示。下面我们以之前的Web应用例子为基础（Chapter3-1-2），进行统一异常处理的改造。

• 创建全局异常处理类：通过使用

  @ControllerAdvice

  定义统一的异常处理类，而不是在每个Controller中逐个定义。

  @ExceptionHandler

  用来定义函数针对的异常类型，最后将Exception对象和请求URL映射到

  error.html

  中

• 实现

  error.html

  页面展示：在

  templates

  目录下创建

  error.html

  ，将请求的URL和Exception对象的message输出。

启动该应用，访问：

http://localhost:8080/hello

，可以看到如下错误提示页面。 alt=自定义的错误页面通过实现上述内容之后，我们只需要在

Controller

中抛出

Exception

，当然我们可能会有多种不同的

Exception

。然后在

@ControllerAdvice

类中，根据抛出的具体

Exception

类型匹配

@ExceptionHandler

中配置的异常类型来匹配错误映射和处理。

返回JSON格式

在上述例子中，通过

@ControllerAdvice

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

@ExceptionHandler

之后加入

@ResponseBody

，就能让处理函数return的内容转换为JSON格式。下面以一个具体示例来实现返回JSON格式的异常处理。

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

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

• Controller

  中增加json映射，抛出

  MyException

  异常

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

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

阅读更多