前言
ApplicationContextInitializer在spring中,也是一個比較重要的擴(kuò)展點,使用ApplicationContextInitializer可以向容器中注入一些組件。
示例
定義一個類實現(xiàn)ApplicationContextInitializer接口
@Slf4j
public class MyApplicationContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
@Override
public void initialize(ConfigurableApplicationContext applicationContext) {
FirstBeanDefinitionRegistryPostProcessor processor = new FirstBeanDefinitionRegistryPostProcessor();
applicationContext.addBeanFactoryPostProcessor(processor);
applicationContext.addApplicationListener(null);
applicationContext.addProtocolResolver(null);
log.info("自定義BeanDefinitionRegistryPostProcessor已加載進(jìn)spring上下文");
}
}
可以看到可以向spring上下文中添加BeanFactoryPostProcessor,ApplicationListener以及ProtocolResolver。或者,也可以執(zhí)行自己的代碼邏輯。比如apollo的正常啟動程序也是通過這個擴(kuò)展接口接入的。
public class ApolloApplicationContextInitializer implements
ApplicationContextInitializer<ConfigurableApplicationContext> , EnvironmentPostProcessor, Ordered {
@Override
public void initialize(ConfigurableApplicationContext context) {
ConfigurableEnvironment environment = context.getEnvironment();
if (!environment.getProperty(PropertySourcesConstants.APOLLO_BOOTSTRAP_ENABLED, Boolean.class, false)) {
logger.debug("Apollo bootstrap config is not enabled for context {}, see property: ${{}}", context, PropertySourcesConstants.APOLLO_BOOTSTRAP_ENABLED);
return;
}
logger.debug("Apollo bootstrap config is enabled for context {}", context);
initialize(environment);
}
}
源碼
入口是在SpringApplication的run()方法中:
prepareContext(bootstrapContext, context, environment, listeners, applicationArguments, printedBanner);
// 進(jìn)入到上面方法,在這里執(zhí)行。
applyInitializers(context);
// 然后遍歷執(zhí)行所有的initializers
for (ApplicationContextInitializer initializer : getInitializers()) {
Class<?> requiredType = GenericTypeResolver.resolveTypeArgument(initializer.getClass(),
ApplicationContextInitializer.class);
Assert.isInstanceOf(requiredType, context, "Unable to call initializer.");
initializer.initialize(context);
}
邏輯很簡單,就是springboot程序的一個擴(kuò)展點。這里需要注意的是,ApplicationContextInitializer有三種方式加載。
第一種,配置類里用context.initializer.classes定義
第二種,在 resources/META-INF/spring.factories 中配置
第三種,在啟動類里用SpringApplication類的addInitializers()方法
簡單說一下啟動順序, run方法啟動之前,會先初始化當(dāng)前類SpringApplication,SpringApplication初始化的時候,會從spring.factories中加載定義為ApplicationContextInitializer的類,然后再走第三種方式使用addInitializers()方法加載寫在啟動類的ApplicationContextInitializer類。之后就是走run方法,走到applyInitializers(context); 然后遍歷執(zhí)行所有的ApplicationContextInitializer實現(xiàn)類。
重點:
springboot內(nèi)置了一個DelegatingApplicationContextInitializer類。這個類實現(xiàn)了order接口,優(yōu)先級是最高的,所有遍歷執(zhí)行的時候是先執(zhí)行這個類的initialize()方法。這個類的initialize()方法會從配置文件中加載定義為ApplicationContextInitializer的類,然后遍歷執(zhí)行。源碼很簡單,大家點進(jìn)去看一下。
總結(jié):
第二種方式先加載,第三種方式后加載,然后執(zhí)行的時候DelegatingApplicationContextInitializer先執(zhí)行,然后加載第一種方式的類執(zhí)行。
三種加載方式, 加載順序是231, 執(zhí)行順序是123??梢酝ㄟ^@order注解改變23的執(zhí)行順序,但是改變不了1, 從而保證本地配置優(yōu)先執(zhí)行。
引申
執(zhí)行完applyInitializers(context);方法后,上下文發(fā)布了一個ApplicationContextInitializedEvent事件,但是這個事件目前沒有人監(jiān)聽。為啥不寫個監(jiān)聽類,然后把a(bǔ)pplyInitializers(context);方法放到監(jiān)聽類的邏輯里呢?不知道是有什么特殊的含義還是代碼就是這么設(shè)計的。有答案也歡迎留言。