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 服務器初始化事件)。

  • ContextRefreshedEvent

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


自定義啟動事件監聽器

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

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

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

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

1、新建監聽器

import lombok.extern.slf4j.Slf4j;
import org.springframework.boot.availability.AvailabilityChangeEvent;
import org.springframework.boot.availability.ReadinessState;
import org.springframework.context.ApplicationListener;

/**
 * 來源微信公眾號:Java技術棧
 */
@Slf4j
public class JavastackListener implements ApplicationListener<AvailabilityChangeEvent> {

    @Override
    public void onApplicationEvent(AvailabilityChangeEvent event) {
        log.info("監聽到事件:" + event);
        if (ReadinessState.ACCEPTING_TRAFFIC == event.getState()){
            log.info("應用啟動完成,可以請求了……");
        }
    }

}

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

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

2、注冊監聽器

注冊監聽器有兩種方式:

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

org.springframework.context.ApplicationListener=\
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技術棧" 原創,原創實屬不易,轉載、引用本文內容請注明出處,禁止抄襲、洗稿,請自重,尊重他人勞動成果和知識產權。

近期熱文推薦:

1.Java 15 正式發布, 14 個新特性,刷新你的認知!!

2.終於靠開源項目弄到 IntelliJ IDEA 激活碼了,真香!

3.我用 Java 8 寫了一段邏輯,同事直呼看不懂,你試試看。。

4.吊打 Tomcat ,Undertow 性能很炸!!

5.《Java開發手冊(嵩山版)》最新發布,速速下載!

覺得不錯,別忘了隨手點贊+轉發哦!


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM