Spring Boot定制错误响应

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

• 浏览器，返回一个默认的错误页面

浏览器发送请求的请求头

• 其他客户端，默认响应一个json数据

• 原理

SpringBoot中错误处理的类基本都由ErrorMvcAutoConfiguration来配置

1. ErrorPageCustomizer

ErrorMvcAutoConfiguration中有向IOC容器注入ErrorPageCustomizer的方法，同时它也是ErrorMvcAutoConfiguration的内部类

@Bean
public ErrorPageCustomizer errorPageCustomizer() {
	return new ErrorPageCustomizer(this.serverProperties, this.dispatcherServletPath);
}

private static class ErrorPageCustomizer implements ErrorPageRegistrar, Ordered {

	private final ServerProperties properties;

	private final DispatcherServletPath dispatcherServletPath;

	protected ErrorPageCustomizer(ServerProperties properties, DispatcherServletPath dispatcherServletPath) {
		this.properties = properties;
		this.dispatcherServletPath = dispatcherServletPath;
	}

	@Override
	public void registerErrorPages(ErrorPageRegistry errorPageRegistry) {
		ErrorPage errorPage = new ErrorPage(
					this.dispatcherServletPath.getRelativePath(this.properties.getError().getPath()));
		errorPageRegistry.addErrorPages(errorPage);
	}

	@Override
	public int getOrder() {
		return 0;
	}
}

this.properties.getError().getPath()：获取ErrorProperties类中path属性，该属性表示系统出现错误以后跳转的请求，能让对应的Controller处理

public class ErrorProperties {
	/**
	 * Path of the error controller.
	 */
	@Value("${error.path:/error}")
	private String path = "/error";
    
    ...
}

2. BasicErrorController

处理/error请求的Controller，也就是处理ErrorPageCustomizer配置的请求。BasicErrorController在ErrorMvcAutoConfiguration有向IOC注入的方法

@Bean
@ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT)
public BasicErrorController basicErrorController(ErrorAttributes errorAttributes) {
	return new BasicErrorController(errorAttributes, this.serverProperties.getError(), this.errorViewResolvers);
}

@Controller
//默认按server.error.path键获取配置，没有找到按error.path键寻找，还是没有就根据/error请求处理
@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);
	}

BasicErrorController类中一种是处理浏览器发送的请求，一种是客户端发送的请求（返回json）。

处理浏览器请求的方法中resolveErrorView方法用来获取ModelAndView视图对象，那么来分析一下它。

resolveErrorView方法定义在AbstractErrorController中，下面是源码：

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

在这里它遍历了IOC容器中所有ErrorViewResolver对象，并且这个视图就是由错误视图解析器解析获得的。

如果没有解析器可以解析，就返回null， 然后在BasicErrorController的errorHtml方法的最后new一个返回

return (modelAndView == null ? new ModelAndView("error", model) : modelAndView);

这也是为什么在不设置错误页面，会有一错误页面。

ErrorViewResolver是怎么解析的呢，下面来解析ErrorViewResolver。

• DefaultErrorViewResolver

ErrorViewResolver的实现类只有DefaultErrorViewResolver这一个类，并且在ErrorMvcAutoConfiguration中有向IOC注入的方法

@Bean
@ConditionalOnBean(DispatcherServlet.class)
@ConditionalOnMissingBean
public DefaultErrorViewResolver conventionErrorViewResolver() {
	return new DefaultErrorViewResolver(this.applicationContext, this.resourceProperties);
}

下面是DefaultErrorViewResolver的部分源码

public class DefaultErrorViewResolver implements ErrorViewResolver, Ordered {

	static {
		Map<Series, String> views = new EnumMap<>(Series.class);
		views.put(Series.CLIENT_ERROR, "4xx");
		views.put(Series.SERVER_ERROR, "5xx");
		SERIES_VIEWS = Collections.unmodifiableMap(views);
	}

        ...
        @Override
	public ModelAndView resolveErrorView(HttpServletRequest request, HttpStatus status, Map<String, Object> model) {
		ModelAndView modelAndView = resolve(String.valueOf(status.value()), 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);
	}

