SpringBoot之ApplicationContextInitializer的理解和使用

一、 ApplicationContextInitializer 介紹

　　首先看spring官網的介紹：

 　　翻譯一下：

• 用於在spring容器重新整理之前初始化Spring ConfigurableApplicationContext的回撥介面。（剪短說就是在容器重新整理之前呼叫該類的 initialize 方法。並將 ConfigurableApplicationContext 類的例項傳遞給該方法）
• 通常用於需要對應用程式上下文進行程式設計初始化的web應用程式中。例如，根據上下文環境註冊屬性源或啟用配置檔案等。
• 可排序的（實現Ordered介面，或者新增@Order註解）

　　看完這段解釋，為了講解方便，我們先看自定義 ApplicationContextInitializer 的三種方式。再通過SpringBoot的原始碼，分析生效的時間以及實現的功能等。

二、三種實現方式

　　首先新建一個類 MyApplicationContextInitializer 並實現 ApplicationContextInitializer 介面。

public class MyApplicationContextInitializer implements ApplicationContextInitializer {
    @Override
    public void initialize(ConfigurableApplicationContext applicationContext) {
        System.out.println("-----MyApplicationContextInitializer initialize-----");
    }
}

　　2.1、mian函式中新增

　　優雅的寫一個SpringBoot的main方法

@SpringBootApplication
public class MySpringBootApplication {
    public static void main(String[] args) {
        SpringApplication application = new SpringApplication(MySpringBootApplication.class);
        application.addInitializers(new MyApplicationContextInitializer());
        application.run(args);
    }
}

 

　　執行，檢視控制檯：生效了

　　

　　2.2、配置檔案中配置

context.initializer.classes=org.springframework.boot.demo.common.MyApplicationContextInitializer 

 

　　

　　2.3、SpringBoot的SPI擴充套件---META-INF/spring.factories中配置

org.springframework.context.ApplicationContextInitializer=org.springframework.boot.demo.common.MyApplicationContextInitializer

 

　　

 

三、排序問題

　　如圖所示改造一下mian方法。打一個斷點，debug檢視排序情況。

　　

　　給 MyApplicationContextInitializer 加上Order註解：我們指定其擁有最高的排序級別。（越高越早執行）

@Order(Ordered.HIGHEST_PRECEDENCE)
public class MyApplicationContextInitializer implements ApplicationContextInitializer{
    @Override
    public void initialize(ConfigurableApplicationContext applicationContext) {
        System.out.println("-----MyApplicationContextInitializer initialize-----");
    }
}

 

　　下面我們通過debug分別驗證二章節中提到的三種方法排序是否都是可以的。

　　首先驗證2.1章節中採用的main函式中新增：debug，斷點處檢視 application.getInitializers() 這行程式碼的結果可見，排序生效了。

　　

　　然後再分別驗證2.2和2.3章節中的方法。排序都是可以實現的。

　　然而當採用2.3中的SPI擴充套件的方式，排序指定 @Order(Ordered.LOWEST_PRECEDENCE) 排序並沒有生效。當然採用實現Ordered介面的方式，排序驗證結果都是一樣的。

 四、通過原始碼分析ApplicationContextInitializer何時被呼叫

　　debug差看上文中自定的 MyApplicationContextInitializer 的呼叫棧。

　　

　　可見 ApplicationContextInitializer 在容器重新整理前的準備階段被呼叫。 refreshContext(context); 

　　在SpringBoot的啟動函式中， ApplicationContextInitializer 

    public ConfigurableApplicationContext run(String... args) {
        //記錄程式執行時間
        StopWatch stopWatch = new StopWatch();
        stopWatch.start();
        // ConfigurableApplicationContext Spring 的上下文
        ConfigurableApplicationContext context = null;
        Collection<SpringBootExceptionReporter> exceptionReporters = new ArrayList<>();
        configureHeadlessProperty();
        //從META-INF/spring.factories中獲取監聽器
        //1、獲取並啟動監聽器
        SpringApplicationRunListeners listeners = getRunListeners(args);
        listeners.starting();
        try {
            ApplicationArguments applicationArguments = new DefaultApplicationArguments(
                    args);
            //2、構造容器環境
            ConfigurableEnvironment environment = prepareEnvironment(listeners, applicationArguments);
            //處理需要忽略的Bean
            configureIgnoreBeanInfo(environment);
            //列印banner
            Banner printedBanner = printBanner(environment);
            ///3、初始化容器
            context = createApplicationContext();
            //例項化SpringBootExceptionReporter.class，用來支援報告關於啟動的錯誤
            exceptionReporters = getSpringFactoriesInstances(
                    SpringBootExceptionReporter.class,
                    new Class[]{ConfigurableApplicationContext.class}, context);
            //4、重新整理容器前的準備階段
            prepareContext(context, environment, listeners, applicationArguments, printedBanner);
            //5、重新整理容器
            refreshContext(context);
            //重新整理容器後的擴充套件介面
            afterRefresh(context, applicationArguments);
            stopWatch.stop();
            if (this.logStartupInfo) {
                new StartupInfoLogger(this.mainApplicationClass)
                        .logStarted(getApplicationLog(), stopWatch);
            }
            listeners.started(context);
            callRunners(context, applicationArguments);
        } catch (Throwable ex) {
            handleRunFailure(context, ex, exceptionReporters, listeners);
            throw new IllegalStateException(ex);
        }

        try {
            listeners.running(context);
        } catch (Throwable ex) {
            handleRunFailure(context, ex, exceptionReporters, null);
            throw new IllegalStateException(ex);
        }
        return context;
    }

 

 　　然後看在 refreshContext(context); 具體是怎麼被呼叫的。

private void prepareContext(ConfigurableApplicationContext context,
                            ConfigurableEnvironment environment, SpringApplicationRunListeners listeners,
                            ApplicationArguments applicationArguments, Banner printedBanner) {
    context.setEnvironment(environment);
    postProcessApplicationContext(context);
    applyInitializers(context);
    ...
}

 

 　　然後在 applyInitializers 中遍歷呼叫每一個被載入的 ApplicationContextInitializer 的  initialize(context);  方法，並將 ConfigurableApplicationContext 的例項傳遞給 initialize 方法。

protected void applyInitializers(ConfigurableApplicationContext context) {
    for (ApplicationContextInitializer initializer : getInitializers()) {
        Class<?> requiredType = GenericTypeResolver.resolveTypeArgument(
                initializer.getClass(), ApplicationContextInitializer.class);
        Assert.isInstanceOf(requiredType, context, "Unable to call initializer.");
        initializer.initialize(context);
    }
}

 

　　OK，到這裡通過原始碼說明了 ApplicationContextInitializer 是何時及如何被呼叫的。