spring boot學(xué)習(xí)(3): SpringApplication 事件監(jiān)聽(tīng)

Acceml 發(fā)布于2019-08-16 15:47 / 2691人閱讀

摘要：在框架中，有多種事件這些時(shí)間會(huì)在不同的運(yùn)行時(shí)刻發(fā)布，來(lái)通知監(jiān)聽(tīng)者。本文僅僅介紹的事件的監(jiān)聽(tīng)。也可以在文件中配置。

spring application listener

在 spring 框架中，有多種事件, 這些時(shí)間會(huì)在不同的運(yùn)行時(shí)刻發(fā)布，來(lái)通知監(jiān)聽(tīng)者。本文僅僅介紹 SpringApplicationEvent 的事件的監(jiān)聽(tīng)。

事件類型

EventType	發(fā)布時(shí)間
ApplicationContextInitializedEvent	在 SpringApplication正在啟動(dòng)， ApplicationContext 已經(jīng)準(zhǔn)備好了，ApplicationContextInitializers 被調(diào)用， bean definitions 被加載之前
ApplicationStartingEvent	在一次啟動(dòng)之前發(fā)布
ApplicationEnvironmentPreparedEvent	在 Environment 準(zhǔn)備好之后，會(huì)有 context 去使用這一 Environment, 會(huì)在 context 創(chuàng)建之前發(fā)出
ApplicationPreparedEvent	會(huì)在 bean definitions 加載之后，refresh 之前發(fā)布
ApplicationStartedEvent	context 更新之后，任何應(yīng)用或命令行啟動(dòng)調(diào)用之前
ApplicationReadyEvent	任何應(yīng)用或命令行啟動(dòng)調(diào)用之后發(fā)布，說(shuō)明應(yīng)用已經(jīng)可以被請(qǐng)求了
ApplicationFailedEvent	啟動(dòng)發(fā)生有異常時(shí)發(fā)步

如何監(jiān)聽(tīng)

監(jiān)聽(tīng)器需要使用 org.springframework.context.ApplicationListener 這個(gè)接口的實(shí)例, 其聲明如下：

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

需要使用 SpringApplication.addListeners(…?) 或 SpringApplicationBuilder.listeners(…?) 來(lái)添加監(jiān)聽(tīng)器。也可以在 META-INF/spring.factories 文件中配置：org.springframework.context.ApplicationListener=com.example.project.MyListener。

例子:

public class StartingEventListener implements ApplicationListener {
    @Override
    public void onApplicationEvent(ApplicationStartingEvent applicationStartingEvent) {
        System.out.println("called own starting listener");

        System.out.println(applicationStartingEvent.getClass());
    }
}

@SpringBootApplication
public class DemoApplication {
    public static void main(String[] args){
        SpringApplication application = new SpringApplication(DemoApplication.class);
        application.addListeners(new StartingEventListener());
        application.run(args);
    }
}

終端運(yùn)行 jar 包：

$ java -jar build/libs/springlisteners-0.0.1-SNAPSHOT.jar
called own starting listener
class org.springframework.boot.context.event.ApplicationStartingEvent

  .   ____          _            __ _ _
 / / ___"_ __ _ _(_)_ __  __ _    
( ( )\___ | "_ | "_| | "_ / _` |    
 /  ___)| |_)| | | | | || (_| |  ) ) ) )
  "  |____| .__|_| |_|_| |_\__, | / / / /
 =========|_|==============|___/=/_/_/_/
 :: Spring Boot ::        (v2.1.3.RELEASE)