查看原文
其他

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

2017-08-08 翟永超 程序猿DD

《Spring Boot基础教程》系列文章微信公众号【复刻版】,所有内容都可在我的博客查阅,点击最下方的阅读原文可跳转至我的博客:http://blog.didispace.com


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

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

  1. @RequestMapping("/hello")

  2. public String hello() throws Exception {

  3.    throw new Exception("发生错误");

  4. }

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

统一异常处理

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

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

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

  1. @ControllerAdvice

  2. class GlobalExceptionHandler {

  3.    public static final String DEFAULT_ERROR_VIEW = "error";

  4.    @ExceptionHandler(value = Exception.class)

  5.    public ModelAndView defaultErrorHandler(HttpServletRequest req, Exception e) throws Exception {

  6.        ModelAndView mav = new ModelAndView();

  7.        mav.addObject("exception", e);

  8.        mav.addObject("url", req.getRequestURL());

  9.        mav.setViewName(DEFAULT_ERROR_VIEW);

  10.        return mav;

  11.    }

  12. }

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

  1. <!DOCTYPE html>

  2. <html>

  3. <head lang="en">

  4.    <meta charset="UTF-8" />

  5.    <title>统一异常处理</title>

  6. </head>

  7. <body>

  8.    <h1>Error Handler</h1>

  9.    <div th:text="${url}"></div>

  10.    <div th:text="${exception.message}"></div>

  11. </body>

  12. </html>

启动该应用,访问: http://localhost:8080/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:请求返回的数据

  1. public class ErrorInfo<T> {

  2.    public static final Integer OK = 0;

  3.    public static final Integer ERROR = 100;

  4.    private Integer code;

  5.    private String message;

  6.    private String url;

  7.    private T data;

  8.    // 省略getter和setter

  9. }

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

  1. public class MyException extends Exception {

  2.    public MyException(String message) {

  3.        super(message);

  4.    }

  5. }

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

  1. @Controller

  2. public class HelloController {

  3.    @RequestMapping("/json")

  4.    public String json() throws MyException {

  5.        throw new MyException("发生错误2");

  6.    }

  7. }

  • 为 MyException异常创建对应的处理

  1. @ControllerAdvice

  2. public class GlobalExceptionHandler {

  3.    @ExceptionHandler(value = MyException.class)

  4.    @ResponseBody

  5.    public ErrorInfo<String> jsonErrorHandler(HttpServletRequest req, MyException e) throws Exception {

  6.        ErrorInfo<String> r = new ErrorInfo<>();

  7.        r.setMessage(e.getMessage());

  8.        r.setCode(ErrorInfo.ERROR);

  9.        r.setData("Some Data");

  10.        r.setUrl(req.getRequestURL().toString());

  11.        return r;

  12.    }

  13. }

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

  1. {

  2.    code: 100,

  3.    data: "Some Data",

  4.    message: "发生错误2",

  5.    url: "http://localhost:8080/json"

  6. }

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


长按指纹

一键关注

好书推荐            

点击“阅读原文”

您可能也对以下帖子感兴趣

文章有问题?点此查看未经处理的缓存