1. /**
2. * Initialize the root web application context.
3. */
4. @Override
5. public void contextInitialized(ServletContextEvent event) {
6. initWebApplicationContext(event.getServletContext());
7. }

1. /**
2. * Initialize Spring's web application context for the given servlet context,
3. * using the application context provided at construction time, or creating a new one
4. * according to the "{@link #CONTEXT_CLASS_PARAM contextClass}" and
5. * "{@link #CONFIG_LOCATION_PARAM contextConfigLocation}" context-params.
6. * @param servletContext current servlet context
7. * @return the new WebApplicationContext
8. * @see #ContextLoader(WebApplicationContext)
9. * @see #CONTEXT_CLASS_PARAM
10. * @see #CONFIG_LOCATION_PARAM
11. */
12. public WebApplicationContext initWebApplicationContext(ServletContext servletContext) {
13. //这里判断是否在ServletContext中存在上下文,如果有，说明已载入过或配置文件出错,可以从错误信息中看出
14. if (servletContext.getAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE) != ) {
15. throw new IllegalStateException(
16. "Cannot initialize context because there is already a root application context present - " +
17. "check whether you have multiple ContextLoader* definitions in your web.xml!");
18. }
19. Log logger = LogFactory.getLog(ContextLoader.class);
20. servletContext.log("Initializing Spring root WebApplicationContext");
21. if (logger.isInfoEnabled()) {
22. logger.info("Root WebApplicationContext: initialization started");
23. }
24. long startTime = System.currentTimeMillis();
25. try {
26. // Store context in local instance variable, to guarantee that
27. // it is available on ServletContext shutdown.
28. if (this.context == ) {
29. this.context = createWebApplicationContext(servletContext);
30. }
31. if (this.context instanceof ConfigurableWebApplicationContext) {
32. ConfigurableWebApplicationContext cwac = (ConfigurableWebApplicationContext) this.context;
33. if (!cwac.isActive()) {
34. // The context has not yet been refreshed -> provide services such as
35. // setting the parent context, setting the application context id, etc
36. if (cwac.getParent() == ) {
37. // The context instance was injected without an explicit parent ->
38. // determine parent for root web application context, if any.
39. // 这里载入根上下文的父上下文
40. ApplicationContext parent = loadParentContext(servletContext);
41. cwac.setParent(parent);
42. }
43. //这里从web.xml中取得相关的初始化参数,对WebApplicationContext进行初始化
44. configureAndRefreshWebApplicationContext(cwac, servletContext);
45. }
46. }
47. servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, this.context);
48. ClassLoader ccl = Thread.currentThread().getContextClassLoader();
49. if (ccl == ContextLoader.class.getClassLoader()) {
50. currentContext = this.context;
51. }
52. else if (ccl != ) {
53. currentContextPerThread.put(ccl, this.context);
54. }
55. if (logger.isDebugEnabled()) {
56. logger.debug("Published root WebApplicationContext as ServletContext attribute with name [" +
57. WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE + "]");
58. }
59. if (logger.isInfoEnabled()) {
60. long elapsedTime = System.currentTimeMillis() - startTime;
61. logger.info("Root WebApplicationContext: initialization completed in " + elapsedTime + " ms");
62. }
63. return this.context;
64. }
65. catch (RuntimeException ex) {
66. logger.error("Context initialization failed", ex);
67. servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, ex);
68. throw ex;
69. }
70. catch (Error err) {
71. logger.error("Context initialization failed", err);
72. servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, err);
73. throw err;
74. }
75. }

