Spring容器初始化扩展点：ApplicationContextInitializer

一、什么是ApplicationContextInitializer？

  ApplicationContextInitializer是 Spring 框架提供的一个接口，用于在 Spring 应用上下文（ApplicationContext）革新之前对其举行自界说初始化。它答应开发者在上下文加载 Bean 界说之前，对上下文举行一些额外的配置或修改。
1、核心作用

• 在上下文革新之前执行自界说逻辑：例如设置情况属性、注册自界说的 Bean 界说、修改上下文配置等
  
• 扩展 Spring 上下文的功能：通过初始化器，可以在 Spring 启动的早期阶段介入，实现一些框架无法直接支持的功能
  

2、适用场景

• 在 Spring Boot 启动时，动态修改情况变量或配置文件
  
• 在上下文革新之前，注册自界说的 Bean 或后置处理器
  
• 在微服务架构中，根据不同的情况（如开发、测试、生产）初始化不同的配置
  

---

二、ApplicationContextInitializer的使用方式

1、实现ApplicationContextInitializer接口

  要实现一个自界说的初始化器，只需实现 ApplicationContextInitializer 接口，并重写其 initialize 方法。

1. import org.springframework.context.ApplicationContextInitializer;
2. import org.springframework.context.ConfigurableApplicationContext;
4. public class CustomContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
6.     @Override
7.     public void initialize(ConfigurableApplicationContext applicationContext) {
8.         // 在这里编写自定义的初始化逻辑
9.         System.out.println("CustomContextInitializer is initializing the ApplicationContext...");
11.         // 示例：设置自定义的环境变量
12.         applicationContext.getEnvironment().setActiveProfiles("dev");
13.     }
14. }

复制代码

2、注册初始化器

在 Spring 应用中，可以通过以下几种方式注册 ApplicationContextInitializer：
   方式 1：通过 Spring Boot 的 spring.factories 文件
  在 src/main/resources/META-INF/spring.factories 文件中添加以下内容：

1. org.springframework.context.ApplicationContextInitializer=com.example.CustomContextInitializer

复制代码

  方式 2：通过 Spring Boot 的 SpringApplication API
  在 Spring Boot 的主类中，通过 SpringApplication 注册初始化器：

1. import org.springframework.boot.SpringApplication;
2. import org.springframework.boot.autoconfigure.SpringBootApplication;
4. @SpringBootApplication
5. public class MyApplication {
7.     public static void main(String[] args) {
8.         SpringApplication application = new SpringApplication(MyApplication.class);
9.         application.addInitializers(new CustomContextInitializer());
10.         application.run(args);
11.     }
12. }

复制代码

  方式 3：通过 @ContextConfiguration 注解
  在 Spring 测试中，可以通过 @ContextConfiguration 注解注册初始化器：

1. @ContextConfiguration(initializers = CustomContextInitializer.class)
2. public class MyTest {
3.     // 测试代码
4. }

复制代码

---

三、ApplicationContextInitializer的执行机遇

  ApplicationContextInitializer 的执行机遇是在 ApplicationContext 创建之后、革新之前。具体来说，它发生在以下两个步骤之间：

• ApplicationContext 创建：
  
  
  
  • 在 SpringApplication.run() 方法中，ApplicationContext 被创建，但尚未革新
    
  
  
• ApplicationContext 革新：
  
  
  
  • 在 ApplicationContext 创建之后，Spring 会调用 ApplicationContextInitializer 的 initialize() 方法，答应开发者对上下文举行自界说初始化
    
  • 之后，Spring 会调用 ApplicationContext 的 refresh() 方法，正式革新上下文
    
  
  

   为什么在这个机遇执行？
    ApplicationContextInitializer 的设计目的是在上下文革新之前，答应开发者对上下文举行一些自界说的初始化操作。这个机遇的选择有以下几点考虑：

• ApplicationContext 已创建：
  
  
  
  • 此时 ApplicationContext 已经创建，开发者可以通过 ConfigurableApplicationContext 访问上下文，并举行一些自界说配置
    
  
  
• 上下文尚未革新：
  
  
  
  • 此时上下文尚未革新，Bean 界说尚未加载，开发者可以通过 ApplicationContextInitializer 动态注册或修改 Bean 界说
    
  
  

---

四、现实应用案例

1、动态设置情况变量

  在某些场景下，可能需要根据运行情况动态设置情况变量。例如，在开发情况中启用调试模式，在生产情况中禁用调试模式。

1. public class EnvironmentInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
3.     @Override
4.     public void initialize(ConfigurableApplicationContext applicationContext) {
5.         String env = System.getProperty("env");
6.         if ("dev".equals(env)) {
7.             applicationContext.getEnvironment().setActiveProfiles("dev");
8.         } else if ("prod".equals(env)) {
9.             applicationContext.getEnvironment().setActiveProfiles("prod");
10.         }
11.     }
12. }

复制代码

2、注册自界说的 Bean 界说

  在上下文革新之前，可以通过 BeanDefinitionRegistry 动态注册自界说的 Bean 界说。

1. import org.springframework.beans.factory.support.BeanDefinitionRegistry;
2. import org.springframework.context.ApplicationContextInitializer;
3. import org.springframework.context.ConfigurableApplicationContext;
4. import org.springframework.beans.factory.config.BeanDefinition;
6. public class CustomBeanInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {
8.     @Override
9.     public void initialize(ConfigurableApplicationContext applicationContext) {
10.         BeanDefinitionRegistry registry = (BeanDefinitionRegistry) applicationContext.getBeanFactory();
11.         BeanDefinition beanDefinition = ...; // 创建自定义的 BeanDefinition
12.         registry.registerBeanDefinition("customBean", beanDefinition);
13.     }
14. }

复制代码

---

五、注意事项

• 执行次序：
  
  
  
  • 假如有多个 ApplicationContextInitializer，它们的执行次序可以通过 Ordered 接口或 @Order 注解来控制
    
  
  
• 制止过早初始化：
  
  
  
  • 在 initialize 方法中，制止直接访问 Bean 或执行耗时的操作，因为此时上下文尚未完全初始化
    
  
  

六、总结

  ApplicationContextInitializer 是 Spring 框架中一个强大的扩展点，答应开发者在上下文革新之前对其举行自界说初始化。通过合理使用 ApplicationContextInitializer，可以实现动态配置、情况隔离、自界说 Bean 注册等功能，从而更好地满足复杂的业务需求。

免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。