引言
Spring Boot 提供了許多便捷的功能和特性，使得開發者可以更加輕鬆地構建強大、高效的應用程式。然而，在應用程式啟動時執行一些初始化操作是至關重要的，它可以確保應用程式在啟動後處於預期的狀態，從而提供更好的使用者體驗和穩定性。
在應用程式啟動時執行初始化操作有許多好處。首先，它可以確保應用程式在啟動後的初始狀態是正確的，避免了在應用程式執行時出現意外情況。其次，它可以在應用程式準備好接受請求之前完成一些必要的設定，例如載入配置、建立資料庫連線、快取預熱等。總的來說，執行初始化操作可以確保應用程式以正確的方式啟動，併為後續操作提供一個穩定的基礎。
監聽 ApplicationContext事件
Spring Boot應用程式啟動時執行初始化操作的方法是透過監聽ApplicationContext事件。ContextRefreshedEvent事件表示ApplicationContext被初始化或重新整理時觸發的事件。透過監聽這個事件，開發者可以在應用程式啟動後執行一些必要的初始化操作。
示例：
@Component
public class MyContextRefreshedListener implements ApplicationListener<ContextRefreshedEvent> {
@Override
public void onApplicationEvent(ContextRefreshedEvent event) {
System.out.println("監聽到ContextRefreshedEvent事件，開始初始化操作。。。。。。。");
}
}
這種方式適合以下場景：
-
執行一次性初始化操作： 當應用程式啟動時，可能需要執行一些只需在應用程式初始化階段執行一次的操作，例如載入基礎資料、建立連線等。透過監聽
ContextRefreshedEvent事件，可以確保這些初始化操作在應用程式啟動後立即執行。 -
初始化快取或快取重新整理： 如果應用程式使用了快取，可能需要在應用程式啟動時初始化快取或定期重新整理快取。透過監聽
ContextRefreshedEvent事件，可以在應用程式啟動後立即執行快取初始化或重新整理操作，確保快取資料是最新的。 -
執行與外部系統的互動： 在應用程式啟動時，可能需要與外部系統進行互動，例如檢查外部系統的可用性、載入配置資訊等。透過監聽
ContextRefreshedEvent事件，可以在應用程式啟動後立即執行與外部系統的互動操作，確保應用程式在啟動後處於正常工作狀態。 -
執行與 Spring Bean 相關的初始化操作： 在應用程式啟動時，可能需要執行一些與 Spring Bean 相關的初始化操作，例如在資料庫連線池初始化後執行資料庫遷移、在訊息佇列連線初始化後執行訂閱操作等。透過監聽
ContextRefreshedEvent事件，可以確保這些初始化操作在 Spring Bean 初始化完成後立即執行
這種方式能夠確保在 ApplicationContext 被完全初始化或重新整理後執行初始化操作，可以在這個時機執行一些需要ApplicationContext完全準備好的操作。但是需要注意的是，ContextRefreshedEvent 事件可能會在應用程式的重新整理週期內多次觸發，因此在處理這個事件時需要謹慎處理，避免重複執行初始化邏輯。
實現CommandLineRunner介面
CommandLineRunner是Spring Boot提供的一個介面，它有一個run方法，當Spring Boot應用上下文初始化完成後，會自動查詢並執行所有實現了CommandLineRunner介面的Bean的run方法。CommandLineRunner介面實際上是Spring Boot對Spring框架生命週期管理的一個擴充套件，透過對介面的實現，我們可以在Spring Boot應用啟動後的特定階段執行自定義的初始化邏輯。
示例：
@Component
public class MyCommandLineRunner implements CommandLineRunner {
@Override
public void run(String... args) throws Exception {
System.out.println("MyCommandLineRunner.run()方法執行了");
}
}
使用場景：
- 命令列引數處理：
CommandLineRunner介面常用於處理從命令列傳入的引數，例如執行不同模式下的任務（如dev模式、prod模式）、讀取配置項等。 - 應用啟動後的一次性操作：在應用啟動後，可能需要進行一些一次性執行的任務，如資料庫表結構檢查、初始化快取、傳送通知郵件等。
使用CommandLineRunner介面這種方式是，我們只需要實現介面，無需關注容器的生命週期事件或手動註冊監聽器。但是如果是多個CommandLineRunner之間的執行順序無法保證，可能會帶來不確定性（如果是不關心順序，那就不是缺點了）。另外，我們不應該在``
run方法中實現過多或較為複雜的任務。
實現ApplicationRunner介面
ApplicationRunner是Spring Boot提供的另一個介面，它也有一個run方法，與CommandLineRunner介面非常相似。當Spring Boot應用啟動並且ApplicationContext初始化完成後，Spring Boot會查詢並執行所有實現了ApplicationRunner介面的Bean的run方法。
ApplicationRunner的主要特點是其run方法接收一個ApplicationArguments引數，它可以更好地解析和處理命令列引數，包括選項引數（鍵值對）和非選項引數。
示例：
@Component
public class ApplicationArgumentProcessor implements ApplicationRunner {
@Override
public void run(ApplicationArguments args) throws Exception {
System.out.println("ApplicationArgumentProcessor.run()方法執行了");
}
}
使用場景：
- 命令列引數解析：由於
ApplicationArguments提供了豐富的引數解析能力，因此更適合處理帶有鍵值對形式的命令列引數，如--server-port=8080，然後根據這些引數執行不同的初始化操作。
@Component
public class ApplicationArgumentProcessor implements ApplicationRunner {
@Override
public void run(ApplicationArguments args) throws Exception {
Optional<Integer> port = args.getOptionValues("server-port").stream()
.map(Integer::parseInt)
.findFirst();
if (port.isPresent()) {
// 根據埠號進行特定的初始化操作
}
}
}
- 啟動時初始化：同
CommandLineRunner，也可用於執行啟動後的一次性操作，例如讀取配置、初始化快取、檢查系統資源等，同時可以根據解析的命令列引數決定初始化的具體內容。
相比較於CommandLineRunner，ApplicationRunner提供了更強大的命令列引數解析功能，可以輕鬆處理各種型別的引數。可以根據命令列引數靈活調整啟動時的初始化邏輯。但是其缺點同CommandLineRunner。
ApplicationRunner和CommandLineRunner都可以用來在Spring Boot啟動時執行特定程式碼，兩者在應用場景上略有差異，具體選擇哪種取決於專案的實際需求和命令列引數的複雜程度。
使用@PostConstruct註解
@PostConstruct註解是JSR-250規範的一部分，Spring框架對此提供了支援。當Spring容器管理的Bean完成依賴注入後，會自動呼叫標註有@PostConstruct的方法。這個註解應用於無參或void返回值的方法上，表明該方法應在依賴注入完成後，但在Bean例項正式投入使用之前呼叫。
在Spring Boot啟動時，當Spring容器初始化並建立Bean時，如果發現某個Bean上有@PostConstruct註解的方法，則會在Bean的生命週期的初始化階段呼叫這個方法。
@Service
public class UserService {
@Autowired
private UserRepository userRepository;
@PostConstruct
public void init() {
// 在依賴注入完成後，執行初始化操作
System.out.println("UserService初始化...");
// 初始化資料庫連線、快取或者其他內部狀態
}
}
使用場景：
- 單個Bean初始化：對於某個特定的Bean，在其所有依賴項注入完成後，需要執行一些特定的初始化操作，例如資料庫連線初始化、快取預熱、初始化內部狀態等。
- 資源初始化：對於一些公共資源，如執行緒池、資料庫連線池等，可以在對應的配置類或服務類中使用
@PostConstruct來完成初始化設定。
@PostConstruct註解只需要在需要執行初始化操作的方法上加上即可，無需額外實現介面或關注Spring容器的生命週期事件。並且針對性強，僅針對單個Bean進行初始化操作，有助於提高程式碼的模組化和複用性。
但是如果有多個具有@PostConstruct註解的方法，它們之間沒有明確的執行順序，除非透過Bean間的依賴關係隱式確定順序。並且針對單個Bean進行初始化操作，所以他並不適合做全域性性初始化操作。
@Bean註解中指定初始化方法
@Bean註解在Spring框架中用於定義一個Bean的例項化邏輯，通常在配置類中使用。透過在@Bean註解中指定initMethod屬性，可以設定一個在Bean例項化並完成依賴注入後執行的方法。當Spring容器建立並注入完所有依賴關係後，會自動呼叫該Bean上指定的初始化方法。
@Configuration
public class PrePostConfig {
/**
* 指定初始化init
* @return
*/
@Bean(initMethod = "init")
BeanWayService beanWayService(){
return new BeanWayService();
}
}
public class BeanWayService {
public void init() {
System.out.println("@Bean-init-method");
}
public BeanWayService(){
super();
System.out.println("初始化建構函式-BeanWayService");
}
}
適用場景：
- 資源初始化：例如，初始化資料庫連線、網路連線、執行緒池等資源。
- Bean狀態設定：在Bean例項化後，對其進行額外的狀態設定或配置。
- 快取預熱：在服務啟動時預先載入部分資料至快取中。
Bean例項上定義初始化方法，與Bean緊密關聯，可以精確地控制Bean在何時執行初始化操作，與Spring容器的生命週期繫結，尤其適用於那些需要在Bean例項化後立即執行的操作。。但是如果多個Bean都有初始化方法，它們之間的執行順序難以控制，除非依賴於Spring容器中Bean的依賴注入順序。
實現InitializingBean介面
InitializingBean是Spring框架中的一個介面，它包含一個方法afterPropertiesSet()。當Spring容器完成了對一個Bean的所有必要屬性的依賴注入後，如果該Bean實現了InitializingBean介面，Spring會自動呼叫其afterPropertiesSet()方法。
@Component
public class MyService implements InitializingBean {
@Autowired
private Dependency dependency;
@Override
public void afterPropertiesSet() throws Exception {
// 在所有依賴注入完成後執行的初始化邏輯
System.out.println("MyService初始化...");
// 初始化資源、設定狀態或執行其他操作
}
// 其他業務方法...
}
適用場景：
- 資源初始化：如初始化資料庫連線、網路連線、執行緒池等資源。
- Bean狀態設定：在依賴注入完成後，設定Bean的初始狀態或執行特定的配置操作。
afterPropertiesSet()方法會在所有屬性注入完成後執行，確保Bean在使用前完成初始化。不需要額外的註解，只需實現介面就可以定義初始化邏輯。但是其要求Bean實現特定介面，增加了類的耦合度，同時也不符合Spring倡導的基於註解的程式設計風格。並且需要顯式丟擲異常。
相比較於@PostConstruct，@PostConstruct註解更具語義化且不強制類實現介面，降低了耦合度。推薦優先考慮使用@PostConstruct註解進行初始化邏輯的編寫。
@EventListener註解
@EventListener 註解在Spring應用程式中定義事件監聽器。透過監聽 ApplicationReadyEvent事件，我們可以確保在應用程式完全啟動並準備好接受請求時執行初始化邏輯。透過在監聽器方法上新增 @EventListener 註解，並指定要監聽的事件型別，可以在事件發生時執行相應的初始化操作。
@Component
public class StartupEventListener {
@EventListener(ApplicationReadyEvent.class)
public void onApplicationReadyEvent(ApplicationReadyEvent event) {
System.out.println("Spring Boot應用已啟動並準備就緒，開始執行初始化操作...");
// 在這裡執行需要在應用啟動後進行的初始化程式碼
}
}
適用場景：
- 應用啟動後執行一次性操作：如資料初始化、快取預熱、統計資訊收集等。
- 等待所有Bean初始化後再執行：當需要確保所有Bean都已經初始化完畢再執行某些操作時。
透過事件驅動的方式，將初始化邏輯與Bean的建立邏輯解耦開來，並且可以監聽多種事件型別（例如：ContextRefreshedEvent），不僅僅是應用啟動事件，還可用於其他業務場景。相比於@PostConstruct、CommandLineRunner或ApplicationRunner等機制，@EventListener監聽的ApplicationReadyEvent在Spring Boot啟動流程中的執行時機較晚，所有Bean都已經初始化並準備就緒後才會觸發。
總結
本文全面探討了Spring Boot啟動階段執行初始化操作的幾種常見方法，包括監聽事件、實現介面以及使用註解等多種策略，具體如下：
-
監聽ApplicationContext事件：透過實現
ApplicationListener<ContextRefreshedEvent>介面，監聽ContextRefreshedEvent事件，可在Spring容器初始化完成後執行初始化邏輯。這種方式適用於需要在所有Bean載入完畢後進行全域性性初始化操作的場景。 -
實現CommandLineRunner介面：Spring Boot啟動後，會自動呼叫實現了
CommandLineRunner介面的Bean的run方法，該方法可以處理命令列引數並執行啟動時的特定操作。適用於需要根據命令列引數執行初始化邏輯或進行啟動後一次性任務的情況。 -
實現ApplicationRunner介面：與
CommandLineRunner類似，ApplicationRunner也在Spring Boot啟動後執行其run方法，但其引數為ApplicationArguments，提供了更強大的命令列引數解析功能。適合處理鍵值對形式的命令列引數並據此執行初始化任務。 -
使用@PostConstruct註解：在Bean的方法上新增
@PostConstruct註解，Spring會在該Bean的所有依賴注入完成後呼叫該方法進行初始化。這種方法用於單個Bean初始化完成後的特定邏輯，增強了程式碼的模組化和可維護性。 -
@Bean註解中指定初始化方法：透過
@Bean註解中的initMethod屬性指定Bean的初始化方法，該方法在Bean例項化並完成注入後由Spring容器呼叫。這種方法適用於需要對特定Bean進行精細化初始化管理的場景。 -
實現InitializingBean介面：Bean實現
InitializingBean介面並重寫afterPropertiesSet方法，也能實現在依賴注入完成後執行初始化邏輯。雖然傳統但不如使用@PostConstruct註解優雅，且增加了類的耦合度。 -
使用@EventListener註解：透過監聽
ApplicationReadyEvent等事件，可以在Spring Boot應用啟動並準備就緒後執行初始化任務。這種方式延遲執行，適用於在所有Bean初始化完畢且應用已經完全啟動後才需要進行的操作。
每種方法均有其適用場景和優缺點，我們應根據專案需求和具體情況選擇最適合的初始化方式。透過熟練掌握和靈活運用這些方法，能夠有效地管理和最佳化Spring Boot應用的啟動流程，確保應用程式在啟動之初即進入正常運作狀態。
本文已收錄於我的個人部落格：碼農Academy的部落格，專注分享Java技術乾貨，包括Java基礎、Spring Boot、Spring Cloud、Mysql、Redis、Elasticsearch、中介軟體、架構設計、面試題、程式設計師攻略等