Spring5 MVC——启动过程，执行refresh方法的入口

• 尝试从SpringMVC子容器中获取Root容器，由于在AbstractDispatcherServletInitializer类中的registerDispatcherServlet方法中只是创建了父子容器，并没有做关联。

• 在该方法中的configureAndRefreshWebApplicationContext方法会调用refresh()方法对Root容器(Root WebApplicationContext)和Servlet容器(dispatcher-servlet mvc子容器)进行刷新。

• 在dispatcher-servlet子容器调用refresh()方法刷新之前会调用HttpServletBean的init方法和FrameworkServlet类的initServletBean、initWebApplicationContext、configureAndRefreshWebApplicationContext等方法。

• 而SpringMVC里面只有一个Servlet即DispatcherServlet，因此推测DispatcherServlet和HttpServletBean、FrameworkServlet有着密切相关的关系。

• Servlet初始化的时候会调用init方法，所以这里的dispatcher-servlet子容器的刷新是在DispatcherServlet初始化的时候进行的，即调用的是HttpServletBean的init方法和FrameworkServlet类的initServletBean、initWebApplicationContext、configureAndRefreshWebApplicationContext等方法。

HttpServlet

HttpServlet是Servlet规范中的核心类，实现Servlet接口，继承此类用于处理用户请求

HttpServletBean

HttpServletBean主要配置servlet中初始化参数。继承HttpServlet，并实现无参的init()方法，用于设置在web.xml中配置的contextConfigLocation属性，此属性指定Spring MVC的配置文件地址，默认为WEB-INF/[servlet-name]-servlet.xml。

HttpServletBean#init

public abstract class HttpServletBean extends HttpServlet implements EnvironmentCapable, EnvironmentAware {

	@Override
	public final void init() throws ServletException {

		// Set bean properties from init parameters.
		//获取在web.xml配置的初始化参数,并将其设置到DispatcherServlet中
		PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);
		if (!pvs.isEmpty()) {
			try {
				BeanWrapper bw = PropertyAccessorFactory.forBeanPropertyAccess(this);
				ResourceLoader resourceLoader = new ServletContextResourceLoader(getServletContext());
				bw.registerCustomEditor(Resource.class, new ResourceEditor(resourceLoader, getEnvironment()));
				initBeanWrapper(bw);
				bw.setPropertyValues(pvs, true);
			}
			catch (BeansException ex) {
				if (logger.isErrorEnabled()) {
					logger.error("Failed to set bean properties on servlet '" + getServletName() + "'", ex);
				}
				throw ex;
			}
		}

		// Let subclasses do whatever initialization they like.
		//调用子类FrameworkServlet进行初始化
		//模板方法，此方法在HttpServletBean本身是空的，但是因为调用方法的对象是DispatcherServlet
		//所以优先在DispatcherServlet找，找不到再去父类找，最后在FrameworkServlet找
		initServletBean();
	}
}

HttpServletBean的作用：

• 获取web.xml的中配置DispatcherServlet的初始化参数，存放到一个参数容器ServletConfigPropertyValues中。
• 根据传进来的this创建BeanWrapper，本质上它就是DispatcherServlet
• 通过bw.setPropertyValues(pvs, true)，把参数设置到bw(即DispatcherServlet)里面去。
• 最后调用子类的initServletBean()。

FrameworkServlet

FrameworkServlet主要创建WebApplicationContext上下文，重写了HttpServletBean的initServletBean()方法。

initServletBean

• 该方法只有两句关键代码，其作用一个是调用initWebApplicationContext()方法初始化WebApplicationContext上下文，另一个是调用子类方法initFrameworkServlet()方法。

public abstract class FrameworkServlet extends HttpServletBean implements ApplicationContextAware {

	@Override
	protected final void initServletBean() throws ServletException {
		getServletContext().log("Initializing Spring " + getClass().getSimpleName() + " '" + getServletName() + "'");
		if (logger.isInfoEnabled()) {
			logger.info("Initializing Servlet '" + getServletName() + "'");
		}
		long startTime = System.currentTimeMillis();

		try {
			// 初始化WebApplicationContext，并调用子类（DispatcherServlet）的onRefresh(wac)方法
			this.webApplicationContext = initWebApplicationContext();
			initFrameworkServlet();
		}
		catch (ServletException | RuntimeException ex) {
			logger.error("Context initialization failed", ex);
			throw ex;
		}

		if (logger.isDebugEnabled()) {
			String value = this.enableLoggingRequestDetails ?
					"shown which may lead to unsafe logging of potentially sensitive data" :
					"masked to prevent unsafe logging of potentially sensitive data";
			logger.debug("enableLoggingRequestDetails='" + this.enableLoggingRequestDetails +
					"': request parameters and headers will be " + value);
		}

		if (logger.isInfoEnabled()) {
			logger.info("Completed initialization in " + (System.currentTimeMillis() - startTime) + " ms");
		}
	}
}

