SpringBoot的错误处理机制

梦里梦外; 2024-04-18 10:47 80阅读 0赞

本篇博文结合SpringBoot的源码，简单分析下SpringBoot的错误处理机制。

### 1.SpringBoot默认错误处理机制 ###

我们在项目报错时经常会遇到错误的默认页面，其实SpringBoot的错误默认响应分为两种情况：  
1.浏览器，会返回一个默认的错误页面  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTUwMTY0NA_size_16_color_FFFFFF_t_70]2.如果时其他客户端（这里用的是PostMan），会默认返回一段json数据  
![在这里插入图片描述][20190905162839879.png]  
那么问题来了，SpringBoot为什么会对这两者的同一个请求响应不同的内容呢？  
这是因为浏览器的请求头和其他客户端的请求头存在差异，如下：  
![这是浏览器发出错误请求的请求头][20190905163224267.png]  
![其他客户端的请求头][20190905163334835.png]  
通过上面两图可以看出，浏览器的请求头默认接收的是“text/html"类型的数据，所以SpringBoot会返回一个页面  
而其他客户端默认接收的类型是”*/*" 。我们不难推测，SpringBoot底层会针对这两种格式响应不同的内容。下面就从源码中的几个与错误机制相关的组建来分析SpringBoot是如何做到的。（可以参照ErrorMvcAutoConfiguration自动配置类）  
（1）DefaultErrorAttributes 默认错误页面的元素，这个组件封装了错误响应的信息，标记下，因为后面还会用到这个哦

@Override
    public Map<String, Object> getErrorAttributes(RequestAttributes requestAttributes,
    boolean includeStackTrace) {
    Map<String, Object> errorAttributes = new LinkedHashMap<String, Object>();
    //添加页面需要显示的错误信息
    errorAttributes.put("timestamp", new Date());
    addStatus(errorAttributes, requestAttributes);
    addErrorDetails(errorAttributes, requestAttributes, includeStackTrace);
    addPath(errorAttributes, requestAttributes);
    return errorAttributes;
    }

（2）BasicErrorController 处理默认/error请求

@Controller
    @RequestMapping("${server.error.path:${error.path:/error}}")
    public class BasicErrorController extends AbstractErrorController {
    	@RequestMapping(produces = "text/html")//产生html类型的数据；浏览器发送的请求来到这个方法处理
    	public ModelAndView errorHtml(HttpServletRequest request,HttpServletResponse response) {
    		HttpStatus status = getStatus(request);
    		Map<String, Object> model = Collections.unmodifiableMap(getErrorAttributes(request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));
    		response.setStatus(status.value());
    		//去哪个页面作为错误页面；包含页面地址和页面内容
    		ModelAndView modelAndView = resolveErrorView(request, response, status, model);
    		return (modelAndView == null ? new ModelAndView("error", model) : modelAndView);
    	}
    	@RequestMapping
    	@ResponseBody //产生json数据，其他客户端来到这个方法处理
    	public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
    		Map<String, Object> body = getErrorAttributes(request,isIncludeStackTrace(request, MediaType.ALL));
    		HttpStatus status = getStatus(request);
    		return new ResponseEntity<Map<String, Object>>(body, status);
    }

（3）ErrorPageCustomizer 错误页面定制器

//系统出现错误以后使系统发出/error请求进行处理；（相当于web.xml注册的错误页面规则）
    @Value("${error.path:/error}")
    private String path = "/error";

（4）DefaultErrorViewResolver

@Override
    public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status,Map<String, Object> model) {
    	ModelAndView modelAndView = resolve(String.valueOf(status), model);
    	if (modelAndView == null && SERIES_VIEWS.containsKey(status.series())) {
    	modelAndView = resolve(SERIES_VIEWS.get(status.series()), model);
    	} 
    	return modelAndView;
    } 
    
    private ModelAndView resolve(String viewName, Map<String, Object> model) {
    	//默认SpringBoot可以去找到一个页面如： error/404
    	String errorViewName = "error/" + viewName;
    	//模板引擎可以解析这个页面地址就用模板引擎解析
    	TemplateAvailabilityProvider provider = this.templateAvailabilityProviders.getProvider(errorViewName, this.applicationContext);
    	if (provider != null) {
    	//模板引擎可用的情况下返回到errorViewName指定的视图地址
    	return new ModelAndView(errorViewName, model);
    	}
    	//模板引擎不可用，就在静态资源文件夹下找errorViewName对应的页面 error/404.html
    	return resolveResource(errorViewName, model);
    }

步骤：  
一但系统出现4xx或者5xx之类的错误；ErrorPageCustomizer就会生效（定制错误的响应规则）；就会来到/error  
请求；就会被BasicErrorController处理；去哪个页面是由DefaultErrorViewResolver解析得到的：

protected ModelAndView resolveErrorView(HttpServletRequest request,HttpServletResponse response, HttpStatus status, Map<String, Object> model) {
    	//所有的ErrorViewResolver得到ModelAndView
    	for (ErrorViewResolver resolver : this.errorViewResolvers) {
    		ModelAndView modelAndView = resolver.resolveErrorView(request, status, model);
    		if (modelAndView != null) {
    			return modelAndView;
    		}
    	} 
    	return null;
    }

如上代码所示，DefaultErrorViewResolver会遍历容器中的所有视图解析器得到ModelAndView，这就意味着我们可以自定义错误页面来代替默认的。

### 2.如何定制错误响应 ###

（1）响应错误页面  
1）、有模板引擎的情况下；error/状态码; 【将错误页面命名为 错误状态码.html 放在模板引擎文件夹里面的error文件夹下】，发生此状态码的错误就会来到 对应的页面；  
我们可以使用4xx和5xx作为错误页面的文件名来匹配这种类型的所有错误，精确优先（优先寻找精确的状态码.html）；  
页面能获取的信息；  
timestamp：时间戳  
status：状态码  
error：错误提示  
exception：异常对象  
message：异常消息  
errors：JSR303数据校验的错误都在这里  
2）、没有模板引擎（模板引擎找不到这个错误页面），静态资源文件夹下找；  
3）、以上都没有错误页面，就是默认来到SpringBoot默认的错误提示页面；  
（2）响应错误json串  
1）、自定义异常处理&返回定制json数据；

@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;
    	}
    }

如上，我们可以自定义异常处理controller，但是这并没有自适应的效果（不能根据浏览器或者客户端发出的请求来响应不同的内容），我们只能返回json，因为我们加了@ResponseBody注解  
2）基于上面的SpringBoot的错误处理机制，我们可以转发到/error进行自适应响应效果处理：

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

3）但是这样又出现了一个问题，我们不能将我们自定义的错误信息加载到响应内容中去。那么如何在自适应的前提下将我们想要的数据带入呢？我们先梳理下SpringBoot的错误机制：  
出现错误以后，会来到/error请求，会被BasicErrorController处理，响应出去可以获取的数据是由getErrorAttributes得到的（是AbstractErrorController（ErrorController）规定的方法）；  
1、完全来编写一个ErrorController的实现类【或者是编写AbstractErrorController的子类】，放在容器中；  
2、页面上能用的数据，或者是json返回能用的数据都是通过errorAttributes.getErrorAttributes得到；容器中DefaultErrorAttributes.getErrorAttributes()；默认进行数据处理的；还记的上面做的标记吗？所以我们完全不用来编写ErrorController的实现类，完全可以自定义ErrorAttributes！

//给容器中加入我们自己定义的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("company","atguigu");
    		return map;
    	}
    }

最终的效果：响应是自适应的，可以通过定制ErrorAttributes改变需要返回的内容  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTUwMTY0NA_size_16_color_FFFFFF_t_70 1]以上就是对SpringBoot的错误机制的分析，记录分享！

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTUwMTY0NA_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/de522dbc6c5e4567a51e014595a66505.png
[20190905162839879.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/7e46b98b7ceb498b89a07ee1e858901c.png
[20190905163224267.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/4f071bdb4b5f4307863eac3d6f0d2e83.png
[20190905163334835.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/70b7410966eb4ac888b4e756b06fea0b.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3dlaXhpbl80MTUwMTY0NA_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/18/3f7deb74a8b54c93854c8206c3d9dea0.png