应用启动过程——刷新应用上下文

92 阅读4分钟

由SpringApplication#refreshContext容易定位到实际执行的方法是AbstractApplicationContext#refresh,refresh方法中几乎包含了ApplicationContext的全部功能。

public void refresh() throws BeansException, IllegalStateException {
   synchronized (this.startupShutdownMonitor) {
      StartupStep contextRefresh = this.applicationStartup.start("spring.context.refresh");

    	//(1)准备刷新的上下文环境
      // Prepare this context for refreshing.
      prepareRefresh();

    	//(2)获取BeanFactory(子类覆写)
      // Tell the subclass to refresh the internal bean factory.
      ConfigurableListableBeanFactory beanFactory = obtainFreshBeanFactory();

    	//(3)对BeanFactory进行各种功能填充
      // Prepare the bean factory for use in this context.
      prepareBeanFactory(beanFactory);

      try {
         //(4)做额外的后置处理(子类覆写)
         // Allows post-processing of the bean factory in context subclasses.
         postProcessBeanFactory(beanFactory);

         StartupStep beanPostProcess = this.applicationStartup.start("spring.context.beans.post-process");

      	 //(5)回调各种BeanFactoryPostProcessor处理器
				 // Invoke factory processors registered as beans in the context.
         invokeBeanFactoryPostProcessors(beanFactory);

         //(6)注册BeanPostProcessor,这里只是注册,真正的调用发生在bean创建时
         // Register bean processors that intercept bean creation.
         registerBeanPostProcessors(beanFactory);
         beanPostProcess.end();

      	 //(7)为应用上下文初始化Message源,即不同语言的消息体,国际化处理
         // Initialize message source for this context.
         initMessageSource();

      	 //(8)为应用上下文初始化应用事件广播器
         // Initialize event multicaster for this context.
         initApplicationEventMulticaster();

         //(9)留给子类覆写,来初始化其它的bean
         // Initialize other special beans in specific context subclasses.
         onRefresh();

         //(10)查找所有的ApplicationListener bean,将其注册到应用事件广播器中
         // Check for listener beans and register them.
         registerListeners();

      	 //(11)初始化剩下的单实例bean(非惰性的)
         // Instantiate all remaining (non-lazy-init) singletons.
         finishBeanFactoryInitialization(beanFactory);

      	 //(12)完成刷新过程,通知生命周期处理器LifecycleProessor刷新过程,同时发出ContextRefreshedEvent事件通知
         // Last step: publish corresponding event.
         finishRefresh();
      }

      catch (BeansException ex) {
         if (logger.isWarnEnabled()) {
            logger.warn("Exception encountered during context initialization - " +
                  "cancelling refresh attempt: " + ex);
         }

         // Destroy already created singletons to avoid dangling resources.
         destroyBeans();

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

         // Propagate exception to caller.
         throw ex;
      }

      finally {
         // Reset common introspection caches in Spring's core, since we
         // might not ever need metadata for singleton beans anymore...
         resetCommonCaches();
         contextRefresh.end();
      }
   }
}

1 准备刷新

protected void prepareRefresh() {
   // Switch to active.
   this.startupDate = System.currentTimeMillis();
   this.closed.set(false);
   this.active.set(true);

   if (logger.isDebugEnabled()) {
      if (logger.isTraceEnabled()) {
         logger.trace("Refreshing " + this);
      }
      else {
         logger.debug("Refreshing " + getDisplayName());
      }
   }

	 (1.1)允许子类覆写方法,实现初始化相关属性源
   // Initialize any placeholder property sources in the context environment.
   initPropertySources();

	 (1.2)校验必填属性
   // Validate that all properties marked as required are resolvable:
   // see ConfigurablePropertyResolver#setRequiredProperties
   getEnvironment().validateRequiredProperties();

   // Store pre-refresh ApplicationListeners...
   if (this.earlyApplicationListeners == null) {
      this.earlyApplicationListeners = new LinkedHashSet<>(this.applicationListeners);
   }
   else {
      // Reset local application listeners to pre-refresh state.
      this.applicationListeners.clear();
      this.applicationListeners.addAll(this.earlyApplicationListeners);
   }

   // Allow for the collection of early ApplicationEvents,
   // to be published once the multicaster is available...
   this.earlyApplicationEvents = new LinkedHashSet<>();
}

(1.1)prepareRefresh主要是做些准备工作,允许子类覆写相关方法初始化属性源,并对属性进行必填验证等。比如当前工程中应用上下文实际类型是AnnotationConfigServletWebServerApplicationContext,在它继承的GenericWebApplicationContext中,可以找到覆写的initPropertySources方法,

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

(1.2)执行initPropertySources后,prepareRefresh还会调用Environment的validateRequiredProperties方法,对属性进行必填验证。可以通过setRequiredProperties方法指定对那些属性进行验证,默认情况下,并没有需要验证的属性。

2 获取BeanFactory

protected ConfigurableListableBeanFactory obtainFreshBeanFactory() {
   refreshBeanFactory();
   return getBeanFactory();
}

obtainFreshBeanFactory的核心是子类实现的refreshBeanFactory方法,