initWebApplicationContext

public abstract class FrameworkServlet extends HttpServletBean implements ApplicationContextAware {

	protected WebApplicationContext initWebApplicationContext() {
		// 获取root WebApplicationContext，即web.xml中配置的listener（ContextLoaderListener）
		WebApplicationContext rootContext =
				WebApplicationContextUtils.getWebApplicationContext(getServletContext());
		WebApplicationContext wac = null;

		// 判断容器是否由编程式传入（即是否已经存在了容器实例），存在的话直接赋值给wac，给springMVC容器设置父容器
		// 最后调用刷新函数configureAndRefreshWebApplicationContext(wac)，作用是把Spring MVC配置文件的配置信息加载到容器中去
		if (this.webApplicationContext != null) {
			// A context instance was injected at construction time -> use it
			// context上下文在构造是注入
			wac = this.webApplicationContext;
			if (wac instanceof ConfigurableWebApplicationContext) {
				ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) wac;
				if (!cwac.isActive()) {
					// The context has not yet been refreshed -> provide services such as
					// setting the parent context, setting the application context id, etc
					// context没有被refreshed，提供一些诸如设置父context、设置应用context id等服务
					if (cwac.getParent() == null) {
						// The context instance was injected without an explicit parent -> set
						// the root application context (if any; may be null) as the parent
						cwac.setParent(rootContext);
					}
					configureAndRefreshWebApplicationContext(cwac);
				}
			}
		}
		// 在ServletContext中寻找是否有Spring MVC容器，初次运行是没有的，Spring MVC初始化完毕ServletContext就有了Spring MVC容器
		if (wac == null) {
			// No context instance was injected at construction time -> see if one
			// has been registered in the servlet context. If one exists, it is assumed
			// that the parent context (if any) has already been set and that the
			// user has performed any initialization such as setting the context id
			wac = findWebApplicationContext();
		}
		// 当wac既没有没被编程式注册到容器中的，也没在ServletContext找得到，此时就要新建一个Spring MVC容器
		if (wac == null) {
			// No context instance is defined for this servlet -> create a local one
			// 如果没有WebApplicationContext则创建
			wac = createWebApplicationContext(rootContext);
		}

		// 到这里Spring MVC容器已经创建完毕，接着真正调用DispatcherServlet的初始化方法onRefresh(wac)
		// 此处仍是模板模式的应用
		if (!this.refreshEventReceived) {
			// Either the context is not a ConfigurableApplicationContext with refresh
			// support or the context injected at construction time had already been
			// refreshed -> trigger initial onRefresh manually here.
			synchronized (this.onRefreshMonitor) {
				onRefresh(wac);
			}
		}
		// 将Spring MVC容器存放到ServletContext中去，方便下次取出来
		if (this.publishContext) {
			// Publish the context as a servlet context attribute.
			String attrName = getServletContextAttributeName();
			getServletContext().setAttribute(attrName, wac);
		}

		return wac;
	}
}

createWebApplicationContext

如果没有WebApplicationContext则创建

public abstract class FrameworkServlet extends HttpServletBean implements ApplicationContextAware {

	protected WebApplicationContext createWebApplicationContext(@Nullable WebApplicationContext parent) {
		return createWebApplicationContext((ApplicationContext) parent);
	}

	protected WebApplicationContext createWebApplicationContext(@Nullable ApplicationContext parent) {
		Class contextClass = getContextClass();
		if (!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {
			throw new ApplicationContextException(
					"Fatal initialization error in servlet with name '" + getServletName() +
					"': custom WebApplicationContext class [" + contextClass.getName() +
					"] is not of type ConfigurableWebApplicationContext");
		}

		// 实例化容器
		ConfigurableWebApplicationContext wac =
				(ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);
		// 设置容器环境
		wac.setEnvironment(getEnvironment());
		// 设置父容器
		wac.setParent(parent);
		// 加载Spring MVC的配置信息，如：bean注入、注解、扫描等等
		String configLocation = getContextConfigLocation();
		if (configLocation != null) {
			wac.setConfigLocation(configLocation);
		}
		// 刷新容器，根据Spring MVC配置文件完成初始化操作
		configureAndRefreshWebApplicationContext(wac);

		return wac;
	}
}

configureAndRefreshWebApplicationContext

• 刷新容器，根据Spring MVC配置文件完成初始化操作

public abstract class FrameworkServlet extends HttpServletBean implements ApplicationContextAware {

	protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac) {
		// 用可以获取到的信息，获取一个更有意义的上下文
		if (ObjectUtils.identityToString(wac).equals(wac.getId())) {
			// The application context id is still set to its original default value
			// -> assign a more useful id based on available information
			if (this.contextId != null) {
				wac.setId(this.contextId);
			}
			else {
				// Generate default id...
				// 生成默认 id
				wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +
						ObjectUtils.getDisplayString(getServletContext().getContextPath()) + '/' + getServletName());
			}
		}
		// 设置 servletContext 属性
		wac.setServletContext(getServletContext());
		wac.setServletConfig(getServletConfig());
		wac.setNamespace(getNamespace());
		wac.addApplicationListener(new SourceFilteringListener(wac, new ContextRefreshListener()));

		// The wac environment's #initPropertySources will be called in any case when the context
		// is refreshed; do it eagerly here to ensure servlet property sources are in place for
		// use in any post-processing or initialization that occurs below prior to #refresh
		// 初始化属性源， 确保 servlet属性源到位并能够在任何 refresh 之前的后期处理和初始化中使用
		ConfigurableEnvironment env = wac.getEnvironment();
		if (env instanceof ConfigurableWebEnvironment) {
			((ConfigurableWebEnvironment) env).initPropertySources(getServletContext(), getServletConfig());
		}

		postProcessWebApplicationContext(wac);
		applyInitializers(wac);
		//刷新容器
		wac.refresh();
	}
}

总结FrameworkServlet的作用：

• 创建Spring MVC的容器，根据配置文件实例化里面各种bean，并将之与spring的容器进行关联。
• 把创建出来的Spring MVC容器存放到ServletContext中。
• 通过模板方法模式调用子类DispatcherServlet的onRefresh()方法。

DispatcherServlet

DispatcherServlet是Spring MVC核心，它是J2EE规范前端控制器的实现，负责拦截用户请求，并解析请求进行转发。

public class DispatcherServlet extends FrameworkServlet {

	@Override
	protected void onRefresh(ApplicationContext context) {
		initStrategies(context);
	}

	protected void initStrategies(ApplicationContext context) {
		//初始化文件上传处理器
		initMultipartResolver(context);
		
		//初始化国际化配置
		initLocaleResolver(context);

		//初始化主题处理器
		initThemeResolver(context);

		//初始化HanlderMapping
		initHandlerMappings(context);

		//初始化HandlerAdapter
		//HandlerAdapter用来调用具体的方法对用户发来的请求来进行处理
		initHandlerAdapters(context);

		//初始化异常处理器,
		// HandlerExceptionResolver是用来对请求处理过程中产生的异常进行处理
		initHandlerExceptionResolvers(context);

		//RequestToViewNameTranslator用于在视图路径为空的时候，自动解析请求
		//去获取ViewName
		initRequestToViewNameTranslator(context);

		//初始化视图处理器
		//ViewResolvers将逻辑视图转成view对象
		initViewResolvers(context);

		//FlashMapManager用于存储、获取以及管理FlashMap实例
		initFlashMapManager(context);
	}
}

总结：

• 容器启动时，加载web.xml部署描述文件，扫描到并找到DispatcherServlet核心控制器。

• 调用HttpServletBean的init()方法，把DispatcherServlet初始化参数设置到DispatcherServlet中，并调用子类FrameworkServlet的initServletBean()方法。

• FrameworkServlet的initServletBean()创建Spring MVC容器并初始化，并且和Spring父容器进行关联，使得Spring MVC容器能访问Spring容器中定义的bean，之后调用子类DispatcherServlet的onRefresh()方法。

• DispatcherServlet的onRefresh(ApplicationContext context)对DispatcherServlet的策略组件进行初始化。

参考： https://www.cnblogs.com/yoci/p/10642493.html

https://www.cnblogs.com/fangjian0423/p/springMVC-directory-summary.html

https://segmentfault.com/a/1190000014674239

https://blog.csdn.net/win7system/article/details/90674757

https://www.cnblogs.com/liwangcai/p/10743943.html

https://www.cnblogs.com/myitnews/p/11565941.html