	private ModelAndView resolveResource(String viewName, Map<String, Object> model) {
                //遍历静态资源文件路径，并逐个根据视图名解析获取视图
		for (String location : this.resourceProperties.getStaticLocations()) {
			try {
				Resource resource = this.applicationContext.getResource(location);
				resource = resource.createRelative(viewName + ".html");
				if (resource.exists()) {
					return new ModelAndView(new HtmlResourceView(resource), model);
				}
			}
			catch (Exception ex) {
			}
		}
                //如果静态资源路径下没有找到，返回null
		return null;
	}
        ...
}   

根据SERIES_VIEWS.get(status.series())可以发现解析的地址是 状态码.html，并且先使用模板引擎解析，如果没有视图，就在静态资源路径下寻找，还是没有就返回null。

最后，解析视图时，还需要用到Map<String, Object> model这一对象，这个对象在浏览器请求和客户端请求中都调用是父类getErrorAttributes得到的。

Map<String, Object> model = Collections
				.unmodifiableMap(getErrorAttributes(request, isIncludeStackTrace(request, MediaType.TEXT_HTML)));

public abstract class AbstractErrorController implements ErrorController {
    private final ErrorAttributes errorAttributes;

    protected Map<String, Object> getErrorAttributes(HttpServletRequest request, boolean includeStackTrace) {
	    WebRequest webRequest = new ServletWebRequest(request);
	    return this.errorAttributes.getErrorAttributes(webRequest, includeStackTrace);
    }
        ...
}    

那么就来聊一聊这个ErrorAttributes的getErrorAttributes方法

• DefaultErrorAttributes

ErrorAttributes只有一个实现类DefaultErrorAttributes，且在ErrorMvcAutoConfiguration的方法中注入IOC容器中

@Bean
@ConditionalOnMissingBean(value = ErrorAttributes.class, search = SearchStrategy.CURRENT)
public DefaultErrorAttributes errorAttributes() {
	return new DefaultErrorAttributes(this.serverProperties.getError().isIncludeException());
}

下面是getErrorAttributes方法的源码

@Override
public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
	Map<String, Object> errorAttributes = new LinkedHashMap<>();
	errorAttributes.put("timestamp", new Date());
	addStatus(errorAttributes, webRequest);
	addErrorDetails(errorAttributes, webRequest, includeStackTrace);
	addPath(errorAttributes, webRequest);
	return errorAttributes;
}

在这里它放入了timestamp：时间戳，status：状态码，errorDetails：错误的一些信息包括异常消息，错误提示，数据校验的错误。

总结

一但系统出现4xx或者5xx之类的错误；ErrorPageCustomizer就会生效（定制错误的响应规则）发送/error请求；该请求会被BasicErrorController处理； BasicErrorController中有两种错误返回视图的方法，一种针对浏览器发送的请求，一种针对其他客户端，两种方法解析视图的方法都需要共享信息model，该model由DefaultErrorAttributes来获取，最后调用DefaultErrorViewResolver解析视图获取具体的视图对象。

 

2. 如何定制错误响应

• 如何定制错误的页面

1）、有模板引擎的情况下；error/状态码; 【将错误页面命名为 错误状态码.html 放在模板引擎文件夹里面的 error文件夹下】，发生此状态码的错误就会来到 对应的页面；

我们可以使用4xx和5xx作为错误页面的文件名来匹配这种类型的所有错误，精确优先（优先寻找精确的状态码.html）；

页面能获取的信息：timestamp：时间戳；status：状态码；error：错误提示；exception：异常对象；message：异常消息；errors：JSR303数据校验的错误都在这里

2）、没有模板引擎（模板引擎找不到这个错误页面），静态资源文件夹下找；

3）、以上都没有错误页面，就是默认来到SpringBoot默认的错误提示页面；

• 如何定制错误的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;
    }
}
//没有自适应效果...

 

2）、转发到/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）、将我们的定制数据携带出去

出现错误以后，会来到/error请求，会被BasicErrorController处理，响应出去可以获取的数据是由getErrorAttributes得到的（是AbstractErrorController（ErrorController）规定的方法）；

​ 1、完全来编写一个ErrorController的实现类【或者是编写AbstractErrorController的子类】，放在容器中；

​ 2、自定义ErrorAttributes，继承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("data","myData");
        return map;
    }
}