Spring Boot 啟動事件和監聽器,太強大了!

大家都知道，在 Spring 框架中事件和監聽無處不在，打通了 Spring 框架的任督二脈，事件和監聽也是 Spring 框架必學的核心知識之一。

一般來說，我們很少會使用到應用程式事件，但我們也不要忘了它們的存在，比如說在 Spring 框架內部都使用了各種不同的事件來處理不同的任務。

毫無疑問，在 Spring Boot 框架中，事件和監聽也得到了發揚光大，除了常用的 Spring Framework 事件(例如：ContextRefreshedEvent)之外，Spring Boot 在啟動過程中還發送一系列其他的應用程式事件。

Spring Boot 啟動事件順序

1、ApplicationStartingEvent

這個事件在 Spring Boot 應用運行開始時，且進行任何處理之前發送(除了監聽器和初始化器註冊之外)。

2、ApplicationEnvironmentPreparedEvent

這個事件在當已知要在上下文中使用 Spring 環境(Environment)時，在 Spring 上下文(context)創建之前發送。

3、ApplicationContextInitializedEvent

這個事件在當 Spring 應用上下文(ApplicationContext)準備好了，並且應用初始化器(ApplicationContextInitializers)已經被調用，在 bean 的定義(bean definitions)被加載之前發送。

4、ApplicationPreparedEvent

這個事件是在 Spring 上下文(context)刷新之前，且在 bean 的定義(bean definitions)被加載之後發送。

5、ApplicationStartedEvent

這個事件是在 Spring 上下文(context)刷新之後，且在 application/ command-line runners 被調用之前發送。

6、AvailabilityChangeEvent

這個事件緊隨上個事件之後發送，狀態：ReadinessState.CORRECT，表示應用已處於活動狀態。

7、ApplicationReadyEvent

這個事件在任何 application/ command-line runners 調用之後發送。

8、AvailabilityChangeEvent

這個事件緊隨上個事件之後發送，狀態：ReadinessState.ACCEPTING_TRAFFIC，表示應用可以開始準備接收請求了。

9、ApplicationFailedEvent

這個事件在應用啟動異常時進行發送。

上面所介紹的這些事件列表僅包括綁定到 SpringApplication 的 SpringApplicationEvents 事件，除了這些事件以外，以下事件也會在 ApplicationPreparedEvent 之後和 ApplicationStartedEvent 之前發送：

• WebServerInitializedEvent

這個 Web 伺服器初始化事件在 WebServer 啟動之後發送，對應的還有 ServletWebServerInitializedEvent(Servlet Web 伺服器初始化事件)、ReactiveWebServerInitializedEvent(響應式 Web 伺服器初始化事件)。

這個上下文刷新事件是在 Spring 應用上下文(ApplicationContext)刷新之後發送。

自定義啟動事件監聽器

既然我們知道了 Spring Boot 在啟動過程中的各個事件，那麼我們就可以在每個環節來處理一些我們想做的事情，只需要自定義一個監聽器來監聽某個事件就可以了。

比如我們想在上面的第 8 步，即應用啟動完成可以接收請求了，我們簡單輸出一個成功標識。

Spring Boot 基礎的構建這裡就不介紹了，如果你對 Spring Boot 還不是很熟悉，或者只是會簡單的使用，那還是建議你深入學習下吧，推薦這個 Spring Boot 學習倉庫，歡迎 Star 關注：

https://github.com/javastacks/spring-boot-best-practice

1、新建監聽器

1. import lombok.extern.slf4j.Slf4j; 
2. import org.springframework.boot.availability.AvailabilityChangeEvent; 
3. import org.springframework.boot.availability.ReadinessState; 
4. import org.springframework.context.ApplicationListener; 
5.  
6. /** 
7.  * 來源微信公眾號：Java技術棧 
8.  */ 
9. @Slf4j 
10. public class JavastackListener implements ApplicationListener<AvailabilityChangeEvent> { 
11.  
12.     @Override 
13.     public void onApplicationEvent(AvailabilityChangeEvent event) { 
14.         log.info("監聽到事件：" + event); 
15.         if (ReadinessState.ACCEPTING_TRAFFIC == event.getState()){ 
16.             log.info("應用啟動完成，可以請求了……"); 
17.         } 
18.     } 
19.  
20. } 

新建一個自定義監聽器，實現了 ApplicationListener 接口，泛型 AvailabilityChangeEvent 表示僅僅監聽 AvailabilityChangeEvent 事件。

因第 8 步的事件和第 6 步的事件同名，我們可以根據事件的狀態來區分到底是哪一個環節的事件 。

2、註冊監聽器

註冊監聽器有兩種方式：

1、在資源目錄中的 META-INF/spring.factories 文件中自動註冊：

1. org.springframework.context.ApplicationListener=\ 
2. cn.javastack.springboot.features.listener.JavastackListener 

2、如果是監聽 Spring 應用上下文(ApplicationContext)創建之後的事件，可以直接在監聽器上使用 @Component 註解即可，否則需要使用第一種方法的自動註冊，因為 ApplicationContext 並未創建，這時的 Bean 是不能被加載的。

3、應用啟動

下面來看下啟動日誌：

可以看到同時輸出了第 6 步和 8 步的監聽日誌，但只輸出第 8 步的啟動完成日誌，自定義監聽實現成功。

總結

了解了 Spring Boot 啟動過程中的各個事件及監聽機制，大家可以依葫蘆畫瓢實現 Spring Boot 啟動過程中的各個自定義操作，比如說在啟動過程上實現動態註冊、移除 Bean 等。

一般來說，不建議使用事件和監聽器來實現比較耗時和繁重的任務，這樣會影響應用程式的正常啟動，考慮使用 Spring Boot 的 application/ command-line runners 來進行實現。

本文只是介紹了一下 Spring Boot 啟動過程中的事件及如何實現自定義監聽器，怎麼實現一個業務上的自定義事件和監聽器不在本文範圍之類，後續棧長再開一篇，關注公眾號Java技術棧第一時間推送，不要走開。

本文實踐所有原始碼已上傳：

https://github.com/javastacks/spring-boot-best-practice

參考資料：

https://docs.spring.io/spring-boot/docs/2.3.5.RELEASE/reference/htmlsingle/#boot-features-application-events-and-listeners

本文轉載自微信公眾號「 Java技術棧」，可以通過以下二維碼關注。轉載本文請聯繫 Java技術棧公眾號。

【編輯推薦】

【責任編輯：

武曉燕

TEL：[phone]】

點讚 0