SpringBoot错误处理的自动配置源码学习笔记

最新推荐文章于 2024-05-31 10:14:06 发布
最新推荐文章于 2024-05-31 10:14:06 发布
阅读量190 收藏
点赞数
文章标签： spring boot
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lizongxiao/article/details/106196001
版权

错误处理的自动配置

	@Configuration
	@ConditionalOnWebApplication(type = Type.SERVLET)
	@ConditionalOnClass({ Servlet.class, DispatcherServlet.class })
	// Load before the main WebMvcAutoConfiguration so that the error View is available
	@AutoConfigureBefore(WebMvcAutoConfiguration.class)
	@EnableConfigurationProperties({ ServerProperties.class, ResourceProperties.class, WebMvcProperties.class })
	
	public class ErrorMvcAutoConfiguration {
		
		@Bean
		//容器中没有这个组件的时候
		@ConditionalOnMissingBean(value = ErrorAttributes.class, search = SearchStrategy.CURRENT)
		public DefaultErrorAttributes errorAttributes() {
			return new DefaultErrorAttributes(this.serverProperties.getError().isIncludeException());
		}
		
		//处理/error请求的
		@Bean
		@ConditionalOnMissingBean(value = ErrorController.class, search = SearchStrategy.CURRENT)
		public BasicErrorController basicErrorController(ErrorAttributes errorAttributes) {
			return new BasicErrorController(errorAttributes, this.serverProperties.getError(), this.errorViewResolvers);
		}
		
		//错误的定制页面，定制错误的响应规则
		@Bean
		public ErrorPageCustomizer errorPageCustomizer() {
			return new ErrorPageCustomizer(this.serverProperties, this.dispatcherServletPath);
		}
		
		@Configuration
		static class DefaultErrorViewResolverConfiguration {
			//帮我们在页面共享信息，
			@Bean
			@ConditionalOnBean(DispatcherServlet.class)
			@ConditionalOnMissingBean(ErrorViewResolver.class)
			public DefaultErrorViewResolver conventionErrorViewResolver() {
				return new DefaultErrorViewResolver(this.applicationContext, this.resourceProperties);
			}
		}
		
		//注册错误页面的响应规则
		private static class ErrorPageCustomizer implements ErrorPageRegistrar, Ordered {
			@Override
			public void registerErrorPages(ErrorPageRegistry errorPageRegistry) {
				ErrorPage errorPage = new ErrorPage(
						this.dispatcherServletPath.getRelativePath(this.properties.getError().getPath()));
				errorPageRegistry.addErrorPages(errorPage);
			}
		}
		@Configuration
		@ConditionalOnProperty(prefix = "server.error.whitelabel", name = "enabled", matchIfMissing = true)
		@Conditional(ErrorTemplateMissingCondition.class)
		protected static class WhitelabelErrorViewConfiguration {
			
			private final StaticView defaultErrorView = new StaticView();

			//视图对象就叫做error
			@Bean(name = "error")
			@ConditionalOnMissingBean(name = "error")
			public View defaultErrorView() {
				return this.defaultErrorView;
			}
		}
		private static class StaticView implements View {
			@Override
			public void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response)
				
				private static final Log logger = LogFactory.getLog(StaticView.class);

				@Override
				public void render(Map<String, ?> model, HttpServletRequest request, HttpServletResponse response)
						throws Exception {
					if (response.isCommitted()) {
						String message = getMessage(model);
						logger.error(message);
						return;
					}
					StringBuilder builder = new StringBuilder();
					Date timestamp = (Date) 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());
			}
		}
	}

getPath()

		源码：
		//从配置文件中取出error.path的值
		public class ErrorProperties {
			@Value("${error.path:/error}")
			private String path = "/error";
		}

BasicErrorController//处理/error请求的

		源码：
		//处理/error请求的，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<Map<String, Object>>(status);
				}
				Map<String, Object> body = getErrorAttributes(request, isIncludeStackTrace(request, MediaType.ALL));
				return new ResponseEntity<>(body, status);
			}
		}

