補習系列(21)-SpringBoot初始化之7招式

目錄

• 背景
• 1、 @PostConstruct 註解
• 2、 InitializingBean 介面
• 3、 @Bean initMethod方法
• 4、 構造器注入
• 5、 ApplicationListener
• 6、 CommandLineRunner
• 7、 ApplicationRunner
• 測試程式碼
• 參考文件

背景

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

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

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

@Component
public class InvalidInitExampleBean {
 
    @Autowired
    private Environment env;
 
    public InvalidInitExampleBean() {
        env.getActiveProfiles();
    }
}

這裡，我們在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的例子：

@Component
public class PostConstructExampleBean {
 
    private static final Logger LOG 
      = Logger.getLogger(PostConstructExampleBean.class);
 
    @Autowired
    private Environment environment;
 
    @PostConstruct
    public void init() {
        //environment 已經注入
        LOG.info(Arrays.asList(environment.getDefaultProfiles()));
    }
}

2、 InitializingBean 介面

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

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

@Component
public class InitializingBeanExampleBean implements InitializingBean {
 
    private static final Logger LOG 
      = Logger.getLogger(InitializingBeanExampleBean.class);
 
    @Autowired
    private Environment environment;
 
    @Override
    public void afterPropertiesSet() throws Exception {
        //environment 已經注入
        LOG.info(Arrays.asList(environment.getDefaultProfiles()));
    }
}

3、 @Bean initMethod方法

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

如下所示：

@Bean(initMethod="init")
public InitMethodExampleBean exBean() {
    return new InitMethodExampleBean();
}

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

public class InitMethodExampleBean {
 
    private static final Logger LOG = Logger.getLogger(InitMethodExampleBean.class);
 
    @Autowired
    private Environment environment;
 
    public void init() {
        LOG.info(Arrays.asList(environment.getDefaultProfiles()));
    }
}

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

<bean id="initMethodExampleBean"
  class="org.baeldung.startup.InitMethodExampleBean"
  init-method="init">
</bean>

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

4、 構造器注入

如果依賴的欄位在Bean的構造方法中宣告，那麼Spring框架會先例項這些欄位對應的Bean，再呼叫當前的構造方法。
此時，構造方法中的一些操作也是安全的，如下：

@Component
public class LogicInConstructorExampleBean {
 
    private static final Logger LOG 
      = Logger.getLogger(LogicInConstructorExampleBean.class);
 
    private final Environment environment;
 
    @Autowired
    public LogicInConstructorExampleBean(Environment environment) {
        //environment例項已初始化
        this.environment = environment;
        LOG.info(Arrays.asList(environment.getDefaultProfiles()));
    }
}

5、 ApplicationListener

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

public interface ApplicationListener<E extends ApplicationEvent> extends EventListener {
    /**
     * Handle an application event.
     * @param event the event to respond to
     */
    void onApplicationEvent(E event);
}

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

@Component
public class StartupApplicationListenerExample implements
  ApplicationListener<ContextRefreshedEvent> {
 
    private static final Logger LOG 
      = Logger.getLogger(StartupApplicationListenerExample.class);
 
    public static int counter;
 
    @Override public void onApplicationEvent(ContextRefreshedEvent event) {
        LOG.info("Increment counter");
        counter++;
    }
}

在Spring上下文初始化完成後，這裡定義的方法將會被執行。
與前面的InitializingBean不同的是，通過ApplicationListener監聽的方式是全域性性的，也就是當所有的Bean都初始化完成後才會執行方法。
Spring 4.2 之後引入了新的 @EventListener註解，可以實現同樣的效果：

@Component
public class EventListenerExampleBean {
 
    private static final Logger LOG 
      = Logger.getLogger(EventListenerExampleBean.class);
 
    public static int counter;
 
    @EventListener
    public void onApplicationEvent(ContextRefreshedEvent event) {
        LOG.info("Increment counter");
        counter++;
    }
}

6、 CommandLineRunner

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

public interface CommandLineRunner {

    /**
     * Callback used to run the bean.
     * @param args incoming main method arguments
     * @throws Exception on error
     */
    void run(String... args) throws Exception;

}

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

@Component
public class CommandLineAppStartupRunner implements CommandLineRunner {
    private static final Logger LOG =
      LoggerFactory.getLogger(CommandLineAppStartupRunner.class);
 
    public static int counter;
 
    @Override
    public void run(String...args) throws Exception {
        //上下文已初始化完成
        LOG.info("Increment counter");
        counter++;
    }
}

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

7、 ApplicationRunner

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

@Component
public class AppStartupRunner implements ApplicationRunner {
    private static final Logger LOG =
      LoggerFactory.getLogger(AppStartupRunner.class);
 
    public static int counter;
 
    @Override
    public void run(ApplicationArguments args) throws Exception {
        LOG.info("Application started with option names : {}", 
          args.getOptionNames());
        LOG.info("Increment counter");
        counter++;
    }
}

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

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

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

測試程式碼

下面，通過一個小測試來演示幾種初始化方法的執行次序，按如下程式碼實現一個複合式的Bean：

@Component
@Scope(value = "prototype")
public class AllStrategiesExampleBean implements InitializingBean {
 
    private static final Logger LOG 
      = Logger.getLogger(AllStrategiesExampleBean.class);
 
    public AllStrategiesExampleBean() {
        LOG.info("Constructor");
    }
 
    @Override
    public void afterPropertiesSet() throws Exception {
        LOG.info("InitializingBean");
    }
 
    @PostConstruct
    public void postConstruct() {
        LOG.info("PostConstruct");
    }
 
    //在XML中定義為initMethod
    public void init() {
        LOG.info("init-method");
    }
}

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

[main] INFO o.b.startup.AllStrategiesExampleBean - Constructor
[main] INFO o.b.startup.AllStrategiesExampleBean - PostConstruct
[main] INFO o.b.startup.AllStrategiesExampleBean - InitializingBean
[main] INFO o.b.startup.AllStrategiesExampleBean - init-method

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

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

參考文件

https://www.baeldung.com/running-setup-logic-on-startup-in-spring

美碼師的 SpringBoot 補習系列