Spring Boot的错误处理机制

1、Spring Boot默认的错误处理机制

1）浏览器访问，返回一个默认的错误处理页面

2）如果是其他客户端访问，返回JSON格式的数据

3）原理

  查看ErrorMvcAutoConfiguration类，发现添加了如下4个组件：

• ErrorPageCustomizer
• BasicErrorController
• DefaultErrorAttributes
• DefaultErrorViewResolver

实现步骤：

【1】ErrorPageCustomizer

  一旦系统出现4xx或者5xx之类的错误，ErrorPageCustomizer就会生效(定制错误的响应规则)，就会来到/error请求

/**
 * Path of the error controller.
 * 作用：系统出现错误以后，来到/error请求进行处理
 * 相当于在web.xml中注册的错误页面规则
 */
@Value("${error.path:/error}")
private String path = "/error";

【2】BasicErrorController

  来到/error请求后，就会被BasicErrorController处理，她里面有两种处理机制

@Controller
@RequestMapping("${server.error.path:${error.path:/error}}")
public class BasicErrorController extends AbstractErrorController {
    //1.产生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 modelAndView = resolveErrorView(request, response, status, model);
		return (modelAndView != null) ? modelAndView : new ModelAndView("error", model);
	}

    //2.产生JSON格式的数据
	@RequestMapping
	public ResponseEntity<Map<String, Object>> error(HttpServletRequest request) {
		HttpStatus status = getStatus(request);
		if (status == HttpStatus.NO_CONTENT) {
			return new ResponseEntity<>(status);
		}
		Map<String, Object> body = getErrorAttributes(request, isIncludeStackTrace(request, MediaType.ALL));
		return new ResponseEntity<>(body, status);
	}
}

注意：同样都是/error请求，怎么区分是浏览器还是客户端发请求呢?

  主要是通过请求头中的Accept来区分：

  【1】浏览器发请求：

  【2】客户端发请求：

【2.1】响应页面处理实现代码

/**
	 * Resolve any specific error views. By default this method delegates to
	 * {@link ErrorViewResolver ErrorViewResolvers}.
	 * @param request the request
	 * @param response the response
	 * @param status the HTTP status
	 * @param model the suggested model
	 * @return a specific {@link ModelAndView} or {@code null} if the default should be
	 * used
	 * @since 1.4.0
	 */
	protected ModelAndView resolveErrorView(HttpServletRequest request, HttpServletResponse response, HttpStatus status,
			Map<String, Object> model) {
			//拿到所有的异常处理解析器（ErrorViewResolver ），如果得到了就返回modelAndView，得不到就返回null
		for (ErrorViewResolver resolver : this.errorViewResolvers) {
			ModelAndView modelAndView = resolver.resolveErrorView(request, status, model);
			if (modelAndView != null) {
				return modelAndView;
			}
		}
		return null;
	}

响应页面去哪个页面是由DefaultErrorViewResolver解析后得到的

@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) {
	   //Spring Boot默认去找一个页面(error/状态码)
		String errorViewName = "error/" + viewName;
		//模板引擎能够解析页面地址就用模板引擎解析
		TemplateAvailabilityProvider provider = this.templateAvailabilityProviders.getProvider(errorViewName,
				this.applicationContext);
		if (provider != null) {//模板引擎可用的情况下返回errorViewName指定的ModelAndView
			return new ModelAndView(errorViewName, model);
		}
		//模板引擎不可用的情况下，就到静态资源文件夹下寻找errorViewName对应的页面
		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()) {//如果静态资源文件夹下有error/状态码.html就进行解析返回ModelAndView
					return new ModelAndView(new HtmlResourceView(resource), model);
				}
			}
			catch (Exception ex) {
			}
		}
        //如果没有，返回null
		return null;
	}

2、如何定制错误响应

【1】如何定制错误页面

• 有模板引擎的情况下：error/状态码。将错误页面命名为状态码.html放到模板引擎的error目录下，发生该状态码的错误，就会来到相应的错误页面。

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

  另外，我们可以使用4xx或者5xx作为错误信息处理页面的文件名来匹配所有以4或者5开头的错误，但精确优先。

错误信息页面能获取到的信息：

  【1】timestamp：时间戳
  【2】status：状态码
  【3】error：错误提示
  【4】exception：异常对象
  【5】message：异常消息
  【6】errors：JSR303数据校验的错误

• 模板引擎中找不到错误页面，在静态资源文件夹下找。
• 以上都没有，默认来到Spring Boot的错误提示页面。

【2】如何定制错误的JSON数据

【2.1】自定义异常处理，返回定制的JSON数据

@ControllerAdvice
public class MyExceptionHandler {
 @ResponseBody
 @ExceptionHandler(UserNotExistsException.class)
 public Map<String,Object> exceptionHandler(Exception ex){
    HashMap<String, Object> map = new HashMap<>();
    map.put("status",500);
    map.put("message",ex.getMessage());
    map.put("cause",ex.getCause());
    return map;
 }
}

缺点： 不能自适应，浏览器与客户端请求返回的都是JSON类型的数据。

【2.2】转发到/error进行自适应效果

   //@ResponseBody  【1】去掉@ResponseBody 注解
    @ExceptionHandler(UserNotExistsException.class)
    public String exceptionHandler(Exception ex, HttpServletRequest req){
        //设置状态码
        req.setAttribute("javax.servlet.error.status_code",500);
        //【2】设置响应的JSON数据
        HashMap<String, Object> map = new HashMap<>();
        map.put("message",ex.getMessage());
        map.put("cause",ex.getCause());
        //【3】请求转发到/error
        return "forward:/error";
    }

注意：一定要传入自己的状态码，否则使用的是Spring Boot的默认错误页面。

【2.3】既要能自适应效果还能将定制的数据携带出去

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

方法一：完全手动地编写一个ErrorController的实现类(或者编写AbstractErrorController)的子类，然后将该类放入容器中。(麻烦)

方法二：在错误页面显示的数据或者是通过JSON显示的数据都是通过errorAttributes.getErrorAttributes(webRequest, includeStackTrace);得到的。容器中的DefaultErrorAttributes.getErrorAttributes()；默认进行数据处理。

自定义的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("path","http://localhost:8080/crud/aa");
        Map<String,Object> ext = (Map<String, Object>) webRequest.getAttribute("ext", 0);
        map.put("ext",ext);
        return map;
    }
}

自定义的异常处理器：

@ControllerAdvice
public class MyExceptionHandler {
    //@ResponseBody
    @ExceptionHandler(UserNotExistsException.class)
    public String exceptionHandler(Exception ex, HttpServletRequest req){
        //设置状态码
        req.setAttribute("javax.servlet.error.status_code",500);
        //设置响应的JSON数据
        HashMap<String, Object> map = new HashMap<>();
        map.put("type","UserNotExistsException");
        //将我们自己额外添加的数据也添加到错误页面上
        req.setAttribute("ext",map);
        //请求转发到/error
        return "forward:/error";
    }
  }

webRequest.getAttribute((String var1, int var2)的使用：

  int SCOPE_REQUEST = 0;
  int SCOPE_SESSION = 1;
  String REFERENCE_REQUEST = "request";
  String REFERENCE_SESSION = "session";

  @Nullable
  Object getAttribute(String var1, int var2);
  void setAttribute(String var1, Object var2, int var3);

效果：响应是自适应的，返回的内容可以通过ErrorAttributes定制。