springboot ApplicationContextInitializer的三種使用方法小結
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()方法中直接加載并實例后執(zhí)行對應的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對應的類并執(zhí)行對應的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;
}
是從配置文件中獲取到對應的初始化類信息,然后執(zhí)行初始化方法。
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,只不過執(zhí)行的順序有差異。這里我比較感興趣有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();
/**
* 初始化環(huán)境變量中的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) {
/**
* 注入一個端口檢查和設置的監(jiān)聽器,對應的事件RSocketServerInitializedEvent
**/
applicationContext.addApplicationListener(new Listener(applicationContext));
}
org.springframework.boot.web.context.ServerPortInfoApplicationContextInitializer
@Override
public void initialize(ConfigurableApplicationContext applicationContext) {
/**
注冊了一個監(jiān)聽org.springframework.boot.web.context.WebServerInitializedEvent事件的監(jiān)聽器,用于設置端口信息
**/
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
// 注冊一個監(jiān)聽ApplicationEvent事件的監(jiān)聽器用于打印自動配置后的日志信息
this.report = ConditionEvaluationReport.get(this.applicationContext.getBeanFactory());
}
}
所有的這些初始化類都沒偶進行啟動服務的實質性操作,都是通過注冊對象,埋點,后面invokeBeanFactoryPostProcessors才真正調用初始化方法,而且在項目啟動之前
以上為個人經驗,希望能給大家一個參考,也希望大家多多支持腳本之家。
相關文章
SpringBoot項目中使用Swagger2及注解解釋的詳細教程
Swagger2是一個開源項目,用于為RESTful Web服務生成REST API文檔,下面這篇文章主要給大家介紹了關于SpringBoot項目中使用Swagger2及注解解釋的詳細教程,文中通過實例代碼介紹的非常詳細,需要的朋友可以參考下2023-04-04
詳解Java數據庫連接JDBC基礎知識(操作數據庫:增刪改查)
這篇文章主要介紹了詳解Java數據庫連接JDBC基礎知識(操作數據庫:增刪改查),本文給大家介紹的非常詳細,對大家的學習或工作具有一定的參考借鑒價值,需要的朋友可以參考下2021-01-01
詳解使用JRebel插件實現SpringBoot應用代碼熱加載
這篇文章主要介紹了詳解使用JRebel插件實現SpringBoot應用代碼熱加載,文中通過示例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友們下面隨著小編來一起學習學習吧2019-10-10
關于Java中try finally return語句的執(zhí)行順序淺析
這篇文章主要介紹了關于Java中try finally return語句的執(zhí)行順序淺析,需要的朋友可以參考下2017-08-08