1. /**
2. * Instantiate the root WebApplicationContext for this loader, either the
3. * default context class or a custom context class if specified.
4. * <p>This implementation expects custom contexts to implement the
5. * {@link ConfigurableWebApplicationContext} interface.
6. * Can be overridden in subclasses.
7. * <p>In addition, {@link #customizeContext} gets called prior to refreshing the
8. * context, allowing subclasses to perform custom modifications to the context.
9. * @param sc current servlet context
10. * @return the root WebApplicationContext
11. * @see ConfigurableWebApplicationContext
12. */
13. protected WebApplicationContext createWebApplicationContext(ServletContext sc) {
14. //这里需要确定我们载入的根WebApplication的类型，
15. //由在web.xml中配置的contextClass中配置的参数, 如果没有使用默认的。
16. Class<?> contextClass = determineContextClass(sc);
17. //contextClass必须实现ConfigurableWebApplicationContext，否则抛异常
18. if (!ConfigurableWebApplicationContext.class.isAssignableFrom(contextClass)) {
19. throw new ApplicationContextException("Custom context class [" + contextClass.getName() +
20. "] is not of type [" + ConfigurableWebApplicationContext.class.getName() + "]");
21. }
22. //初始化WebApplication，强转成ConfigurableWebApplicationContext
23. return (ConfigurableWebApplicationContext) BeanUtils.instantiateClass(contextClass);
24. }

1. /**
2. * Return the WebApplicationContext implementation class to use, either the
3. * default XmlWebApplicationContext or a custom context class if specified.
4. * @param servletContext current servlet context
5. * @return the WebApplicationContext implementation class to use
6. * @see #CONTEXT_CLASS_PARAM
7. * @see org.springframework.web.context.support.XmlWebApplicationContext
8. */
9. protected Class<?> determineContextClass(ServletContext servletContext) {
10. String contextClassName = servletContext.getInitParameter(CONTEXT_CLASS_PARAM);
11. if (contextClassName != ) {
12. try {
13. return ClassUtils.forName(contextClassName, ClassUtils.getDefaultClassLoader());
14. }
15. catch (ClassNotFoundException ex) {
16. throw new ApplicationContextException(
17. "Failed to load custom context class [" + contextClassName + "]", ex);
18. }
19. }
20. else {
21. contextClassName = defaultStrategies.getProperty(WebApplicationContext.class.getName());
22. try {
23. return ClassUtils.forName(contextClassName, ContextLoader.class.getClassLoader());
24. }
25. catch (ClassNotFoundException ex) {
26. throw new ApplicationContextException(
27. "Failed to load default context class [" + contextClassName + "]", ex);
28. }
29. }
30. }

1. /**
2. * Name of the class path resource (relative to the ContextLoader class)
3. * that defines ContextLoader's default strategy names.
4. */
5. private static final String DEFAULT_STRATEGIES_PATH = "ContextLoader.properties";
6. private static final Properties defaultStrategies;
7. static {
8. // Load default strategy implementations from properties file.
9. // This is currently strictly internal and not meant to be customized
10. // by application developers.
11. try {
12. ClassPathResource resource = new ClassPathResource(DEFAULT_STRATEGIES_PATH, ContextLoader.class);
13. defaultStrategies = PropertiesLoaderUtils.loadProperties(resource);
14. }
15. catch (IOException ex) {
16. throw new IllegalStateException("Could not load 'ContextLoader.properties': " + ex.getMessage());
17. }
18. }

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

根据在web.xml中配置的locatorFactorySelector和parentContextKey来给根web应用上下设置父上下文，如果没配置的话，父上下文为空。

1.WebApplicationContext wac = ContextLoader.getCurrentWebApplicationContext();

当前应用的WebApplicationContext就保存在 ContextLoader的currentContextPerThread属性当中

2.基于ServletContext上下文获取的方式

ServletContext sc = request.getSession().getServletContext();

ApplicationContext ac1 = WebApplicationContextUtils.getRequiredWebApplicationContext(sc);

ApplicationContext ac2 = WebApplicationContextUtils.getWebApplicationContext(sc);

WebApplicationContext wac1 = (WebApplicationContext) sc.getAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE);

3.还有一些更合适的，基于Spring提供的抽象类或者接口，在初始化Bean时注入ApplicationContext

3.1:继承自抽象类ApplicationObjectSupport

说明：抽象类ApplicationObjectSupport提供getApplicationContext()方法，可以方便的获取到ApplicationContext。

Spring初始化时，会通过该抽象类的setApplicationContext(ApplicationContext context)方法将ApplicationContext 对象注入。

3.2:继承自抽象类WebApplicationObjectSupport

说明：类似上面方法，调用getWebApplicationContext()获取WebApplicationContext

3.3:实现接口ApplicationContextAware

说明：实现该接口的setApplicationContext(ApplicationContext context)方法，并保存ApplicationContext 对象。