错误处理原理（自动配置解析篇）

最新推荐文章于 2023-04-07 11:25:53 发布
最新推荐文章于 2023-04-07 11:25:53 发布
阅读量803 收藏
点赞数
分类专栏： SpringBoot2 文章标签： 错误处理 自动配置 默认错误视图 错误视图解析器
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/qzw752890913/article/details/122568678
版权

文章目录

ErrorMvcAutoConfiguration里自动配置了异常处理规则。

DefaultErrorAttributes

ErrorMvcAutoConfiguration往容器中放入了一个DefaultErrorAttributes类型的组件，组件id为errorAttributes（即方法名为组件id）。

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

DefaultErrorAttributes决定了响应中会包含哪些内容，如status、error、path、timestamp等。
DefaultErrorAttributes也实现了接口类HandlerExceptionResolver，因此也是一个处理器异常解析器。

public class DefaultErrorAttributes implements ErrorAttributes, HandlerExceptionResolver, Ordered {

	@Override
	public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler,
			Exception ex) {
		storeErrorAttributes(request, ex);
		return null;
	}

	private void storeErrorAttributes(HttpServletRequest request, Exception ex) {
		request.setAttribute(ERROR_INTERNAL_ATTRIBUTE, ex);
	}

	@Override
	public Map<String, Object> getErrorAttributes(WebRequest webRequest, ErrorAttributeOptions options) {
		Map<String, Object> errorAttributes = getErrorAttributes(webRequest, options.isIncluded(Include.STACK_TRACE));
		if (!options.isIncluded(Include.EXCEPTION)) {
			errorAttributes.remove("exception");
		}
		if (!options.isIncluded(Include.STACK_TRACE)) {
			errorAttributes.remove("trace");
		}
		if (!options.isIncluded(Include.MESSAGE) && errorAttributes.get("message") != null) {
			errorAttributes.remove("message");
		}
		if (!options.isIncluded(Include.BINDING_ERRORS)) {
			errorAttributes.remove("errors");
		}
		return errorAttributes;
	}

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

	private void addStatus(Map<String, Object> errorAttributes, RequestAttributes requestAttributes) {
		Integer status = getAttribute(requestAttributes, RequestDispatcher.ERROR_STATUS_CODE);
		if (status == null) {
			errorAttributes.put("status", 999);
			errorAttributes.put("error", "None");
			return;
		}
		errorAttributes.put("status", status);
		try {
			errorAttributes.put("error", HttpStatus.valueOf(status).getReasonPhrase());
		}
		catch (Exception ex) {
			// Unable to obtain a reason
			errorAttributes.put("error", "Http Status " + status);
		}
	}

	private void addErrorDetails(Map<String, Object> errorAttributes, WebRequest webRequest,
			boolean includeStackTrace) {
		Throwable error = getError(webRequest);
		if (error != null) {
			while (error instanceof ServletException && error.getCause() != null) {
				error = error.getCause();
			}
			errorAttributes.put("exception", error.getClass().getName());
			if (includeStackTrace) {
				addStackTrace(errorAttributes, error);
			}
		}
		addErrorMessage(errorAttributes, webRequest, error);
	}

	private void addErrorMessage(Map<String, Object> errorAttributes, WebRequest webRequest, Throwable error) {
		BindingResult result = extractBindingResult(error);
		if (result == null) {
			addExceptionErrorMessage(errorAttributes, webRequest, error);
		}
		else {
			addBindingResultErrorMessage(errorAttributes, result);
		}
	}

	private void addExceptionErrorMessage(Map<String, Object> errorAttributes, WebRequest webRequest, Throwable error) {
		errorAttributes.put("message", getMessage(webRequest, error));
	}

	protected String getMessage(WebRequest webRequest, Throwable error) {
		Object message = getAttribute(webRequest, RequestDispatcher.ERROR_MESSAGE);
		if (!ObjectUtils.isEmpty(message)) {
			return message.toString();
		}
		if (error != null && StringUtils.hasLength(error.getMessage())) {
			return error.getMessage();
		}
		return "No message available";
	}

	private void addBindingResultErrorMessage(Map<String, Object> errorAttributes, BindingResult result) {
		errorAttributes.put("message", "Validation failed for object='" + result.getObjectName() + "'. "
				+ "Error count: " + result.getErrorCount());
		errorAttributes.put("errors", result.getAllErrors());
	}

	private BindingResult extractBindingResult(Throwable error) {
		if (error instanceof BindingResult) {
			return (BindingResult) error;
		}
		return null;
	}

	private void addStackTrace(Map<String, Object> errorAttributes, Throwable error) {
		StringWriter stackTrace = new StringWriter();
		error.printStackTrace(new PrintWriter(stackTrace));
		stackTrace.flush();
		errorAttributes.put("trace", stackTrace.toString());
	}

	private void addPath(Map<String, Object> errorAttributes, RequestAttributes requestAttributes) {
		String path = getAttribute(requestAttributes, RequestDispatcher.ERROR_REQUEST_URI);
		if (path != null) {
			errorAttributes.put("path", path);
		}
	}

	@Override
	public Throwable getError(WebRequest webRequest) {
		Throwable exception = getAttribute(webRequest, ERROR_INTERNAL_ATTRIBUTE);
		if (exception == null) {
			exception = getAttribute(webRequest, RequestDispatcher.ERROR_EXCEPTION);
		}
		// store the exception in a well-known attribute to make it available to metrics
		// instrumentation.
		webRequest.setAttribute(ErrorAttributes.ERROR_ATTRIBUTE, exception, WebRequest.SCOPE_REQUEST);
		return exception;
	}

	@SuppressWarnings("unchecked")
	private <T> T getAttribute(RequestAttributes requestAttributes, String name) {
		return (T) requestAttributes.getAttribute(name, RequestAttributes.SCOPE_REQUEST);
	}

}
BasicErrorController

