spring boot 教程(四) 统一异常处理

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

当处理中抛出异常之后,会转到该请求中处理,并且该请求有一个全局的错误页面用来展示异常内容。下图列出了Spring Boot中跟

MVC异常处理相关的类。

在spring Boot中,我们如果访问一个不存在的URL,就会得到spring boot中内置的页面。


我们在这里修改一下,以前的内容,直接抛出一个异常看看有什么效果

  @RequestMapping("/")
    public String index() throws Exception{
    	throw new Exception("error");  
    }


它会把我们抛出的异常信息,打印在下面。那么为什么Spring Boot会打印这些东西啦,是因为Spring Boot在启动过程中会根据当前环境进行AutoConfiguration,其中跟MVC错误处理相关的配置内容,在ErrorMvcAutoConfiguration这个类中。在Servlet容器中添加了一个默认的错误页面

在ErrorMvcAutoConfiguration类实现了EmbeddedServletContainerCustomizer接口,所以可以

通过override customize方法来定制Servlet容器

@Value("${error.path:/error}")
private String errorPath = "/error";

@Override
public void customize(ConfigurableEmbeddedServletContainer container) {
    container.addErrorPages(new ErrorPage(this.properties.getServletPrefix()
        + this.errorPath));
}

可以看到ErrorMvcAutoConfiguration在容器中,添加了一个错误页面/error。因为这项配置的存在,如果Spring MVC在处理过程抛出异常到Servlet容器,

容器会定向到这个错误页面/error。

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

  • 创建全局异常处理类:通过使用@ControllerAdvice定义统一的异常处理类,而不是在每个Controller中逐个定义。@ExceptionHandler用来定义函数针对的异常类型,
  • 最后将Exception对象和请求URL映射到error.html
  • 实现error.html页面展示:在templates目录下创建error.html,将请求的URL和Exception对象的message输出。
@ControllerAdvice
public class GlobalExceptionHandler {
	public static final String DEFAULT_ERROR_VIEW = "error";
    @ExceptionHandler(value = Exception.class)
    public ModelAndView defaultErrorHandler(HttpServletRequest req, Exception e) throws Exception {
        ModelAndView mav = new ModelAndView();
        mav.addObject("exception", e);
        mav.addObject("url", req.getRequestURL());
        mav.setViewName(DEFAULT_ERROR_VIEW);
        System.out.println("进来了--------------------");
        return mav;
    }
}
  • 实现error.html页面展示:在templates目录下创建error.html,将请求的URL和Exception对象的message输出。
<html>
<head lang="en">
    <meta charset="UTF-8" />
    <title>统一异常处理</title>
</head>
<body>
    <h1>Error Handler1</h1>
    <div th:text="${url}"></div>
    <div th:text="${exception.message}"></div>
</body>
</html>

最后访问异常方法可以看到


通过实现上述内容之后,我们只需要在Controller中抛出Exception,当然我们可能会有多种不同的Exception

然后在@ControllerAdvice类中,根据抛出的具体Exception类型匹配@ExceptionHandler中配置的异常类型来匹配错误映射和处理。

返回JSON格式

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

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

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

  • 创建统一的JSON返回对象,code:消息类型,message:消息内容,url:请求的url,data:请求返回的数据
public class ErrorInfo<T> {
    public static final Integer OK = 0;
    public static final Integer ERROR = 100;
    private Integer code;
    private String message;
    private String url;
    private T data;
    // 省略getter和setter


  • 创建一个自定义异常,用来实验捕获该异常,并返回json
public class MyException extends Exception {
    public MyException(String message) {
        super(message);
    }
    
}


  • Controller中增加json映射,抛出MyException异常
 @RequestMapping("/json")
    public String json() throws MyException {
        throw new MyException("发生错误2");
    }

  • MyException异常创建对应的处理
   @ExceptionHandler(value = MyException.class)
    @ResponseBody
    public ErrorInfo<String> jsonErrorHandler(HttpServletRequest req, MyException e) throws Exception {
        ErrorInfo<String> r = new ErrorInfo<>();
        r.setMessage(e.getMessage());
        r.setCode(ErrorInfo.ERROR);
        r.setData("Some Data");
        r.setUrl(req.getRequestURL().toString());
        return r;
    }

我们访问页面就可以得到下面的结果




至此,已完成在Spring Boot中创建统一的异常处理,实际实现还是依靠Spring MVC的注解。

补充:如果全部异常处理返回json,那么可以使用 @RestControllerAdvice 代替 @ControllerAdvice ,

这样在方法上就可以不需要添加 @ResponseBody。


展开阅读全文

没有更多推荐了,返回首页