Spring Boot |错误处理机制

---

一、SpringBoot错误处理机制

1.1 默认错误处理

浏览器访问出现错误时，会返回一个默认的错误页面。

其他客户端访问出现错误，默认响应一个json数据。

{
	"timestamp":"2020-05-07T03:04:44.737+0000",
	"status":404,
	"error":"Not Found",
	"message":"No message available",
	"path":"/crud/aax"
}

如何区分是浏览器访问还是客户端访问?

原因在于浏览器和其他客户端的请求头的accept属性对html页面的请求优先级不同。

1.2 错误处理原理

一但系统出现4xx或者5xx之类的错误，ErrorPageCustomizer组件生效，会执行/error请求。被BasicErrorController处理，此时就会根据请求头的不同来判定返回是返回响应页面还是响应数据。

• 响应页面：去哪个页面是由DefaultErrorViewResolver解析得到的。

错误处理的自动配置原理可以参照ErrorMvcAutoConfiguration类，该类添加了下列组件：

1、DefaultErrorAttributes组件
作用：帮我们在页面共享信息、

源码：
public class DefaultErrorAttributes implements ErrorAttributes, HandlerExceptionResolver, Ordered {
	...
	@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;
	}
	...
}

2、BasicErrorController组件
作用：处理默认/error请求

源码:
@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {
	...
		//产生html类型的数据
		@RequestMapping(produces = MediaType.TEXT_HTML_VALUE)
	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) ? modelAndView : new ModelAndView("error", model);
	}
	
	//产生json类型的数据
	@RequestMapping
	public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
		HttpStatus status = getStatus(request);
		if (status == HttpStatus.NO_CONTENT) {
			return new ResponseEntity<>(status);
		}
		//ErrorAttributes的实现是DefaultErrorAttributes
		Map<String, Object> body = getErrorAttributes(request, isIncludeStackTrace(request, MediaType.ALL));
		return new ResponseEntity<>(body, status);
	}
	...
}
---------------------------------------------------------------------------------------------------------------------------
resolveErrorView:响应页面的源码:
	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;
	}

3、ErrorPageCustomizer组件
作用：定制错误的相应规则

系统出现错误以后，来到error请求进行处理。

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

4、DefaultErrorViewResolver组件
作用：

源码：
public class DefaultErrorViewResolver implements ErrorViewResolver, Ordered {
		...
		static {
			Map<Series, String> views = new EnumMap<>(Series.class);
			views.put(Series.CLIENT_ERROR, "4xx");//所有4开头的状态码
			views.put(Series.SERVER_ERROR, "5xx");//所有5开头的状态码
			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) {
				//模板引擎可用的情况下,返回到errorView指定的视图地址
				return new ModelAndView(errorViewName, model);
			}
			//模板引擎不可用,调用resolveResource方法
			return resolveResource(errorViewName, model);
		}
		private ModelAndView resolveResource(String viewName, Map<String, Object> model) {
		//该方法会在静态资源文件夹下找errorViewName对应的页面 error/404.html
		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) {
			}
		}
		return null;
	}
	...
}

二、定制错误页面(实现)

2.1 服务端:定制错误的页面

第一种情况:使用了模板引擎

使用了模板引擎的情况下，会去找error/状态码。我们只需要将错误页面命名为错误状态码.html，放在模板引擎文件夹下的error文件夹下，发生此状态码的错误就会来到对应的页面。

可以使用4xx和5xx作为错误页面的文件名来匹配这种类型的所有错误，原则是精确优先。

页面能获取的信息：

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

可以通过下面的方式在页面获取这些信息。

		<h1>status:[[${status}]]</h1>
		<h2>timestamp:[[${timestamp}]]</h2>
		<h2>exception:[[${exception}]]</h2>
		<h2>message:[[${message}]]</h2>
		<h2>ext:[[${ext.code}]]</h2>
		<h2>ext:[[${ext.message}]]</h2>

第二种情况:没有使用模板引擎

没有模板引擎(模板引擎找不到这个错误页面)，会在静态资源文件夹下找。

如果模板引擎文件夹下和静态资源文件夹下都没有错误页面，就默认来到SpringBoot的错误提示页面。

2.2 客户端:定制错误的json数据

写法一：自定义异常处理返回定制json数据。

• 缺点：没有自适应效果。

/**
 * 异常处理器
 */
@ControllerAdvice
public class MyExceptionHandler {

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

写法二：转发到/error进行自适应响应效果处理

• 需要手动设置状态码，否则不会进入定制错误页面的解析流程。

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

写法三：将我们的定制数据携带出去

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

(1)完全来编写一个ErrorController的实现类(或编写AbstractErrorController的子类)，放在容器中。

(2)页面上能用的数据，或者是json返回能用的数据都是通过errorAttributes.getErrorAttributes得到的。(第一种较为复杂，后文采用这种写法)

容器中DefaultErrorAttributes.getErrorAttributes()是默认进行数据处理的。
自定义ErrorAttributes

//为容器加入自己定义的ErrorAttributes
@Component
public class MyErrorAttributes extends DefaultErrorAttributes {

    //获取错误的属性
    //返回的map就是页面和json能获取的所有字段
    @Override
    public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
        Map<String, Object> map = super.getErrorAttributes(webRequest, includeStackTrace);
        map.put("company","gql");//添加公司标识
        //异常处理器携带的数据
        Map<String,Object> ext = (Map<String, Object>) webRequest.getAttribute("ext", 0);
        map.put("ext",ext);
        return map;
    }
}

在异常处理器中设置map的值。

/**
 * 异常处理器
 */
@ControllerAdvice
public class MyExceptionHandler {
    @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());
        request.setAttribute("ext",map);
        //转发到/error
        return "forward:/error";
    }
}

最终，响应是自适应的，可以通过定制ErrorAttributes改变需要返回的内容。