spring Context 创建

最新推荐文章于 2023-07-09 11:35:42 发布
原创 最新推荐文章于 2023-07-09 11:35:42 发布 · 213 阅读 · 0 ·
CC 4.0 BY-SA版权
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
文章标签：

#spring #ioc容器 #源码 #applicationContext

本文详细解析了Spring容器在Web应用中的启动流程，包括关键配置项的读取、上下文的初始化及Bean实例化的全过程。

  使用spring框架的时候，在web.xml的配置文件中都会加入如下注释：

  

	<!-- spring -->
  	<context-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>/WEB-INF/spring/spring.xml</param-value>
	</context-param>
	
	<listener>
		<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
	</listener>

   从上面的配置文件可知，spring容器的加载和创建是从org.springframework.web.context.ContextLoaderListener开始的。

 

 

  

public class ContextLoaderListener extends ContextLoader implements ServletContextListener

  ContextLoaderListener实现了ServletContextListener接口，大家都知道ServletContextListener是Servlet的监听器，监听ServletEvent，

 

在加载web.xml的时候，会首先加载Listener，ContextLoaderListener实现了ServletContextListener的抽象方法contextInitialized（），contextDestroyed（）

 

spring容器的创建就是在方法contextInitialized（）中完成的，如下是contextInitialized（）的代码：

 

	public void contextInitialized(ServletContextEvent event) {
		this.contextLoader = createContextLoader();
		if (this.contextLoader == null) {
			this.contextLoader = this;
		}
		this.contextLoader.initWebApplicationContext(event.getServletContext());
	}

  createContextLoader（）方法已经废弃了，会返回一个null，所以实际的创建在initWebApplicationContext方法中完成。

 

 

  initWebApplicationContext方法的实现：

  

	public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
		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 {
			// Store context in local instance variable, to guarantee that
			// it is available on ServletContext shutdown.
                        //创建WebApplicationContext
			if (this.context == null) {
				this.context = createWebApplicationContext(servletContext);
			}
                        
			if (this.context instanceof ConfigurableWebApplicationContext) {//对context进行包装
				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) {
						// The context instance was injected without an explicit parent ->
						// determine parent for root web application context, if any.
						ApplicationContext parent = loadParentContext(servletContext);//设置父context
						cwac.setParent(parent);
					}
                                        //配置和刷新context
					configureAndRefreshWebApplicationContext(cwac, servletContext);
				}
			}
			servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);

			ClassLoader ccl = Thread.currentThread().getContextClassLoader();
			if (ccl == ContextLoader.class.getClassLoader()) {
				currentContext = this.context;
			}
			else if (ccl != null) {
				currentContextPerThread.put(ccl, this.context);
			}

			if (logger.isDebugEnabled()) {
				logger.debug("Published root WebApplicationContext as ServletContext attribute with name [" +
						WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE + "]");
			}
			if (logger.isInfoEnabled()) {
				long elapsedTime = System.currentTimeMillis() - startTime;
				logger.info("Root WebApplicationContext: initialization completed in " + elapsedTime + " ms");
			}

			return this.context;
		}
		catch (RuntimeException ex) {
			logger.error("Context initialization failed", ex);
			servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, ex);
			throw ex;
		}
		catch (Error err) {
			logger.error("Context initialization failed", err);
			servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, err);
			throw err;
		}
	}

    首先会进入方法：createWebApplicationContext（）

 

  

	protected WebApplicationContext createWebApplicationContext(ServletContext sc) {
                //决定究竟创建哪种类型的context
		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) {
                //先获取web.xml中配置的CONTEXT_CLASS_PARAM即“contextClass”
		String contextClassName = servletContext.getInitParameter(CONTEXT_CLASS_PARAM);
		if (contextClassName != null) {//分支1
			try {
				return ClassUtils.forName(contextClassName, ClassUtils.getDefaultClassLoader());
			}
			catch (ClassNotFoundException ex) {
				throw new ApplicationContextException(
						"Failed to load custom context class [" + contextClassName + "]", ex);
			}
		}
		else {//分支2
			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);
			}
		}
	}

    在web.xml中我很少会配置contextClass这个配置项，所以代码会走分支2，defaultStrategies的内容是什么呢？

    在ContextLoader有如下代码

	private static final Properties defaultStrategies;

	static {
		// Load default strategy implementations from properties file.
		// This is currently strictly internal and not meant to be customized
		// by application developers.
		try {
                        //获取DEFAULT_STRATEGIES_PATH路径下的配置文件，然后加载此配置文件内容
			ClassPathResource resource = new ClassPathResource(DEFAULT_STRATEGIES_PATH, ContextLoader.class);
			defaultStrategies = PropertiesLoaderUtils.loadProperties(resource);
		}
		catch (IOException ex) {
			throw new IllegalStateException("Could not load 'ContextLoader.properties': " + ex.getMessage());
		}
	}

    DEFAULT_STRATEGIES_PATH为ContextLoader.properties，即是org.springframework.web.ContextLoader.properties

   ContextLoader.properties内容为：

   

# Default WebApplicationContext implementation class for ContextLoader.
# Used as fallback when no explicit context implementation has been specified as context-param.
# Not meant to be customized by application developers.
 
org.springframework.web.context.WebApplicationContext=org.springframework.web.context.support.XmlWebApplicationContext

  

  所以determineContextClass（）方法的返回值是XmlWebApplicationContext.class

  所以在方法createWebApplicationContext（）中，根据XmlWebApplicationContext.class创建XmlWebApplicationContext对象

 

  现在回到方法initWebApplicationContext中去,

  然后会给context设置父context，然后配置和刷新context，现在进入方法configureAndRefreshWebApplicationContext（）

  方法configureAndRefreshWebApplicationContext

   

		
      protected void configureAndRefreshWebApplicationContext(ConfigurableWebApplicationContext wac, ServletContext sc) {
            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
			String idParam = sc.getInitParameter(CONTEXT_ID_PARAM);
                        //设置id
			if (idParam != null) {
				wac.setId(idParam);
			}
			else {
				// Generate default id...
				if (sc.getMajorVersion() == 2 && sc.getMinorVersion() < 5) {
					// Servlet <= 2.4: resort to name specified in web.xml, if any.
					wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +
							ObjectUtils.getDisplayString(sc.getServletContextName()));
				}
				else {
					wac.setId(ConfigurableWebApplicationContext.APPLICATION_CONTEXT_ID_PREFIX +
							ObjectUtils.getDisplayString(sc.getContextPath()));
				}
			}
		}

		wac.setServletContext(sc);
                //CONFIG_LOCATION_PARAM即是：“contextConfigLocation”即web.xml配置的contextConfigLocation，即spring配置文件的位置
		String initParameter = sc.getInitParameter(CONFIG_LOCATION_PARAM);
		if (initParameter != null) {
			wac.setConfigLocation(initParameter);
		}
		customizeContext(sc, wac);
		wac.refresh();
	}

   customizeContext(sc, wac);和wac.refresh();做了什么？ 

 