TEXT_HTML_VALUE

			源码：
			public static final String TEXT_HTML_VALUE = "text/html";

getStatus

			源码：
			public abstract class AbstractErrorController implements ErrorController {
				protected HttpStatus getStatus(HttpServletRequest request) {
					Integer statusCode = (Integer) request.getAttribute("javax.servlet.error.status_code");
					if (statusCode == null) {
						return HttpStatus.INTERNAL_SERVER_ERROR;
					}
					try {
						return HttpStatus.valueOf(statusCode);
					}
					catch (Exception ex) {
						return HttpStatus.INTERNAL_SERVER_ERROR;
					}
				}
			}

getErrorAttributes

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

errorAttributes

				源码：
				public interface ErrorAttributes {
				}

ErrorAttributes

					实现：
					@Order(Ordered.HIGHEST_PRECEDENCE)
					public class DefaultErrorAttributes implements ErrorAttributes, HandlerExceptionResolver, Ordered {
						//页面能获取的信息
						@Override
						public Map<String, Object> getErrorAttributes(WebRequest webRequest, boolean includeStackTrace) {
							Map<String, Object> errorAttributes = new LinkedHashMap<>();
							//timestamp时间戳
							errorAttributes.put("timestamp", new Date());
							//status添加状态码
							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, "javax.servlet.error.status_code");
							if (status == null) {
								errorAttributes.put("status", 999);
								//error错误的提示
								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();
								}
								if (this.includeException) {
									//exception异常对象
									errorAttributes.put("exception", error.getClass().getName());
								}
								addErrorMessage(errorAttributes, error);
								if (includeStackTrace) {
									addStackTrace(errorAttributes, error);
								}
							}
							Object message = getAttribute(webRequest, "javax.servlet.error.message");
							if ((!StringUtils.isEmpty(message) || errorAttributes.get("message") == null)
									&& !(error instanceof BindingResult)) {
								//message异常消息
								errorAttributes.put("message", StringUtils.isEmpty(message) ? "No message available" : message);
							}
						}
						private void addErrorMessage(Map<String, Object> errorAttributes, Throwable error) {
							BindingResult result = extractBindingResult(error);
							if (result == null) {
								errorAttributes.put("message", error.getMessage());
								return;
							}
							if (result.hasErrors()) {
							//JSR303数据校验的错误
								errorAttributes.put("errors", result.getAllErrors());
								errorAttributes.put("message", "Validation failed for object='" + result.getObjectName()
										+ "'. Error count: " + result.getErrorCount());
							}
							else {
								errorAttributes.put("message", "No errors");
							}
						}
					}

resolveErrorView

		源码：
		public abstract class AbstractErrorController implements ErrorController {
			protected ModelAndView resolveErrorView(HttpServletRequest request, HttpServletResponse response, HttpStatus status,
					Map<String, Object> model) {
				//拿到所有异常视图解析器
				for (ErrorViewResolver resolver : this.errorViewResolvers) {
					//得到ModelAndView就返回，得不到就null
					ModelAndView modelAndView = resolver.resolveErrorView(request, status, model);
					if (modelAndView != null) {
						return modelAndView;
					}
				}
				return null;
			}
		}

DefaultErrorViewResolver//帮我们在页面共享信息

		源码：
		public class DefaultErrorViewResolver implements ErrorViewResolver, Ordered {
			static {
				Map<Series, String> views = new EnumMap<>(Series.class);
				//客户端错误用4xx
				views.put(Series.CLIENT_ERROR, "4xx");
				//服务端错误用5xx
				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())) {
					//status状态码
					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");
						//如果静态文件夹下存在HtmlResourceView
						if (resource.exists()) {
							return new ModelAndView(new HtmlResourceView(resource), model);
						}
					}
					catch (Exception ex) {
					}
				}
				return null;
			}		
		}
