一、背景
springboot应用在启动的过程中,它也使用了事件驱动机制,所以在不同的阶段会发布相应的事件。
进入spring-boot源码,有许多事件,ApplicationReadyEvent是本文要讨论的事件。
可以看到有一个基类SpringApplicationEvent,它继承于spring的ApplicationEvent,然后又有7个事件继承抽象类SpringApplicationEvent。
除ApplicationFailedEvent事件是贯穿始终外,其余6个事件它们的执行先后顺序是:
- ApplicationStartingEvent
- ApplicationEnvironmentPreparedEvent
- ApplicationContextInitializedEvent
- ApplicationPreparedEvent
- ApplicationStartedEvent
- ApplicationReadyEvent
倒数两个事件所处的环节虽有先后,但大差不差,两个生命周期之间会执行的内容是:回调执行容器所有的ApplicationRunner和CommandLineRunner实例。
-
ApplicationStartedEvent事件是说应用已启动,代表web容器启动成功,也即当你看到日志“Started Application in xxx seconds (JVM running for xxx)”的时候;
-
ApplicationReadyEvent事件是说应用已准备好,如果有自定义的初始化事项,建议监听该事件。当然,如果你的应用中没有涉及到ApplicationRunner和CommandLineRunner实例,与监听ApplicationStartedEvent事件一致。
二、应用示例
ApplicationReadyEvent 通常在执行完所有ApplicationRunner和CommandLineRunner接口的方法之后发布,这表示所有的初始化代码已经执行完毕,应用已经可以对外提供服务了。在这个事件之后,可以执行一些应用就绪后的操作。
import org.checkerframework.checker.nullness.qual.NonNull;
import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;
@Component
public class ApplicationReadyEventListener implements ApplicationListener<ApplicationReadyEvent> {
@Override
public void onApplicationEvent(@NonNull ApplicationReadyEvent event) {
// 自定义的初始化事项
}
}