customizeContext（sc, wac)代码为：

 

	protected void customizeContext(ServletContext servletContext, ConfigurableWebApplicationContext applicationContext) {
		List<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>> initializerClasses =
				determineContextInitializerClasses(servletContext);
		if (initializerClasses.size() == 0) {
			// no ApplicationContextInitializers have been declared -> nothing to do
			return;
		}

		Class<?> contextClass = applicationContext.getClass();
		ArrayList<ApplicationContextInitializer<ConfigurableApplicationContext>> initializerInstances =
				new ArrayList<ApplicationContextInitializer<ConfigurableApplicationContext>>();

		for (Class<ApplicationContextInitializer<ConfigurableApplicationContext>> initializerClass : initializerClasses) {
			Class<?> initializerContextClass =
					GenericTypeResolver.resolveTypeArgument(initializerClass, ApplicationContextInitializer.class);
			if (initializerContextClass != null) {
				Assert.isAssignable(initializerContextClass, contextClass, String.format(
						"Could not add context initializer [%s] as its generic parameter [%s] " +
						"is not assignable from the type of application context used by this " +
						"context loader [%s]: ", initializerClass.getName(), initializerContextClass.getName(),
						contextClass.getName()));
			}
			initializerInstances.add(BeanUtils.instantiateClass(initializerClass));
		}

		ConfigurableEnvironment env = applicationContext.getEnvironment();
		if (env instanceof ConfigurableWebEnvironment) {
			((ConfigurableWebEnvironment)env).initPropertySources(servletContext, null);
		}

		Collections.sort(initializerInstances, new AnnotationAwareOrderComparator());
		for (ApplicationContextInitializer<ConfigurableApplicationContext> initializer : initializerInstances) {
			initializer.initialize(applicationContext);
		}
	}

 

 首先代码会进入方法determineContextInitializerClasses(servletContext); determineContextInitializerClasses方法代码为：

	protected List<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>>
			determineContextInitializerClasses(ServletContext servletContext) {
		String classNames = servletContext.getInitParameter(CONTEXT_INITIALIZER_CLASSES_PARAM);
		List<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>> classes =
			new ArrayList<Class<ApplicationContextInitializer<ConfigurableApplicationContext>>>();
		if (classNames != null) {
			for (String className : StringUtils.tokenizeToStringArray(classNames, ",")) {
				try {
					Class<?> clazz = ClassUtils.forName(className, ClassUtils.getDefaultClassLoader());
					Assert.isAssignable(ApplicationContextInitializer.class, clazz,
							"class [" + className + "] must implement ApplicationContextInitializer");
					classes.add((Class<ApplicationContextInitializer<ConfigurableApplicationContext>>)clazz);
				}
				catch (ClassNotFoundException ex) {
					throw new ApplicationContextException(
							"Failed to load context initializer class [" + className + "]", ex);
				}
			}
		}
		return classes;
	}

 如上所示：首先会从web.xml的配置文件里查找名称为CONTEXT_INITIALIZER_CLASSES_PARAM（即contextInitializerClasses）的配置项，我们一般不会配置这个配置项的，所以classNames为null,所以如上方法返回为一个空的list，再回到方法customizeContext（）中，list为空，所以方法customizeContext（）返回值为空。

 

那么我们就进入最后一个方法：wac.refresh();代码为：

	public void refresh() throws BeansException, IllegalStateException {
		synchronized (this.startupShutdownMonitor) {
			// Prepare this context for refreshing.
			prepareRefresh();

			// Tell the subclass to refresh the internal bean factory.
			ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();

			// Prepare the bean factory for use in this context.
			prepareBeanFactory(beanFactory);

			try {
				// Allows post-processing of the bean factory in context subclasses.
				postProcessBeanFactory(beanFactory);

				// Invoke factory processors registered as beans in the context.
				invokeBeanFactoryPostProcessors(beanFactory);

				// Register bean processors that intercept bean creation.
				registerBeanPostProcessors(beanFactory);

				// Initialize message source for this context.
				initMessageSource();

				// Initialize event multicaster for this context.
				initApplicationEventMulticaster();

				// Initialize other special beans in specific context subclasses.
				onRefresh();

				// Check for listener beans and register them.
				registerListeners();

				// Instantiate all remaining (non-lazy-init) singletons.
				finishBeanFactoryInitialization(beanFactory);

				// Last step: publish corresponding event.
				finishRefresh();
			}

			catch (BeansException ex) {
				// Destroy already created singletons to avoid dangling resources.
				destroyBeans();

				// Reset 'active' flag.
				cancelRefresh(ex);

				// Propagate exception to caller.
				throw ex;
			}
		}
	}

 由上面的代码可以知道，context的加载配置项，初始化，创建beanFactory均在此方法中完成。

 