/**
 * Subclasses must implement this method to perform the actual configuration load.
 * The method is invoked by {@link #refresh()} before any other initialization work.
 * <p>A subclass will either create a new bean factory and hold a reference to it,
 * or return a single BeanFactory instance that it holds. In the latter case, it will
 * usually throw an IllegalStateException if refreshing the context more than once.
 * @throws BeansException if initialization of the bean factory failed
 * @throws IllegalStateException if already initialized and multiple refresh
 * attempts are not supported
 */
protected abstract void refreshBeanFactory() throws BeansException, IllegalStateException;

通过refreshBeanFactory的方法注释可以了解到,方法实现应当是返回一个持有的BeanFactory,且如果被多次调用通常会抛异常,看下GenericWebApplicationContext的实现

/**
 * Do nothing: We hold a single internal BeanFactory and rely on callers
 * to register beans through our public methods (or the BeanFactory's).
 * @see #registerBeanDefinition
 */
@Override
protected final void refreshBeanFactory() throws IllegalStateException {
   if (!this.refreshed.compareAndSet(false, true)) {
      throw new IllegalStateException(
            "GenericApplicationContext does not support multiple refresh attempts: just call 'refresh' once");
   }
   this.beanFactory.setSerializationId(getId());
}

说的是啥也没做,就把当前持有的beanFactory返回了,为什么啥也不做呢,因为依赖callers调用registerBeanDefinition方法去注册bean,也就是说BeanFactory的主要工作在registerBeanDefinition方法中。

3 准备BeanFactory

/**
 * Configure the factory's standard context characteristics,
 * such as the context's ClassLoader and post-processors.
 * @param beanFactory the BeanFactory to configure
 */
protected void prepareBeanFactory(ConfigurableListableBeanFactory beanFactory) {
   // Tell the internal bean factory to use the context's class loader etc.
   beanFactory.setBeanClassLoader(getClassLoader());
   if (!shouldIgnoreSpel) {
      beanFactory.setBeanExpressionResolver(new StandardBeanExpressionResolver(beanFactory.getBeanClassLoader()));
   }
   beanFactory.addPropertyEditorRegistrar(new ResourceEditorRegistrar(this, getEnvironment()));

   // Configure the bean factory with context callbacks.
   beanFactory.addBeanPostProcessor(new ApplicationContextAwareProcessor(this));
   beanFactory.ignoreDependencyInterface(EnvironmentAware.class);
   beanFactory.ignoreDependencyInterface(EmbeddedValueResolverAware.class);
   beanFactory.ignoreDependencyInterface(ResourceLoaderAware.class);
   beanFactory.ignoreDependencyInterface(ApplicationEventPublisherAware.class);
   beanFactory.ignoreDependencyInterface(MessageSourceAware.class);
   beanFactory.ignoreDependencyInterface(ApplicationContextAware.class);
   beanFactory.ignoreDependencyInterface(ApplicationStartupAware.class);

   // BeanFactory interface not registered as resolvable type in a plain factory.
   // MessageSource registered (and found for autowiring) as a bean.
   beanFactory.registerResolvableDependency(BeanFactory.class, beanFactory);
   beanFactory.registerResolvableDependency(ResourceLoader.class, this);
   beanFactory.registerResolvableDependency(ApplicationEventPublisher.class, this);
   beanFactory.registerResolvableDependency(ApplicationContext.class, this);

   // Register early post-processor for detecting inner beans as ApplicationListeners.
   beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(this));

   // Detect a LoadTimeWeaver and prepare for weaving, if found.
   if (!NativeDetector.inNativeImage() && beanFactory.containsBean(LOAD_TIME_WEAVER_BEAN_NAME)) {
      beanFactory.addBeanPostProcessor(new LoadTimeWeaverAwareProcessor(beanFactory));
      // Set a temporary ClassLoader for type matching.
      beanFactory.setTempClassLoader(new ContextTypeMatchClassLoader(beanFactory.getBeanClassLoader()));
   }

   // Register default environment beans.
   if (!beanFactory.containsLocalBean(ENVIRONMENT_BEAN_NAME)) {
      beanFactory.registerSingleton(ENVIRONMENT_BEAN_NAME, getEnvironment());
   }
   if (!beanFactory.containsLocalBean(SYSTEM_PROPERTIES_BEAN_NAME)) {
      beanFactory.registerSingleton(SYSTEM_PROPERTIES_BEAN_NAME, getEnvironment().getSystemProperties());
   }
   if (!beanFactory.containsLocalBean(SYSTEM_ENVIRONMENT_BEAN_NAME)) {
      beanFactory.registerSingleton(SYSTEM_ENVIRONMENT_BEAN_NAME, getEnvironment().getSystemEnvironment());
   }
   if (!beanFactory.containsLocalBean(APPLICATION_STARTUP_BEAN_NAME)) {
      beanFactory.registerSingleton(APPLICATION_STARTUP_BEAN_NAME, getApplicationStartup());
   }
}

prepareBeanFactory主要做了这几种事情:

给BeanFactory设置一些属性,如

添加一些BeanPostProcessor

如ApplicationContextAwareProcessor