SpringBoot中的错误处理机制源码解析

1、默认错误处理机制

1.1 现象描述

当我们使用浏览器访问一个路径出现错误时，SpringBoot会弹出一个ErrorPage：

当我们使用的是非浏览器的客户端来访问一个路径出现错误，会返回一个JSON字符串：

springboot根据访问者的request中的Accept属性来判断要返回什么样的数据，如果是浏览器，该属性如下：

如果不是浏览器，该属性如下：

也就是说，SpringBoot存在一个错误处理机制，会根据不同请求返回不同的结果。

1.2 原理解析

SpringBoot中存在一个专门处理错误情况的配置类ErrorMvcAutoConfiguration，这跟我们前面分析自动配置类没什么太大的区别。 进入这个配置类，配置类中配置了一个BasicErrorController对象：

@Bean
@ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT)
public BasicErrorController basicErrorController(ErrorAttributes errorAttributes, ObjectProvider<ErrorViewResolver> errorViewResolvers) {
	return new BasicErrorController(errorAttributes, this.serverProperties.getError(), errorViewResolvers.orderedStream().collect(Collectors.toList()));
}

这个BasicErrorController部分截图如下：

BasicErrorController是SpringBoot专门处理错误请求的控制器，当出现错误情况时，会访问/error路径，就进入到这个控制器了。 BasicErrorController有两个核心方法：

一个带produces属性，一个不带。带produces属性的表示产生html类型的数据；浏览器发送的请求来到这个方法处理。不带这个属性的产生json数据，其他客户端来到这个方法处理； errorHtml方法和error方法逻辑相似，都是根据request来生成返回数据，前者生成一个视图，后者生成一个response。 既然errorHtml方法是返回ModelAndView，那么就存在一个生成错误页面的视图解析器。我们回到自动配置类ErrorMvcAutoConfiguration，里面找到DefaultErrorViewResolver：

我们继续看它是怎么默认生成错误页面视图的，里面有个视图解析方法。

1.3 原理小结

SpringBoot有一个处理错误情况的机制，当访问的页面出现错误时：

1、BasicErrorController控制器判断访问来源是浏览器还是其他客户端来决定进入errorHtml方法还是error方法；

2、如果是浏览器，则生成视图，然后交给默认视图解析器DefaultErrorAttributes处理；处理过程就是：如果模板引擎可用，就访问模板路径下的/error相关页面；如果模板引擎不可用，就访问静态资源路径下的/error相关页面。

3、如果是非浏览器客户端，就生成json数据封装到response返回。

2、定制错误响应

2.1 定制错误页面

上面分析出SpringBoot会找模板引擎下的/error路径，但是我们初始项目并没有这个路径，其实是框架内置了一个空白页面，就是一开始我们看到的默认页面。当我们创建了/error目录，并在里面放了以错误码命名的html页面，那么SpringBoot就会去找我们定制的错误页面。 上面说到，SpringBoot有一个专门处理错误页面的控制器BasicErrorController，处理浏览器的是errorHtml方法，该方法在生成视图时，调用了getErrorAttributes方法：

这个方法返回一个ErrorAttributes对象：

ErrorAttributes是一个接口，SpringBoot有一个默认实现类DefaultErrorAttributes实现了该接口，里面对getErrorAttributes也有默认实现方法：

也就是说，有模板引擎情况下，我们定制了错误页面后，以状态码为命名，例如：404.html，然后我们自定义的错误页面可以获得时间戳、状态码、错误信息等数据。 当没有模板引擎时，会在静态资源文件夹下找。如果静态资源文件夹也没有/error文件夹，那么就会来到一开始我们看到的那个空白页面：

2.2 定制错误json数据

当是客户端访问出现错误时，是由控制器BasicErrorController的error方法来处理：

我们进入这个ResponseEntity对象不断往下挖，直到看到：

其实就是给header复制而已。 我们自定义一个异常处理类：

@ControllerAdvice
public class MyExceptionHandler {
    @ResponseBody
    @ExceptionHandler(UserNotExistException.class)
    public Map<String,Object> handleException(Exception e){
        Map<String,Object> map = new HashMap<>();
        map.put("code","user.notexist");
        map.put("message",e.getMessage());
        return map;
    }
}

注解@ControllerAdvice表示增强控制器，当出现异常时，如果是UserNotExistException异常，那么SpringBoot用MyExceptionHandler的handleException方法来处理，而不是找默认的错误处理控制器BasicErrorController。 上面这个方法只能返回json，如果要有自适应的效果，还能写成如下：

@ExceptionHandler(UserNotExistException.class)
public String handleException(Exception e, HttpServletRequest request){
	Map<String,Object> map = new HashMap<>();
    //传入我们自己的错误状态码  4xx 5xx，否则就不会进入定制错误页面的解析流程
    request.setAttribute("javax.servlet.error.status_code",500);
    map.put("code","user.notexist");
    map.put("message",e.getMessage());
    //转发到/error
    return "forward:/error";
}

我们用到的错误信息是默认的，如果要自定义，还可以完全写一个错误处理控制类，放在容器中。错误页面上的数据或者json的数据都是通过errorAttributes.getErrorAttributes得到的。如果我们没有定制，SpringBoot是默认从容器中找DefaultErrorAttributes.getErrorAttributes()进行处理的。 自定义ErrorAttributes：

@Component
public class MyErrorAttributes extends DefaultErrorAttributes {
    @Override
    public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes, boolean includeStackTrace) {
        Map<String, Object> map = super.getErrorAttributes(requestAttributes, includeStackTrace);
        map.put("author","klb");
        return map;
    }
}

到此这篇关于SpringBoot中的错误处理机制源码解析的文章就介绍到这了,更多相关SpringBoot错误处理机制内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！