Spring父子容器源码1

第一个blog  最近在看spring的父子容器  整理一下源码 就给自己看吧

首先看看xml文件的配置

<context-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:applicationContext.xml</param-value>
</context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
</listener>

关于spring ioc容器的建立 一起都需要从这个ContextLoaderListener监听器说起

首先 web服务器启动时 执行此监听器,下面来看一下该监听器实现的接口

public interface ServletContextListener extends EventListener {
    public void contextInitialized ( ServletContextEvent sce );
    public void contextDestroyed ( ServletContextEvent sce );
}

ContextLoaderListener中实现了该接口  下面是contentInitalized方法

public void contextInitialized(ServletContextEvent event) {
	//此处调用父类ContextLoader的方法 
	initWebApplicationContext(event.getServletContext());
}

父类contextLoader的初始化wac方法 实际上就是初始化spring的ioc容器

//入参的实例对象为ApplicationContextFacaed对象
public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
		//上下文中是否已经有跟ioc容器
		if (servletContext.getAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE) != null) {
			throw new IllegalStateException(
					"Cannot initialize context because there is already a root application context present - " +
					"check whether you have multiple ContextLoader* definitions in your web.xml!");
		}
				
		Log logger = LogFactory.getLog(ContextLoader.class);
		servletContext.log("Initializing Spring root WebApplicationContext");
		if (logger.isInfoEnabled()) {
			logger.info("Root WebApplicationContext: initialization started");
		}
		long startTime = System.currentTimeMillis();

		try {
			//servlet3.0以上 可使用带参构成器配置上下文  这里我们使用2.5的无参构造器
			if (this.context == null) {
				this.context = createWebApplicationContext(servletContext);
			}
			if (this.context instanceof ConfigurableWebApplicationContext) {
				ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) this.context;
				if (!cwac.isActive()) {
					// The context has not yet been refreshed -> provide services such as
					// setting the parent context, setting the application context id, etc
					if (cwac.getParent() == null) {
						// 这里没有配置springIoc 父容器的初始化参数 所以为null 没有父容器
						ApplicationContext parent = loadParentContext(servletContext);
						cwac.setParent(parent);
					}
					configureAndRefreshWebApplicationContext(cwac, servletContext);
				}
			}
			servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);

进入 creatWebApplicationContext方法   整个ioc容器的初始化阶段（刷新除外）都在contextLoader完成

protected WebApplicationContext createWebApplicationContext(ServletContext sc) {
	//确定ioc容器的类型
	Class<?> contextClass = determineContextClass(sc);
	if (!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {
		throw new ApplicationContextException("Custom context class [" + contextClass.getName() +
				"] is not of type [" + ConfigurableWebApplicationContext.class.getName() + "]");
	}
		return (ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);
	}

进入determineContextClass()方法

protected Class<?> determineContextClass(ServletContext servletContext) {
		//在该配置中并没有配置 contextClass初始化参数  当然也可以配置 即 XmlWebApplicationContext全类名 
		String contextClassName = servletContext.getInitParameter(CONTEXT_CLASS_PARAM);
		if (contextClassName != null) {
			try {
				return ClassUtils.forName(contextClassName, ClassUtils.getDefaultClassLoader());
			}
			catch (ClassNotFoundException ex) {
				throw new ApplicationContextException(
						"Failed to load custom context class [" + contextClassName + "]", ex);
			}
		}
		else {
			//ContextLoader静态码块中已加载该property： ContextLoader.properties 这里获得的就是
			//XmlWebApplicationContext全类名
			contextClassName = defaultStrategies.getProperty(WebApplicationContext.class.getName());
			try {
				return ClassUtils.forName(contextClassName, ContextLoader.class.getClassLoader());
			}
			catch (ClassNotFoundException ex) {
				throw new ApplicationContextException(
						"Failed to load default context class [" + contextClassName + "]", ex);
			}
		}
	}

进入 configureAndRefreshWebApplicationContext方法

protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac, ServletContext sc) {
		if (ObjectUtils.identityToString(wac).equals(wac.getId())) {
			//这个方法就是为了获取我们设置的contextId  我们并没有设置 
			String idParam = sc.getInitParameter(CONTEXT_ID_PARAM);
			if (idParam != null) {
				wac.setId(idParam);
			}
			else {
				// 此处设置id ，在refresh阶段 通过获取此id设置ioc的序列化号
				wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +
						ObjectUtils.getDisplayString(sc.getContextPath()));
			}
		}
		//设置ioc的上下为
		wac.setServletContext(sc);
		//获取spring的配置文件的文章
		String initParameter = sc.getInitParameter(CONFIG_LOCATION_PARAM);
		if (initParameter != null) {
			wac.setConfigLocation(initParameter);
		}
		//自定义上下文 这个要后补  目前没用过  以后在看
		customizeContext(sc, wac);
		//开始ioc容器的刷新  父子容器写完了 下一张写这个吧
		wac.refresh();
	}

最后一个方法

servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
全局上下文中 set spring的ioc容器对象,springMVC ioc容器初始化时  由此获取父容器

下面是springMVC子容器的初始化  

dispatcherservlet的两个主要父类   FrameWorkServlet  HttpServletBean

首先进入核心控制器的初始化方法  在httpServletBean中完成