Spring 核心技术解析【纯干货版】- XXI：Spring 第三方工具整合模块 Spring-Context-Suppor 模块精讲
栗筝i的博客
04-04 1394
Spring-Context-Support 模块，是 Spring Framework 的一个模块，它提供了一系列对常见第三方库集成的支持类，以便于在Spring应用中更容易地使用这些库。Spring-Context-Support 模块包含的类主要是为了帮助开发者更好地利用外部库的功能，而无需自己编写大量的胶水代码。
Spring中的Context你真的懂了吗
08-25
在 refresh 方法中，Spring 会做一些准备工作，如创建 BeanFactory、注册 BeanFactoryPostProcessor 等，只有等这些准备工作做好以后才去开始 Spring Context 的启动。 通过这些内容，我们可以更好地理解 Spring 中...
SpringContext的创建过程分析
qq_43408971的博客
01-29 661
在Spring框架中IOC容器起到了关键作用，Context模块也是整个Spring框架当之无愧的根基。每个Spring应用程序都至少存在一个Context对象，Context的创建过程中具体进行了什么操作呢，下面以最常用的AnnotationConfigApplicationContext为例，来说明SpringContext的创建过程，以下为示例代码： //配置类 @Configuration public class AnnoBeanConfig { @Bean public Bean
框架源码 -- Spring context
小达的博客
10-23 9442
应用上下文 Spring通过应用上下文（Application Context）装载bean的定义并把它们组装起来。Spring应用上下文全权负责对象的创建和组装。Spring自带了多种应用上下文的实现，它们之间主要的区别仅仅在于如何加载配置。 1.AnnotationConfigApplicationContext：从一个或多个基于Java的配置类中加载 Spring应用上下文。 2.An...
利用Spring Context上下文创建自定义对象
07-04
利用Spring Context上下文创建自定义对象，学习Spring的IoC容器如何使用控制反转创建一个对象，了解Spring控制反转原理
配置服务器启动加载applicationContext
Jack Wu
09-25 3422
      在spring使用过程中，通常的做法是让服务器启动时即实例化所有的bean，这样做在一定程度上提高了web应用的速度。加载完成后，在用的时候便可以通过ApplicationContext ctx = WebApplicationContextUtils.getWebApplictionContext();Test test = (Test)ctx.getBean("test")