ErrorMvcAutoConfiguration往容器中放了一个BasicErrorController类的组件，组件id为basicErrorController。

@Bean
@ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT)
public BasicErrorController basicErrorController(ErrorAttributes errorAttributes,
		ObjectProvider<ErrorViewResolver> errorViewResolvers) {
	return new BasicErrorController(errorAttributes, this.serverProperties.getError(),
			errorViewResolvers.orderedStream().collect(Collectors.toList()));
}

BasicErrorController的定义如下。

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

	@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, getErrorAttributeOptions(request, MediaType.ALL));
		return new ResponseEntity<>(body, status);
	}
}

@RequestMapping("${server.error.path:${error.path:/error}}")，控制器BasicErrorController可以处理的请求映射是：server.error.path或error.path或/error，默认是/error。
如果是浏览器客户端，则调用BasicErrorController#errorHTML方法进行处理，返回一个HTML格式的错误视图；如果是机器客户端，则调用BasicErrorController#error方法进行处理，返回一个JSON数据。

WhitelabelErrorViewConfiguration
@Configuration(proxyBeanMethods = false)
@ConditionalOnProperty(prefix = "server.error.whitelabel", name = "enabled", matchIfMissing = true)
@Conditional(ErrorTemplateMissingCondition.class)
protected static class WhitelabelErrorViewConfiguration {

	private final StaticView defaultErrorView = new StaticView();

	@Bean(name = "error")
	@ConditionalOnMissingBean(name = "error")
	public View defaultErrorView() {
		return this.defaultErrorView;
	}

	// If the user adds @EnableWebMvc then the bean name view resolver from
	// WebMvcAutoConfiguration disappears, so add it back in to avoid disappointment.
	@Bean
	@ConditionalOnMissingBean
	public BeanNameViewResolver beanNameViewResolver() {
		BeanNameViewResolver resolver = new BeanNameViewResolver();
		resolver.setOrder(Ordered.LOWEST_PRECEDENCE - 10);
		return resolver;
	}
}

往容器中放入了一个View类的组件，组件id为error。（默认错误视图）
往容器中放入了一个BeanNameViewResolver类的组件，组件id为beanNameViewResolver，它可以根据组件id解析视图。（用于解析 默认错误视图的 视图解析器）

默认错误视图是StaticView类，StaticView定义如下。
render方法中就是“whitelabel”错误视图的渲染过程。

private static class StaticView implements View {
	//...
	@Override
	public void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response)
			throws Exception {
		if (response.isCommitted()) {
			String message = getMessage(model);
			logger.error(message);
			return;
		}
		response.setContentType(TEXT_HTML_UTF8.toString());
		StringBuilder builder = new StringBuilder();
		Object timestamp = model.get("timestamp");
		Object message = model.get("message");
		Object trace = model.get("trace");
		if (response.getContentType() == null) {
			response.setContentType(getContentType());
		}
		builder.append("<html><body><h1>Whitelabel Error Page</h1>").append(
				"<p>This application has no explicit mapping for /error, so you are seeing this as a fallback.</p>")
				.append("<div id='created'>").append(timestamp).append("</div>")
				.append("<div>There was an unexpected error (type=").append(htmlEscape(model.get("error")))
				.append(", status=").append(htmlEscape(model.get("status"))).append(").</div>");
		if (message != null) {
			builder.append("<div>").append(htmlEscape(message)).append("</div>");
		}
		if (trace != null) {
			builder.append("<div style='white-space:pre-wrap;'>").append(htmlEscape(trace)).append("</div>");
		}
		builder.append("</body></html>");
		response.getWriter().append(builder.toString());
	}
	//...
}
DefaultErrorViewResolverConfiguration
@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties({ WebProperties.class, WebMvcProperties.class })
static class DefaultErrorViewResolverConfiguration {