星LZX
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
SpringBoot源码学习系列之SpringMVC自动配置
Nicky's blog
11-26 4539
源码学习系列之WebMvc自动配置原理笔记 web的自动配置在SpringBoot项目中是一个很重要的方面，实现代码在spring-boot-autoconfigure工程里： WebMvcAutoConfiguration.java这个类很关键，这个就是SpringBoot Springmvc自动配置的一个很关键的配置类 @Configuration(proxyBeanMethods = fa...
springboot源码学习笔记项目.zip
04-26
通过学习和运行这些源码，你可以掌握各平台开发的基础知识，提升编程能力和项目实战经验。 使用场景及目标： 在学习阶段，你可以利用这些源码资源进行课程实践、课外项目或毕业设计。通过分析和运行源码，你将深入...
[SpringBoot-10]源码解析SpringBoot中的错误处理机制
学哥斌的博客
05-12 300
文章目录1、默认错误处理机制1.1 现象描述1.2 原理解析1.3 原理小结2、定制错误响应2.1 定制错误页面2.2 定制错误json数据 1、默认错误处理机制 1.1 现象描述   当我们使用浏览器访问一个路径出现错误时，SpringBoot会弹出一个ErrorPage：   当我们使用的是非浏览器的客户端来访问一个路径出现错误，会返回一个JSON字符串：   springboot根据访问者的request中的Accept属性来判断要返回什么样的数据，如果是浏览器，该属性如下：   如果不是浏览器
Spring Boot 自动配置 ErrorMvcAutoConfiguration
Details Inside Spring
07-04 4725
概述 自动配置ErrorMvcAutoConfiguration类配置了一个MVC error控制类用于渲染错误信息页面。 源代码 package org.springframework.boot.autoconfigure.web.servlet.error; // 省略 import 行 /** * EnableAutoConfiguration Auto-configuration t...
SpringBoot源码剖析
沉浸式Study
08-26 2795
SpringBoot概念 什么是SpringBoot spring官方的网站：https://spring.io/ 翻译：通过Spring Boot，可以轻松地创建独立的，基于生产级别的基于Spring的应用程序，并且可以“运行”它们 其实Spring Boot 的设计是为了让你尽可能快的跑起来 Spring 应用程序并且尽可能减少你的配置文件。 以下内容来自百度百科 SpringBoot是由Pivotal团队在2013年开始研发、2014年4月发布第一个版本的全新开源的轻量级框架。它基于Spring4.
SpringBoot笔记
热门推荐
ThinkStu的博客
05-05 31万+
最全SpringBoot笔记
SpringBoot学习笔记
weixin_52938172的博客
07-04 1359
SpringBoot初学习笔记
SpringBoot（六）——错误处理机制
weixin_43691723的博客
07-11 396
这篇文章主要介绍了SpringBoot的错误处理机制源码，以及自定义错误响应页面的方法。
【SpringBoot学习笔记 十一】深入理解SpringBoot异常处理
MaoLin Tian's Blog
10-16 717
上篇Blog详细聊了SpringBoot的拦截器使用，上上篇Blog详细介绍了SpringBoot是如何定制整合页面模板Thymeleaf的，这些都可以看做SpringBoot对SpringMVC功能层面的一个完善，那么本篇Blog继续介绍SpringBoot如何处理前端请求的异常，自动配置是如何帮助我们定制错误页面并轻松应用
SpringBoot3 全栈指南教程——尚硅谷学习笔记 2023年
末影小黑xh的博客
09-15 3638
Java17Maven、IDEA1、Spring 使用作为内部日志，但底层日志实现是开放的。可对接其他日志框架。① spring5 及以后 commons-logging 被 spring 直接自己实现了。2、支持jullog4j2logback。SpringBoot 提供了默认的控制台输出配置，也可以配置输出为文件。3、logback是默认使用的。4、虽然日志框架很多，但是不用担心，使用 SpringBoot 的默认配置就能工作的很好。SpringBoot 怎么把日志默认配置好的。1、每个。
（全）SpringBoot学习笔记（狂神说java系列）
qq_41978509的博客
04-24 4万+
文章目录从今天开始就进入微服务阶段1.HelloWorld1.1回顾什么是Spring1.2什么是SpringBoot1.3微服务架构2.第一个SpringBoot程序2.1环境配置2.2创建基础项目说明2.3.1项目创建方式一2.3.2项目创建方式二2.3.3项目结构分析：2.3SpringBoot特点2.3.1依赖管理2.3.2自动配置2.4容器功能2.4.1组件添加2.4.2原生配置文件引入2.4.3配置绑定3.自动配置原理初探3.1pom.xml3.2主程序3.3@SpringBootApplica
SpringBoot学习笔记所有源码集
09-19
SpringBoot学习笔记所有源码集，包括 集成了freemarker、Servlet、拦截器、拦截器、Filter、静态资源处理、启动加载数据、Springboot 日志、JDBC使用、Springboot JPA、Mybatis、动态数据源、集成swagger、集成Redis...
狂神SpringBoot笔记+源码
04-22
狂神SpringBoot笔记+源码 狂神SpringBoot笔记+源码 狂神SpringBoot笔记+源码 狂神SpringBoot笔记+源码 狂神SpringBoot笔记+源码 狂神SpringBoot笔记+源码 狂神SpringBoot笔记+源码 狂神SpringBoot笔记+源码 狂神...
SpringBoot经典学习笔记_springboot_SpringBoot经典学习笔记_
09-30
Springboot经典学习笔记，来源于csdn
基于springboot OA自动化办公系统源码
04-17
一套OA自动化办公系统源码，主要功能包括：系统管理、角色管理、用户管理、考勤管理、流程管理、公告通知、邮件管理、任务管理、日程管理、工作计划、文件管理、笔记管理、通讯录、讨论区、便签等等，还有多种颜色...
使用 Docker 环境变量轻松配置 Spring Boot 应用程序：详细指南
nbsaas-boot基于Request-Response的企业级快速开发框架
05-29 456
通过上述步骤，你可以轻松地将 Spring Boot 应用程序打包到 Docker 容器中，并通过环境变量来配置关键参数，如数据库连接、用户名和密码。这样可以使你的应用程序更加灵活和便于部署。
spring boot 3.x版本 引入 swagger2启动时报错
最新发布
东皋长歌的专栏
05-31 773
級到Spring Boot 3.x之后，需要从Springfox迁移到SpringDoc，Springfox已经很久没有维护了，不兼容Spring Boot 3.x -->-- 引入1.5.22及以上版本的swagger组件，以解决example默认解析报错（NumberFormatException）的问题 -->Spring Boot版本是3.3.0。那么就针对这个修改pom引入就好了。在pom文件后面加上下面配置。
Spring Boot注解（Annotation）
刘大辉的博客
05-28 456
在Spring Boot中，注解（Annotation）是一种元数据形式，它可以在代码中提供信息，这些信息可以在运行时或编译时被处理。Spring Boot使用注解来实现依赖注入、事务管理、配置等功能。
Java高级---Spring Boot---3快速入门
B6665X的博客
05-28 634
demo├── mvnw└── src├── main│ │ └── (其他Java类文件)│ └── (其他资源文件)└── test└── (测试资源文件)pom.xml: Maven项目对象模型文件，定义项目的构建配置和依赖。: 存放主要的Java源代码。: 存放资源文件，如配置文件。: 存放测试代码。
springboot学习笔记
06-09
好的，我可以和你分享一些关于Spring Boot的学习笔记。 1. Spring Boot是什么？ Spring Boot是一个基于Spring框架的快速开发框架，它能够帮助开发者快速搭建Spring项目，简化了Spring应用开发的繁琐过程，提高了...

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值