SpringMVC junit测试，设置context
zhanghe_zht的博客
06-02 368
设置spring的context @RunWith(SpringJUnit4ClassRunner.class) //使用junit4进行测试 @ContextConfiguration(locations = {"classpath:conf/core/monitor_v2-servlet.xml", "classpath:conf/core/monitor_v2_application.xml"}) @WebAppConfiguration public class BaseJunit4Test { }
精选资源
spring-context-support-4.2.2和quartz-2.2.3所需Jar包
03-02
标题中的"spring-context-support-4.2.2和quartz-2.2.3所需Jar包"涉及到两个关键的Java库：Spring Context Support 4.2.2版本和Quartz Scheduler 2.2.3版本。这两个库在企业级Java应用开发中扮演着重要角色，特别是...
spring-context-4.2.xsd.zip
05-31
Spring Context模块是Spring框架的核心部分，它提供了一个统一的接口来管理应用对象，包括bean的创建、初始化、配置和查找。Context模块使得应用程序可以跨越不同层次和组件，实现松耦合和高可测试性。在Spring中，...
Spring加载context的几种方法
weixin_30954265的博客
07-20 252
Spring中的context管理 Spring中IOC容器的初始化： ApplicationContext即是保存bean对象的容器，故容器本身的初始化，就是通过一系列的配置，将ApplicationContext进行初始化。 而配置ApplicationContext大方向上分为了3中： 一、使用classpath 二、使用本地文件系统中某个文件地址 三、（SpringMVC）we...
Spring源码(三)-Context的创建(下)
liagnzi1259的专栏
08-24 434
由于该篇文章较多，所以就拆分为了上下两篇，接上面完成了beanFactory的信息处理，接下来是bean的相关定义的处理。1、BeanDefinition获取完beanFactory的之后，代码涉及到了一些bean的定义，接下来看beanDefination的定义。 - 1、BeanDefinition 设计bean相关信息 - 2、BeanDefinitionHolder 封装bean定义
Spring源码(二)-Context的创建(上)
liagnzi1259的专栏
08-24 727
我们前一章介绍了spring的整体架构以及模块划分，也已经将代码导入ide中，那么接下来就要开始让人心动的Spring源码之旅了。1、默认的Spring启动器@SpringBootApplication @ComponentScan(basePackages = {"com"}) public class SpringSourceApplication { public static voi
关于Spring ApplicationContext和Bean创建
csgarten的博客
07-23 5823
       在社区中似乎存在很多关于如何表达bean配置的困惑，或者更确切地说如何将bean配置从XML转换为Java（或Groovy，或Kotlin，或......），因为它看起来好像不同的配置方式产生的是完全不同的东西。        但事实上，它们或多或少是以格式（Java，XML，Properties）表示的配置，以指示Spring ApplicationContext（实际上是Bea...
spring开发小记：ApplicationContext 的创建
Jimmy.lu的专栏
10-24 2005
 创建ApplicationContext有两种方式，最常用的一种方式就是以声明的方式创建，如使用ContextLoader,这也是绝大多数web应用采用的一种方式。另一种方式就是用ApplicationContext的借口实现类以编程的方式实现。在这里我主要讲一下声明方式的实现及其原理：首先讲一下ContextLoader接口，它有两个实现:ContextLoaderListener
Spring初始化时创建容器和applicationContext.xml 配置文件的存放位置（四）
Annn_kk的博客
03-16 1712
在web项目中，每次请求都会创建一个Spring的工厂（容器），这样浪费服务器资源，所以一个项目只应该有一个工厂（容器）。 解决方法是： 在服务器启动的时候，创建一个工厂 创建完工厂，把这个工厂类保存到ServletContext中 每次使用的时候，就从ServletContext中获取。 使用Spring的核心监听器ContextLodaerListener 需要引入spring...
【框架篇】Spring 创建与使用介绍
小杨的博客
07-09 2922
核心重点： 1，Spring 创建与使用流程？ 2，获取 Spring 对象的两种方式？区别? 3，获取 Bean 对象的三种方式?
创建Spring应用上下文
jiuweideqixu的博客
01-09 500
1、启动类 package com.imooc.springapplication; import org.springframework.boot.WebApplicationType; import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.bu...
java:程序包 org.springframework.context不存在
weixin_47617631的博客
02-04 789
java:程序包 org.springframework.context不存在 再运行测试类中的方法，问题解决 如果没有：
spring程序中获取 系统上下文找不到初始化对象
小武人生
05-29 1160
如果找不到上下文，请看调用时候的服务器时候有实例化过该对象，假如有就说明可以找到，否则找不到
spring如何创建context
最新发布
11-20
Spring创建`ApplicationContext`（即context）有多种常见的方法，以下为你详细介绍： ### 使用`ClassPathXmlApplicationContext` 从类路径中加载XML配置文件来创建`ApplicationContext`。示例代码如下： ```java import org.springframework.context.ApplicationContext; import org.springframework.context.support.ClassPathXmlApplicationContext; public class ClassPathXmlContextExample { public static void main(String[] args) { ApplicationContext context = new ClassPathXmlApplicationContext("applicationContext.xml"); } } ``` 这种方式适用于配置文件存放在类路径下的场景[^1]。 ### 使用`FileSystemXmlApplicationContext` 从文件系统中加载XML配置文件来创建`ApplicationContext`。示例代码如下： ```java import org.springframework.context.ApplicationContext; import org.springframework.context.support.FileSystemXmlApplicationContext; public class FileSystemXmlContextExample { public static void main(String[] args) { ApplicationContext context = new FileSystemXmlApplicationContext("C:/path/to/applicationContext.xml"); } } ``` 此方式可指定文件系统中的具体路径来加载配置文件。 ### 使用`AnnotationConfigApplicationContext` 基于Java注解配置来创建`ApplicationContext`。示例代码如下： ```java import org.springframework.context.annotation.AnnotationConfigApplicationContext; // 配置类 import org.springframework.context.annotation.Configuration; @Configuration class AppConfig { // 配置Bean的方法 } public class AnnotationConfigContextExample { public static void main(String[] args) { AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(AppConfig.class); } } ``` 适用于使用Java注解进行配置的项目。 ### Spring Boot中创建`ApplicationContext` Spring Boot启动过程中，在`createApplicationContext()`方法里，通过一个工厂来创建`ApplicationContext`。示例代码如下： ```java protected ConfigurableApplicationContext createApplicationContext() { return this.applicationContextFactory.create(this.webApplicationType); } ``` Spring Boot会根据应用类型（如Web应用或非Web应用）来创建合适的`ApplicationContext` [^2]。 ### 通过`XmlBeanFactory`（较旧的方式） 结合`ClassPathResource`使用，从类路径加载XML文件创建`BeanFactory`。示例代码如下： ```java import org.springframework.beans.factory.BeanFactory; import org.springframework.beans.factory.xml.XmlBeanFactory; import org.springframework.core.io.ClassPathResource; public class XmlBeanFactoryExample { public static void main(String[] args) { BeanFactory factory = new XmlBeanFactory(new ClassPathResource("applicationContext.xml")); } } ``` 不过`XmlBeanFactory`已被标记为过时，不建议在新的项目中使用 [^3]。
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值