spring Boot2 —— 异常处理机制详细源码分析（附源码）

异常处理

文章目录

- 异常处理

一、错误处理

1、默认规则

（1）默认情况下，Spring Boot提供/error处理所有错误的映射
（2）对于机器客户端，它将生成JSON响应，其中包含错误，HTTP状态和异常消息的详细信息。对于浏览器客户端，响应一个“ whitelabel”错误视图，以HTML格式呈现相同的数据

在这里插入图片描述

（3）要对其进行自定义，添加View解析为error
（4）要完全替换默认行为，可以实现 ErrorController 并注册该类型的Bean定义，或添加ErrorAttributes类型的组件以使用现有机制但替换其内容。
（5）error/下的4xx，5xx页面会被自动解析；
在这里插入图片描述

2、源码分析

Spring Boot的异常处理过程分析，从ErrorMvcAutoConfiguration开始。
在这里插入图片描述
源码中最为核心的几个组件是：

DefaultErrorAttributes：
在这里插入图片描述
BasicErrorController：

ErrorPageCustomizer：

DefaultErrorViewResolver：

异常处理步骤：

（1）系统发生4xx或5xx错误时，ErrorPageCustomizer就会生效（定制错误的响应规则，获取配置文件中的error.path的值，如果没有配置，默认使用/error路径）即，系统出现错误后来到/error请求进行处理。
在这里插入图片描述
“/error” 请求则是由BasicErrorController处理：

BasicErrorController分别实现了html和JSON格式的返回数据，通过不同客户端发送请求头之间的区别实现自适应

浏览器发送的请求头是“Accept： text/html”；而客户端的请求头为“Accept: * / *”。

响应页面的处理：
根据HttpStatus去调用resolveErrorView选择相对应的视图和Model（页面内容）
在这里插入图片描述
具体去到那个页面则由DefaultErrorViewResolver解析得到：

public class DefaultErrorViewResolver implements ErrorViewResolver, Ordered {

	private static final Map<Series, String> SERIES_VIEWS;

	static {
		Map<Series, String> views = new EnumMap<>(Series.class);
		//4开头的页面都可匹配，如有精确匹配则匹配精确页面
		views.put(Series.CLIENT_ERROR, "4xx");
		//5开头的页面都可匹配，如有精确匹配则匹配精确页面
		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;
	}
//springboot默认去找 "error/" + viewName页面，如 "error/404"
	private ModelAndView resolve(String viewName, Map<String, Object> model) {
		String errorViewName = "error/" + viewName;
		//如果模板引擎可以解析这个地址就用模板引擎解析
		TemplateAvailabilityProvider provider = this.templateAvailabilityProviders.getProvider(errorViewName,
				this.applicationContext);
		if (provider != null) {
		//模板引擎可用的情况下返回到此视图，地址为errorViewName，内容为model
			return new ModelAndView(errorViewName, model);
		}
		//模板引擎不可用时则调用resolveResource
		return resolveResource(errorViewName, model);
	}

	private ModelAndView resolveResource(String viewName, Map<String, Object> model) {
		//从静态资源文件夹下找viewName对应的页面，如 "error/404"
		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;
	}

3、定制错误处理逻辑

（1）自定义错误页

如果存在模板引擎，将错误页面命名为错误状态码。html放在模板引擎文件夹里面的error文件夹下即可。页面可以获取到的信息：timestamp status error exception message errors
如果不存在模板引擎或找不到，则去静态资源文件夹下找，但是无法动态获取数据
如果都找不到对应的页面，则使用spring boot默认的空白页
error/404.html error/5xx.html；有精确的错误状态码页面就匹配精确，没有就找 4xx.html；如果都没有就触发白页

（2）统一异常处理相关注解介绍

@ControllerAdvice

声明在类上用于指定该类为控制增强器类，如果想声明返回的结果为 RESTFull 风格的数据，需要在声明 @ExceptionHandler 注解的方法上同时加上 @ResponseBody

@RestControllerAdvice

声明在类上用于指定该类为控制增强器类。并声明返回的结果为 RESTFull 风格的数据，无需在声明@ExceptionHandler 注解的方法上加@ResponseBody

@ExceptionHandler

声明在方法上用于指定需要统一拦截的异常。例如：@ExceptionHandler(value = Exception.class)

A. @ControllerAdvice+@ExceptionHandler处理全局异常；底层是 ExceptionHandlerExceptionResolver 支持的

B. @ResponseStatus+自定义异常；底层是 ResponseStatusExceptionResolver ，把response status注解的信息底层调用 response.sendError(statusCode, resolvedReason)；tomcat发送的/error。
在这里插入图片描述

C. Spring底层的异常，如：参数类型转换异常；DefaultHandlerExceptionResolver 处理框架底层的异常。

response.sendError(HttpServletResponse.SC_BAD_REQUEST, ex.getMessage());

（3）ErrorViewResolver 实现自定义处理异常；

response.sendError ，error请求就会转给controller
你的异常没有任何人能处理。tomcat底层 response.sendError。error请求就会转给controller
basicErrorController 要去的页面地址是 ErrorViewResolver

[案例]：

@Data
@AllArgsConstructor
public class Result {
    private boolean success;
    private String code;
    private String message;
    private Object data;
    public Result() {
        this.success = true;
        this.code = "200";
    }
}

/**
 * @Author m.kong
 * @Date 2021/3/25 上午9:49
 * @Version 1
 * @Description 自定义异常
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
public class MyException extends RuntimeException {
    /**
     * 异常状态码
     */
    private String errCode;
    /**
     * 异常信息
     */
    private String errMsg;
    /**
     * 异常详细描述
     */
    private String errDesc;
    /**
     * 发生的地方（方法）
     */
    private String errMethod;
}

