SpringBoot初始化幾大招式，看了終于明白了

背景

在日常開發(fā)時，我們常常需要 在SpringBoot 應(yīng)用啟動時執(zhí)行某一段邏輯，如下面的場景：

• 獲取一些當(dāng)前環(huán)境的配置或變量

• 向數(shù)據(jù)庫寫入一些初始數(shù)據(jù)

• 連接某些第三方系統(tǒng)，確認(rèn)對方可以工作..

在實現(xiàn)這些功能時，我們可能會遇到一些"坑"。為了利用SpringBoot框架的便利性，我們不得不將整個應(yīng)用的執(zhí)行控制權(quán)交給容器，于是造成了大家對于細(xì)節(jié)是一無所知的。那么在實現(xiàn)初始化邏輯代碼時就需要小心了，比如，我們并不能簡單的將初始化邏輯在Bean類的構(gòu)造方法中實現(xiàn)，類似下面的代碼：

@Component
public  class  InvalidInitExampleBean {

     @Autowired
     private  Environment env;

     public  InvalidInitExampleBean() {
          env.getActiveProfiles();
     }
}

這里，我們在InvalidInitExampleBean的構(gòu)造方法中試圖訪問一個自動注入的env字段，當(dāng)真正執(zhí)行時，你一定會得到一個空指針異常(NullPointerException)。

原因在于，當(dāng)構(gòu)造方法被調(diào)用時，Spring上下文中的Environment這個Bean很可能還沒有被實例化，同時也仍未注入到當(dāng)前對象，所以并不能這樣進(jìn)行調(diào)用。

下面，我們來看看在SpringBoot中實現(xiàn)"安全初始化"的一些方法：

1、 @PostConstruct 注解

@PostConstruct 注解其實是來自于 javax的擴(kuò)展包中(大多數(shù)人的印象中是來自于Spring框架)，它的作用在于聲明一個Bean對象初始化完成后執(zhí)行的方法。

來看看它的原始定義：

The?PostConstruct?annotation?is?used?on?a?method?that?needs?to?be?executed??after?dependency?injection?is?done?to?perform?any?initialization

也就是說，該方法會在所有依賴字段注入后才執(zhí)行，當(dāng)然這一動作也是由Spring框架執(zhí)行的。

下面的代碼演示了使用@PostConstruct的例子：

2、 InitializingBean 接口

InitializingBean 是由Spring框架提供的接口，其與@PostConstruct注解的工作原理非常類似。如果不使用注解的話，你需要讓Bean實例繼承 InitializingBean接口，并實現(xiàn)afterPropertiesSet()這個方法。

下面的代碼，展示了這種用法：

3、 @Bean initMethod方法

我們在聲明一個Bean的時候，可以同時指定一個initMethod屬性，該屬性會指向Bean的一個方法，表示在初始化后執(zhí)行。

如下所示：

然后，這里將initMethod指向init方法，相應(yīng)的我們也需要在Bean中實現(xiàn)這個方法：

上面的代碼是基于Java注解的方式，使用Xml配置也可以達(dá)到同樣的效果：

該方式在早期的?Spring版本中大量被使用

4、 構(gòu)造器注入

如果依賴的字段在Bean的構(gòu)造方法中聲明，那么Spring框架會先實例這些字段對應(yīng)的Bean，再調(diào)用當(dāng)前的構(gòu)造方法。此時，構(gòu)造方法中的一些操作也是安全的，如下：

5、 ApplicationListener

ApplicationListener 是由 spring-context組件提供的一個接口，主要是用來監(jiān)聽 "容器上下文的生命周期事件"。它的定義如下：

這里的event可以是任何一個繼承于ApplicationEvent的事件對象。對于初始化工作來說，我們可以通過監(jiān)聽ContextRefreshedEvent這個事件來捕捉上下文初始化的時機(jī)。如下面的代碼：

在Spring上下文初始化完成后，這里定義的方法將會被執(zhí)行。與前面的InitializingBean不同的是，通過ApplicationListener監(jiān)聽的方式是全局性的，也就是當(dāng)所有的Bean都初始化完成后才會執(zhí)行方法。

Spring 4.2 之后引入了新的 @EventListener注解，可以實現(xiàn)同樣的效果：

6、 CommandLineRunner

SpringBoot 提供了一個CommanLineRunner接口，用來實現(xiàn)在應(yīng)用啟動后的邏輯控制，其定義如下：

這里的run方法會在Spring 上下文初始化完成后執(zhí)行，同時會傳入應(yīng)用的啟動參數(shù)。如下面的代碼：

此外，對于多個CommandLineRunner的情況下可以使用@Order注解來控制它們的順序。

7、 ApplicationRunner

與 CommandLineRunner接口類似, Spring boot 還提供另一個ApplicationRunner 接口來實現(xiàn)初始化邏輯。不同的地方在于 ApplicationRunner.run()方法接受的是封裝好的ApplicationArguments參數(shù)對象，而不是簡單的字符串參數(shù)。

ApplicationArguments對象提供了一些非常方便的方法，可以用來直接獲取解析后的參數(shù)，比如：

java -jar application.jar --debug --ip=xxxx

此時通過 ApplicationArguments的getOptionNames就會得到["debug","ip"]這樣的值。

測試代碼

下面，通過一個小測試來演示幾種初始化方法的執(zhí)行次序。

按如下代碼實現(xiàn)一個復(fù)合式的Bean：

執(zhí)行這個Bean的初始化，會發(fā)現(xiàn)日志輸出如下：

所以，這幾種初始化的順序為：

1. 構(gòu)造器方法

2. @PostConstruct 注解方法

3. InitializingBean的afterPropertiesSet()

4. Bean定義的initMethod屬性方法