前言
ApplicationContextInitializer在spring中,也是一个比较重要的扩展点,使用ApplicationContextInitializer可以向容器中注入一些组件。
示例
定义一个类实现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已加载进spring上下文");
}
}
可以看到可以向spring上下文中添加BeanFactoryPostProcessor,ApplicationListener以及ProtocolResolver。或者,也可以执行自己的代码逻辑。比如apollo的正常启动程序也是通过这个扩展接口接入的。
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);
// 进入到上面方法,在这里执行。
applyInitializers(context);
// 然后遍历执行所有的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程序的一个扩展点。这里需要注意的是,ApplicationContextInitializer有三种方式加载。
第一种,配置类里用context.initializer.classes定义
第二种,在 resources/META-INF/spring.factories 中配置
第三种,在启动类里用SpringApplication类的addInitializers()方法
简单说一下启动顺序, run方法启动之前,会先初始化当前类SpringApplication,SpringApplication初始化的时候,会从spring.factories中加载定义为ApplicationContextInitializer的类,然后再走第三种方式使用addInitializers()方法加载写在启动类的ApplicationContextInitializer类。之后就是走run方法,走到applyInitializers(context); 然后遍历执行所有的ApplicationContextInitializer实现类。
重点:
springboot内置了一个DelegatingApplicationContextInitializer类。这个类实现了order接口,优先级是最高的,所有遍历执行的时候是先执行这个类的initialize()方法。这个类的initialize()方法会从配置文件中加载定义为ApplicationContextInitializer的类,然后遍历执行。源码很简单,大家点进去看一下。
总结:
第二种方式先加载,第三种方式后加载,然后执行的时候DelegatingApplicationContextInitializer先执行,然后加载第一种方式的类执行。
三种加载方式, 加载顺序是231, 执行顺序是123。可以通过@order注解改变23的执行顺序,但是改变不了1, 从而保证本地配置优先执行。
引申
执行完applyInitializers(context);方法后,上下文发布了一个ApplicationContextInitializedEvent事件,但是这个事件目前没有人监听。为啥不写个监听类,然后把applyInitializers(context);方法放到监听类的逻辑里呢?不知道是有什么特殊的含义还是代码就是这么设计的。有答案也欢迎留言。