/**
 * @Author m.kong
 * @Date 2021/3/25 上午9:50
 * @Version 1
 * @Description 全局异常配置
 */
public class ExceptionAdviceConfig {
    /**
     * 全局异常处理
     * @return result
     */
    @ResponseBody
    @ExceptionHandler(value = Exception.class)
    public Result exceptionHandle(Exception e){
        Result result = new Result();
        result.setCode("201");
        result.setSuccess(false);
        result.setMessage(e.getMessage());
        //异常业务逻辑处理（日志记录或者其他存储）

        return result;
    }

    /**
     * 自定义异常处理
     */
    @ResponseBody
    @ExceptionHandler(value = MyException.class)
    public Result exceptionHandle(MyException exception){
        Result result = new Result();
        result.setCode(exception.getErrCode());
        // 打印出详细信息
        result.setData(exception.getErrDesc());
        result.setSuccess(false);
        result.setMessage(exception.getErrMsg());
        return result;
    }

}

/**
 * @Author m.kong
 * @Date 2021/3/25 上午9:45
 * @Version 1
 * @Description
 */
@RestController
public class ExceptionController {

    @RequestMapping(value = "/test",method = RequestMethod.GET)
    public Result test1() throws Exception {
        throw new Exception("haha");
    }

    @RequestMapping(value = "/test2",method = RequestMethod.GET)
    @ResponseBody
    public Result test2() {
        throw new MyException("201","测试异常保持","testOne","desc");
    }
}

二、异常处理自动配置原理

1、自动配置异常处理规则

（1）容器中的组件

类型：DefaultErrorAttributes -> id：errorAttributes

public class DefaultErrorAttributes implements ErrorAttributes, HandlerExceptionResolver

DefaultErrorAttributes：定义错误页面中可以包含哪些数据。

在这里插入图片描述

（2）容器中的组件：

类型：BasicErrorController --> id：basicErrorController（json+白页适配响应）

处理默认 /error 路径的请求；页面响应 new ModelAndView(“error”, model)；
容器中有组件 View->id是error；（响应默认错误页）
容器中放组件 BeanNameViewResolver（视图解析器）；按照返回的视图名作为组件的id去容器中找View对象。

（3）容器中的组件：

类型：DefaultErrorViewResolver -> id：conventionErrorViewResolver

如果发生错误，会以HTTP的状态码作为视图页地址（viewName），找到真正的页面
error/404、5xx.html

2、异常处理步骤流程

（1）执行目标方法，目标方法运行期间有任何异常都会被catch、而且标志当前请求结束；并且用 dispatchException

（2）进入视图解析流程（页面渲染？）

processDispatchResult(processedRequest, response, mappedHandler, mv, dispatchException);

（3）mv = processHandlerException；处理handler发生的异常，处理完成返回ModelAndView；

遍历所有的 handlerExceptionResolvers，看谁能处理当前异常[HandlerExceptionResolver处理器异常解析器]
系统默认的异常解析器；
a. DefaultErrorAttributes先来处理异常。把异常信息保存到rrequest域，并且返回null；
b. 默认没有任何人能处理异常，所以异常会被抛出
- 如果没有任何人能处理最终底层就会发送 /error 请求。会被底层的BasicErrorController处理
- 解析错误视图；遍历所有的 ErrorViewResolver 看谁能解析。
- 默认的 DefaultErrorViewResolver ,作用是把响应状态码作为错误页的地址，error/500.html
- 模板引擎最终响应这个页面 error/500.html