	private final ApplicationContext applicationContext;

	private final Resources resources;

	DefaultErrorViewResolverConfiguration(ApplicationContext applicationContext, WebProperties webProperties) {
		this.applicationContext = applicationContext;
		this.resources = webProperties.getResources();
	}

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

}

往容器中放了一个DefaultErrorViewResolver类的组件，id为conventionErrorViewResolver。（错误视图解析器）

@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties({ WebProperties.class, WebMvcProperties.class })
static class DefaultErrorViewResolverConfiguration {
	//...
	@Bean
	@ConditionalOnBean(DispatcherServlet.class)
	@ConditionalOnMissingBean(ErrorViewResolver.class)
	DefaultErrorViewResolver conventionErrorViewResolver() {
		return new DefaultErrorViewResolver(this.applicationContext, this.resources);
	}
}

DefaultErrorViewResolver的定义如下。

public class DefaultErrorViewResolver implements ErrorViewResolver, Ordered {

	private static final Map<Series, String> SERIES_VIEWS;

	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) {
		String errorViewName = "error/" + viewName;
		TemplateAvailabilityProvider provider = this.templateAvailabilityProviders.getProvider(errorViewName,
				this.applicationContext);
		if (provider != null) {
			return new ModelAndView(errorViewName, model);
		}
		return resolveResource(errorViewName, model);
	}

	private ModelAndView resolveResource(String viewName, Map<String, Object> model) {
		for (String location : this.resources.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;
	}
}

"error/"+String.valueOf(status.value())，这也是为什么自定义错误页面时，要在error目录下放4xx.html或5xx.html视图文件。

