springboot ApplicationContextInitializer的三種使用方法小結

Posted on by

ApplicationContextInitializer的三種使用方法

概述

ApplicationContextInitializer是在springboot啟動過程(refresh方法前)調用，主要是在ApplicationContextInitializer中initialize方法中拉起瞭ConfigurationClassPostProcessor這個類(我在springboot啟動流程中有描述)，通過這個processor實現瞭beandefinition。

言歸正傳，ApplicationContextInitializer實現主要有3中方式：

1、使用spring.factories方式

首先我們自定義個類實現瞭ApplicationContextInitializer,然後在resource下面新建/META-INF/spring.factories文件。

 
public class Demo01ApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
    @Override
    public void initialize(ConfigurableApplicationContext configurableApplicationContext) {
        System.out.println("user add method ==> ApplicationContextInitializer");
    }
}

這個加載過程是在SpringApplication中的getSpringFactoriesInstances()方法中直接加載並實例後執行對應的initialize方法。代碼如下：

private <T> Collection<? extends T> getSpringFactoriesInstances(Class<T> type,
			Class<?>[] parameterTypes, Object... args) {
		ClassLoader classLoader = Thread.currentThread().getContextClassLoader();
		// Use names and ensure unique to protect against duplicates
		Set<String> names = new LinkedHashSet<String>(
				SpringFactoriesLoader.loadFactoryNames(type, classLoader));
		List<T> instances = createSpringFactoriesInstances(type, parameterTypes,
				classLoader, args, names);
		AnnotationAwareOrderComparator.sort(instances);
		return instances;
	}

2、application.properties添加配置方式

對於這種方式是通過DelegatingApplicationContextInitializer這個初始化類中的initialize方法獲取到application.properties中context.initializer.classes對應的類並執行對應的initialize方法。

隻需要將實現瞭ApplicationContextInitializer的類添加到application.properties即可。如下：

下面我們看看DelegatingApplicationContextInitializer是如何加載的。看代碼：

private static final String PROPERTY_NAME = "context.initializer.classes";
private List<Class<?>> getInitializerClasses(ConfigurableEnvironment env) {
		String classNames = env.getProperty(PROPERTY_NAME);
		List<Class<?>> classes = new ArrayList<Class<?>>();
		if (StringUtils.hasLength(classNames)) {
			for (String className : StringUtils.tokenizeToStringArray(classNames, ",")) {
				classes.add(getInitializerClass(className));
			}
		}
		return classes;
	}

是從配置文件中獲取到對應的初始化類信息，然後執行初始化方法。

3、直接通過add方法

這個方法就比較簡單，直接在springboot啟動的時候，add一個實現瞭ApplicationContextInitializer的類即可，代碼如下：

@SpringBootApplication
public class InitializerDemoApplication { 
	public static void main(String[] args) {
		//type01
		SpringApplication springApplication = new SpringApplication(InitializerDemoApplication.class);
		springApplication.addInitializers(new Demo01ApplicationContextInitializer());
		springApplication.run(args);
 
		//SpringApplication.run(InitializerDemoApplication.class,args);
	}
}

以上3中方法都可以實現自定義的Initializer，隻不過執行的順序有差異。這裡我比較感興趣有2個，一個通過spring.factories實現SPI模式，有興趣的可以看下jdbc-starter等一些相關springboot starter。

第二個就是作為一個鉤子去拉起來”一坨”的bean。

ApplicationContextInitializer都幹瞭些什麼

初始化方法

org.springframework.boot.context.config.DelegatingApplicationContextInitializer

 @Override
 public void initialize(ConfigurableApplicationContext context) {
  ConfigurableEnvironment environment = context.getEnvironment();
  /**
  * 初始化環境變量中的context.initializer.classes指定的類
  **/
  List<Class<?>> initializerClasses = getInitializerClasses(environment);
  if (!initializerClasses.isEmpty()) {
   applyInitializerClasses(context, initializerClasses);
  }
 }

也就是說沒有定義的話，就不會初始化瞭。

org.springframework.boot.autoconfigure.SharedMetadataReaderFactoryContextInitializer

 @Override
 public void initialize(ConfigurableApplicationContext applicationContext) {
  /**
  * 註冊一個元數據讀取的工廠類
  **/
  applicationContext.addBeanFactoryPostProcessor(new CachingMetadataReaderFactoryPostProcessor());
 }

org.springframework.boot.context.ContextIdApplicationContextInitializer

 @Override
 public void initialize(ConfigurableApplicationContext applicationContext) {
  ContextId contextId = getContextId(applicationContext);
  applicationContext.setId(contextId.getId());
  /**
  * 註冊一個ContextId對象
  **/
  applicationContext.getBeanFactory().registerSingleton(ContextId.class.getName(), contextId);
 }

org.springframework.boot.context.ConfigurationWarningsApplicationContextInitializer

 @Override
 public void initialize(ConfigurableApplicationContext context) {
  /**
  * 註入ComponentScan檢查處理對象
  **/
  context.addBeanFactoryPostProcessor(new ConfigurationWarningsPostProcessor(getChecks()));
 }

org.springframework.boot.rsocket.context.RSocketPortInfoApplicationContextInitializer

 @Override
 public void initialize(ConfigurableApplicationContext applicationContext) {
   /**
  * 註入一個端口檢查和設置的監聽器，對應的事件RSocketServerInitializedEvent
  **/
  applicationContext.addApplicationListener(new Listener(applicationContext));
 }

org.springframework.boot.web.context.ServerPortInfoApplicationContextInitializer

 @Override
 public void initialize(ConfigurableApplicationContext applicationContext) {
  /**
   註冊瞭一個監聽org.springframework.boot.web.context.WebServerInitializedEvent事件的監聽器，用於設置端口信息
  **/
  applicationContext.addApplicationListener(this);
 }

org.springframework.boot.autoconfigure.logging.ConditionEvaluationReportLoggingListener

 @Override
 public void initialize(ConfigurableApplicationContext applicationContext) {
  this.applicationContext = applicationContext;
  applicationContext.addApplicationListener(new ConditionEvaluationReportListener());
  if (applicationContext instanceof GenericApplicationContext) {
   // Get the report early in case the context fails to load
   // 註冊一個監聽ApplicationEvent事件的監聽器用於打印自動配置後的日志信息
   this.report = ConditionEvaluationReport.get(this.applicationContext.getBeanFactory());
  }
 }

所有的這些初始化類都沒偶進行啟動服務的實質性操作，都是通過註冊對象，埋點，後面invokeBeanFactoryPostProcessors才真正調用初始化方法，而且在項目啟動之前

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：