目錄

• 一、什么是ApplicationContextInitializer？
• • 1、核心作用
  • 2、適用場景
• 二、ApplicationContextInitializer的使用方式
• • 1、實現ApplicationContextInitializer接口
  • 2、注冊初始化器
• 三、ApplicationContextInitializer的執行時機
• 四、實際應用案例
• • 1、動態設置環境變量
  • 2、注冊自定義的 Bean 定義
• 五、注意事項
• 六、總結

一、什么是ApplicationContextInitializer？

ApplicationContextInitializer是 Spring 框架提供的一個接口，用于在 Spring 應用上下文（ApplicationContext）刷新之前對其進行自定義初始化。它允許開發者在上下文加載 Bean 定義之前，對上下文進行一些額外的配置或修改。

1、核心作用

• 在上下文刷新之前執行自定義邏輯：例如設置環境屬性、注冊自定義的 Bean 定義、修改上下文配置等
• 擴展 Spring 上下文的功能：通過初始化器，可以在 Spring 啟動的早期階段介入，實現一些框架無法直接支持的功能

2、適用場景

• 在 Spring Boot 啟動時，動態修改環境變量或配置文件
• 在上下文刷新之前，注冊自定義的 Bean 或后置處理器
• 在微服務架構中，根據不同的環境（如開發、測試、生產）初始化不同的配置

---

二、ApplicationContextInitializer的使用方式

1、實現ApplicationContextInitializer接口

要實現一個自定義的初始化器，只需實現 ApplicationContextInitializer 接口，并重寫其 initialize 方法。

import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.ConfigurableApplicationContext;public class CustomContextInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {@Overridepublic void initialize(ConfigurableApplicationContext applicationContext) {// 在這里編寫自定義的初始化邏輯System.out.println("CustomContextInitializer is initializing the ApplicationContext...");// 示例：設置自定義的環境變量applicationContext.getEnvironment().setActiveProfiles("dev");}
}

2、注冊初始化器

在 Spring 應用中，可以通過以下幾種方式注冊 ApplicationContextInitializer：

方式 1：通過 Spring Boot 的 spring.factories 文件

在 src/main/resources/META-INF/spring.factories 文件中添加以下內容：

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

方式 2：通過 Spring Boot 的 SpringApplication API

在 Spring Boot 的主類中，通過 SpringApplication 注冊初始化器：

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;@SpringBootApplication
public class MyApplication {public static void main(String[] args) {SpringApplication application = new SpringApplication(MyApplication.class);application.addInitializers(new CustomContextInitializer());application.run(args);}
}

方式 3：通過 @ContextConfiguration 注解

在 Spring 測試中，可以通過 @ContextConfiguration 注解注冊初始化器：

@ContextConfiguration(initializers = CustomContextInitializer.class)
public class MyTest {// 測試代碼
}

---

三、ApplicationContextInitializer的執行時機

ApplicationContextInitializer 的執行時機是在 ApplicationContext 創建之后、刷新之前。具體來說，它發生在以下兩個步驟之間：

1. ApplicationContext 創建：
   • 在 SpringApplication.run() 方法中，ApplicationContext 被創建，但尚未刷新
2. ApplicationContext 刷新：
   • 在 ApplicationContext 創建之后，Spring 會調用 ApplicationContextInitializer 的 initialize() 方法，允許開發者對上下文進行自定義初始化
   • 之后，Spring 會調用 ApplicationContext 的 refresh() 方法，正式刷新上下文

為什么在這個時機執行？

ApplicationContextInitializer 的設計目的是在上下文刷新之前，允許開發者對上下文進行一些自定義的初始化操作。這個時機的選擇有以下幾點考慮：

• ApplicationContext 已創建：
  • 此時 ApplicationContext 已經創建，開發者可以通過 ConfigurableApplicationContext 訪問上下文，并進行一些自定義配置
• 上下文尚未刷新：
  • 此時上下文尚未刷新，Bean 定義尚未加載，開發者可以通過 ApplicationContextInitializer 動態注冊或修改 Bean 定義

---

四、實際應用案例

1、動態設置環境變量

在某些場景下，可能需要根據運行環境動態設置環境變量。例如，在開發環境中啟用調試模式，在生產環境中禁用調試模式。

public class EnvironmentInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {@Overridepublic void initialize(ConfigurableApplicationContext applicationContext) {String env = System.getProperty("env");if ("dev".equals(env)) {applicationContext.getEnvironment().setActiveProfiles("dev");} else if ("prod".equals(env)) {applicationContext.getEnvironment().setActiveProfiles("prod");}}
}

2、注冊自定義的 Bean 定義

在上下文刷新之前，可以通過 BeanDefinitionRegistry 動態注冊自定義的 Bean 定義。

import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.context.ApplicationContextInitializer;
import org.springframework.context.ConfigurableApplicationContext;
import org.springframework.beans.factory.config.BeanDefinition;public class CustomBeanInitializer implements ApplicationContextInitializer<ConfigurableApplicationContext> {@Overridepublic void initialize(ConfigurableApplicationContext applicationContext) {BeanDefinitionRegistry registry = (BeanDefinitionRegistry) applicationContext.getBeanFactory();BeanDefinition beanDefinition = ...; // 創建自定義的 BeanDefinitionregistry.registerBeanDefinition("customBean", beanDefinition);}
}

---

五、注意事項

1. 執行順序：
   • 如果有多個 ApplicationContextInitializer，它們的執行順序可以通過 Ordered 接口或 @Order 注解來控制
2. 避免過早初始化：
   • 在 initialize 方法中，避免直接訪問 Bean 或執行耗時的操作，因為此時上下文尚未完全初始化

六、總結

ApplicationContextInitializer 是 Spring 框架中一個強大的擴展點，允許開發者在上下文刷新之前對其進行自定義初始化。通過合理使用 ApplicationContextInitializer，可以實現動態配置、環境隔離、自定義 Bean 注冊等功能，從而更好地滿足復雜的業務需求。