richest_qi
关注
专栏目录
SpringBoot自动装配原理，这一篇就够了！
CC_且听风吟丶的博客
05-08 8万+
有关SpringBoot自动装配原理，你需要知道的一切。
错排原理
Ordinarv
08-21 584
错排问题 考虑一个有n个元素的排列，若一个排列中所有的元素都不在自己原来的位置上，那么这样的排列就称为原排列的一个错排。 n个元素的错排数记为Dn。 递推公式：Dn=(n-1)(Dn-1+Dn-2)  n&gt;3, D1 = 0 , D2 = 1; 例题 HDU1465-装信封   写n封信，全部装错信封，求有多少种全部装错的方式 #include&lt;bits/stdc++.h&...
Spring boot Web MVC : 缺省错误属性处理工具 DefaultErrorAttributes
Details Inside Spring
04-05 3317
DefaultErrorAttributes是Spring boot缺省提供的从Web Servlet请求中获取错误属性的工具。这里所指的Web Servlet请求应该是一个对错误处理页面的请求。 当一个用户请求处理过程中出现错误时，Servlet容器会构造并触发(forward)一个对错误处理页面的请求，并将如下信息作为对错误处理页面请求的属性 : javax.servlet.error.re...
Springboot全局异常处理
程序三两行
11-26 3669
springboot默认发生4xx错误时候，pc端响应的页面如下如果是移动端（手机端）将会响应json格式的数据，如下。
DefaultErrorAttributes
baidu_41634343的博客
03-25 3335
DefaultErrorAttributes记录一下在项目中的使用。 在做项目时前端要优化代码，让后端抛出的异常以固定的状态格式返回，所以使用了DefaultErrorAttributes。 DefaultErrorAttributes源代码 // // Source code recreated from a .class file by IntelliJ IDEA // (powered by...
自定义异常信息
gt1432173469的博客
06-27 1129
默认情况下，在Spring Boot 中，所有的异常数据其实就是上文所展示出来的5条数据，这5条数据定义在 org.springframework.boot.web.reactive.error.DefaultErrorAttributes 类中，具体定义在 getErrorAttributes 方法中 ： @Override public Map<String, Object> getErrorAttributes(ServerRequest request,
Springboot错误处理机制实现原理解析
08-19
"Springboot错误处理机制实现原理解析" Springboot错误处理机制是指在Springboot框架中，处理错误和异常的机制。该机制主要通过ErrorMvcAutoConfiguration自动配置实现，默认情况下，Springboot会返回一个空白页面...
SpringBoot自动配置原理分析.7z
04-27
例如，它会自动配置视图解析器、静态资源处理、错误处理等。 10. **数据访问配置** 自动配置还涵盖了数据访问层，如JDBC、JPA、MongoDB等。它会根据存在的依赖自动配置数据源、事务管理器以及相应的模板类。 通过...
Go-HOCON配置格式解析器
08-13
Go开发-配置解析库标签意味着这个解析器是专为Go语言开发者设计的，提供了方便的API来读取和处理HOCON格式的配置。通常，这样的库会包含以下功能： 1. **解析器接口**：提供一个简单的API，使得开发者能够轻松地...
配置文件解析器
12-09
配置文件解析器是一种工具，主要...在给定的“iniconfig”库中，可能提供了更高级的功能，如错误处理、类型转换等，以适应不同项目的需求。对于任何涉及配置管理的项目，理解并熟练使用配置文件解析器都是十分必要的。
SpringBoot—异常处理
weixin_57128596的博客
02-06 764
错误处理： 首先，我们应该知道异常的返回应当像ModelAndView，返回数据+视图：数据就是异常信息； 怎样操作： 1.在templates下建一个error文件，里面放入5xx.html与4xx.html等页面，它们会代替默认的异常处理行为 ...
【技术方案】springboot全局异常处理方式
qiuxuezhe_fei的博客
01-18 517
springboot全局异常处理方式
SpringBoot错误处理机制
木讷的鱼
10-27 358
浅谈SpringBoot错误处理机制一. DefaultErrorAttributes二. BasicErrorController三. ErrorPageCustomizer四. DefaultErrorViewResolver五. 如何自定义错误响应页面5.1 如何定制错误页面5.2 如何定制返回的Json数据 SpringBoot错误处理的自动配置由ErrorMvcAutoConfiguration提供，所以我们从对此类的分析入手研究错误处理机制。 一. DefaultErrorAttributes
Springboot @Autowired依赖注入HttpServletRequest 和 HttpServletResponse 原理（居然不是单例）
HD243608836的博客
02-28 5863
通常来说依赖注入的对象一旦创建完成后就不会在改变，因为Spring的默认行为创建的都是单例对象。和不是单例对象，它们都是根据HTTP请求进行创建的，一个HTTP请求对象一个request和response。但是通过@Autowired可以实现每当一个请求进来时使用的都是当前的request或response对象,演示代码如下。
springmvc在使用@ModelAttribute注解获取Request和Response会产生线程并发不安全问题
HELLO_CZ的博客
06-20 1910
springmvc在获取Request和Response有很多方式：具体请看：https://www.cnblogs.com/wade-luffy/p/8867144.html 产生线程问题的代码如下： public class BaseController { protected HttpServletRequest request; protected HttpServl...
Feign中的RequestInterceptor获取不到HttpServletRequest问题解决方案
最新发布
qq_34091529的博客
04-07 2365
我们这里不用它这个默认的实现类，自己实现HystrixConcurrencyStrategy类，重写其#wrapCallable方法，方法内逻辑就是重开子线程之前将主线程的请求设置为可被子线程继承**（注意：继承的请求还是同一个，如果主线程和子线程存在异步情况，主线程结束后请求被销毁，子线程同样获取不到了）**。，翻看代码发现，其实它还提供了SPI的方式来加载自定义插件。HystrixPlugins插件在获取当前策略时，是会先加载程序员配置的策略实现类，找不到才会加载默认策略实现。自定义隔离策略的思路。
SpringMvc错误处理
mingtiandexia的专栏
03-26 1091
DispatchServlet的doDispatch方法 // Actually invoke the handler. mv = ha.handle(processedRequest, response, mappedHandler.getHandler()) springmvc对应的handlermapper是RequestMappingHandlerAdapter @Overrid...
springboot全局异常处理BasicErrorController和RestControllerAdvice
yujunlong3919的专栏
12-04 3741
文章目录@RestControllerAdviceBasicErrorController @RestControllerAdvice @RestControllerAdvice public class ExceptionHandlerAdvice { @ExceptionHandler(value = ToolBoxException.class) public Ret<String> doBaseApiException(ToolBoxException e) {
SpringBoot源码之BasicErrorController、DefaultErrorViewResolver、ErrorMvcAutoConfiguration类
编程学习者的博客
03-26 2303
当前源码：spring-boot 2.2.5.RELEASE版本！ 1.声明 当前内容是用来了解和复习SpringBoot中的BasicErrorController源码的，在于一次配置了日志的时候发现访问一个错误的url产生的就是一个模板错误页面 使用springboot的时候产生这个肯定是访问路径没有被映射，所以才产生的 本人debug发现： 发现这个无论访问任何不存在的url都会调用Ba...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值