前言
ApplicationContextInitializer在spring中毁嗦,也是一個(gè)比較重要的擴(kuò)展點(diǎn)蓉媳,使用ApplicationContextInitializer可以向容器中注入一些組件散吵。
示例
定義一個(gè)類實(shí)現(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的正常啟動(dòng)程序也是通過這個(gè)擴(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);
}
邏輯很簡(jiǎn)單,就是springboot程序的一個(gè)擴(kuò)展點(diǎn)瓷们。這里需要注意的是盟猖,ApplicationContextInitializer有三種方式加載。
第一種换棚,配置類里用context.initializer.classes定義
第二種式镐,在 resources/META-INF/spring.factories 中配置
第三種,在啟動(dòng)類里用SpringApplication類的addInitializers()方法
簡(jiǎn)單說一下啟動(dòng)順序固蚤, run方法啟動(dòng)之前娘汞,會(huì)先初始化當(dāng)前類SpringApplication,SpringApplication初始化的時(shí)候夕玩,會(huì)從spring.factories中加載定義為ApplicationContextInitializer的類你弦,然后再走第三種方式使用addInitializers()方法加載寫在啟動(dòng)類的ApplicationContextInitializer類。之后就是走run方法燎孟,走到applyInitializers(context); 然后遍歷執(zhí)行所有的ApplicationContextInitializer實(shí)現(xiàn)類禽作。
重點(diǎn):
springboot內(nèi)置了一個(gè)DelegatingApplicationContextInitializer類。這個(gè)類實(shí)現(xiàn)了order接口揩页,優(yōu)先級(jí)是最高的旷偿,所有遍歷執(zhí)行的時(shí)候是先執(zhí)行這個(gè)類的initialize()方法。這個(gè)類的initialize()方法會(huì)從配置文件中加載定義為ApplicationContextInitializer的類爆侣,然后遍歷執(zhí)行萍程。源碼很簡(jiǎn)單,大家點(diǎn)進(jìn)去看一下兔仰。
總結(jié):
第二種方式先加載茫负,第三種方式后加載,然后執(zhí)行的時(shí)候DelegatingApplicationContextInitializer先執(zhí)行乎赴,然后加載第一種方式的類執(zhí)行忍法。
三種加載方式潮尝, 加載順序是231, 執(zhí)行順序是123饿序∶闶В可以通過@order注解改變23的執(zhí)行順序,但是改變不了1嗤堰, 從而保證本地配置優(yōu)先執(zhí)行戴质。
引申
執(zhí)行完applyInitializers(context);方法后度宦,上下文發(fā)布了一個(gè)ApplicationContextInitializedEvent事件踢匣,但是這個(gè)事件目前沒有人監(jiān)聽。為啥不寫個(gè)監(jiān)聽類戈抄,然后把a(bǔ)pplyInitializers(context);方法放到監(jiān)聽類的邏輯里呢离唬?不知道是有什么特殊的含義還是代碼就是這么設(shè)計(jì)的。有答案也歡迎留言划鸽。