public final void init() throws ServletException {
		if (logger.isDebugEnabled()) {
			logger.debug("Initializing servlet '" + getServletName() + "'");
		}

		// 设置bean的初始化属性
		try {
			PropertyValues pvs = new ServletConfigPropertyValues(getServletConfig(), this.requiredProperties);
			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) {
			logger.error("Failed to set bean properties on servlet '" + getServletName() + "'", ex);
			throw ex;
		}

		//委派模式 由FrameWorkServlet重写此方法
		initServletBean();

		if (logger.isDebugEnabled()) {
			logger.debug("Servlet '" + getServletName() + "' configured successfully");
		}
	}

初始化springioc容器阶段 主要在framework中完成（refresh除外）

protected final void initServletBean() throws ServletException {
		getServletContext().log("Initializing Spring FrameworkServlet '" + getServletName() + "'");
		if (this.logger.isInfoEnabled()) {
			this.logger.info("FrameworkServlet '" + getServletName() + "': initialization started");
		}
		long startTime = System.currentTimeMillis();

		try {
			//这就是初始化springMVC容器
			this.webApplicationContext = initWebApplicationContext();
			initFrameworkServlet();
		}
		catch (ServletException ex) {
			this.logger.error("Context initialization failed", ex);
			throw ex;
		}
		catch (RuntimeException ex) {
			this.logger.error("Context initialization failed", ex);
			throw ex;
		}


		if (this.logger.isInfoEnabled()) {
			long elapsedTime = System.currentTimeMillis() - startTime;
			this.logger.info("FrameworkServlet '" + getServletName() + "': initialization completed in " +
					elapsedTime + " ms");
		}
	}

进入initWebApplicationContext方法

protected WebApplicationContext initWebApplicationContext() {
		//获取springIOC容器作为跟容器（ContextLoader initWebApplicationContext中设置了该容器
		
		//servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
		WebApplicationContext rootContext =
				WebApplicationContextUtils.getWebApplicationContext(getServletContext());
				//其内部调用了 sc.getAttribute(); 

		WebApplicationContext wac = null;
		//3。0+以上使用 有这是构造器参数这只该上下文 
		if (this.webApplicationContext != null) {
			// A context instance was injected at construction time -> use it
			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
					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);
				}
			}
		}
		if (wac == null) {
			// 调用此方法需在xml中手动设置contextattribute属性  没有设置返回null
			wac = findWebApplicationContext();
		}
		if (wac == null) {
			// 设置父容器以及刷星子容器的方法入口
			wac = createWebApplicationContext(rootContext);
		}


		if (!this.refreshEventReceived) {
			// 和findWebApplicationContext()中配合使用 这里不进入此方法dispaterServlet的9大组件初始化由容器刷新结束后 触发framework内部监听器 			执onrefesh方法
			onRefresh(wac);
		}


		if (this.publishContext) {
			// Publish the context as a servlet context attribute.
			String attrName = getServletContextAttributeName();
			getServletContext().setAttribute(attrName, wac);
			if (this.logger.isDebugEnabled()) {
				this.logger.debug("Published WebApplicationContext of servlet '" + getServletName() +
						"' as ServletContext attribute with name [" + attrName + "]");
			}
		}
		return wac;
	}

进入createWebApplicationContext方法

protected WebApplicationContext createWebApplicationContext(ApplicationContext parent) {
		//默认获取XmlWebApplicationContext
		Class<?> contextClass = getContextClass();
		if (this.logger.isDebugEnabled()) {
			this.logger.debug("Servlet with name '" + getServletName() +
					"' will try to create custom WebApplicationContext context of class '" +
					contextClass.getName() + "'" + ", using parent context [" + parent + "]");
		}
		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");
		}
		//创建XmlWebApplicationContext对象
		ConfigurableWebApplicationContext wac =
				(ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);
		//设置运行环境，父容器,配置路径
		wac.setEnvironment(getEnvironment());
		wac.setParent(parent);
		wac.setConfigLocation(getContextConfigLocation());
		
		configureAndRefreshWebApplicationContext(wac);


		return wac;

进入configureAndRefreshWebApplicationContext方法

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...
				wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +
						ObjectUtils.getDisplayString(getServletContext().getContextPath()) + "/" + getServletName());
			}
		}

		wac.setServletContext(getServletContext());
		wac.setServletConfig(getServletConfig());
		wac.setNamespace(getNamespace());
		wac.addApplicationListener(new SourceFilteringListener(wac, new ContextRefreshListener()));

		ConfigurableEnvironment env = wac.getEnvironment();
		if (env instanceof ConfigurableWebEnvironment) {
			((ConfigurableWebEnvironment)env).initPropertySources(getServletContext(), getServletConfig());
		}
		//上面的方法看spring的初始化 基本一致
		//后处理
		postProcessWebApplicationContext(wac);
		applyInitializers(wac);
		//进入refresh方法
		wac.refresh();

后面加是两个不同容器的刷新了，真的的ioc容器刷新阶段创建 。下一次再写。

总的来说 父子容器 实际上就是在 spring 将自己的ioc容器设置经servlectContex中，springMVC 将在servletContext中的获取的ioc容器设置为自己的父容器。使得子容器可以访问父容器的资源。