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

背景

在日常開發時，我們常常需要 在SpringBoot 應用啟動時執行某一段邏輯，如下面的場景：

• 獲取一些當前環境的配置或變量
• 向數據庫寫入一些初始數據
• 連接某些第三方系統，確認對方可以工作..

在實現這些功能時，我們可能會遇到一些"坑"。為了利用SpringBoot框架的便利性，我們不得不將整個應用的執行控制權交給容器，於是造成了大家對於細節是一無所知的。那麼在實現初始化邏輯代碼時就需要小心了，比如，我們並不能簡單的將初始化邏輯在Bean類的構造方法中實現，類似下面的代碼：

<code>@Componentpublic  class  InvalidInitExampleBean {     @Autowired     private  Environment env;     public  InvalidInitExampleBean() {          env.getActiveProfiles();     }}/<code>

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

原因在於，當構造方法被調用時，Spring上下文中的Environment這個Bean很可能還沒有被實例化，同時也仍未注入到當前對象，所以並不能這樣進行調用。

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

1、 @PostConstruct 註解

@PostConstruct 註解其實是來自於 javax的擴展包中(大多數人的印象中是來自於Spring框架)，它的作用在於聲明一個Bean對象初始化完成後執行的方法。

來看看它的原始定義：

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

也就是說，該方法會在所有依賴字段注入後才執行，當然這一動作也是由Spring框架執行的。

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

2、 InitializingBean 接口

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

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

3、 @Bean initMethod方法

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

如下所示：

然後，這裡將initMethod指向init方法，相應的我們也需要在Bean中實現這個方法：

上面的代碼是基於Java註解的方式，使用Xml配置也可以達到同樣的效果：

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

4、 構造器注入

如果依賴的字段在Bean的構造方法中聲明，那麼Spring框架會先實例這些字段對應的Bean，再調用當前的構造方法。此時，構造方法中的一些操作也是安全的，如下：

5、 ApplicationListener

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

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

在Spring上下文初始化完成後，這裡定義的方法將會被執行。與前面的InitializingBean不同的是，通過ApplicationListener監聽的方式是全局性的，也就是當所有的Bean都初始化完成後才會執行方法。

Spring 4.2 之後引入了新的 @EventListener註解，可以實現同樣的效果：

6、 CommandLineRunner

SpringBoot 提供了一個CommanLineRunner接口，用來實現在應用啟動後的邏輯控制，其定義如下：

這裡的run方法會在Spring 上下文初始化完成後執行，同時會傳入應用的啟動參數。如下面的代碼：

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

7、 ApplicationRunner

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

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

<code>java -jar application.jar --debug --ip=xxxx/<code>

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

測試代碼

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

按如下代碼實現一個複合式的Bean：

執行這個Bean的初始化，會發現日誌輸出如下：

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

1. 構造器方法
2. @PostConstruct 註解方法
3. InitializingBean的afterPropertiesSet()
4. Bean定義的initMethod屬性方法

來源：https://mp.weixin.qq.com/s/XJ8wGiN9LTYA_i7Z1YB3CQ

閱讀更多 老男孩的成長之路 的文章

關鍵字: 日常 XML 初始化