【愚公系列】2023年07月 Java教学课程 153-SpringBoot事件监听


前言

SpringBoot事件监听器是一种机制,可以监听应用程序中的事件和状态变化。它可以让开发人员在应用程序启动、关闭、失败或者其他事件发生时,接收到通知并执行相应的操作。SpringBoot提供了很多种事件监听器,如应用程序启动事件、应用程序关闭事件、Web服务器启动事件、Web服务器关闭事件等。开发人员可以通过实现特定的监听器接口并注册到SpringBoot中,来监听这些事件的触发并执行相应的操作。

SpringBoot事件监听是一种机制,用于监听应用程序中的状态变化和事件。事件监听器是一种编程模式,用于在应用程序中的某些状态变化或事件发生时执行自定义代码。Spring Boot提供了一些常用的事件监听器,这里简单介绍几种:

  1. ApplicationStartingEvent:应用程序正在启动时的事件。可以在应用程序启动之前执行一些初始化操作。

  2. ApplicationEnvironmentPreparedEvent:应用程序的环境准备就绪时的事件。可以在这个事件中获取应用程序的环境信息并进行一些配置。

  3. ApplicationPreparedEvent:应用程序已经准备好时的事件。可以在这个事件中进行一些复杂的初始化工作。

  4. ApplicationStartedEvent:应用程序已经启动时的事件。可以在这个事件中执行一些后台任务或启动异步线程。

  5. ApplicationReadyEvent:应用程序已经准备好接受请求时的事件。可以在这个事件中执行应用程序的一些业务逻辑。

  6. ApplicationFailedEvent:应用程序启动失败时的事件。可以在这个事件中进行一些异常处理或者启动备用服务。

除了以上常用的事件监听器外,Spring Boot还提供了很多其他的事件监听器,如ServletWebServerInitializedEvent、ContextRefreshedEvent、ContextClosedEvent等。开发人员可以根据自己的需求选择相应的事件监听器进行注册。

一、SpringBoot事件监听

Java中的事件监听机制定义了以下几个角色:

①事件:Event,继承 java.util.EventObject 类的对象

②事件源:Source ,任意对象Object

③监听器:Listener,实现 java.util.EventListener 接口 的对象

SpringBoot 在项目启动时,会对几个监听器进行回调,我们可以实现这些监听器接口,在项目启动时完成一些操作。

  • ApplicationContextInitializer、

  • SpringApplicationRunListener、

  • CommandLineRunner、

  • ApplicationRunner

    自定义监听器的启动时机:MyApplicationRunner和MyCommandLineRunner都是当项目启动后执行,使用@Component放入容器即可使用

MyApplicationRunner

/**
 * 当项目启动后执行run方法。
 */
@Component
public class MyApplicationRunner implements ApplicationRunner {
    
    
    @Override
    public void run(ApplicationArguments args) throws Exception {
    
    
        System.out.println("ApplicationRunner...run");
        System.out.println(Arrays.asList(args.getSourceArgs()));
    }
} 

MyCommandLineRunner

@Component
public class MyCommandLineRunner implements CommandLineRunner {
    
    
    @Override
    public void run(String... args) throws Exception {
    
    
        System.out.println("CommandLineRunner...run");
        System.out.println(Arrays.asList(args));
    }
}

MyApplicationContextInitializer的使用要在resource文件夹下添加META-INF/spring.factories

org.springframework.context.ApplicationContextInitializer=com.itheima.springbootlistener.listener.MyApplicationContextInitializer
@Component
public class MyApplicationContextInitializer implements ApplicationContextInitializer {
    @Override
    public void initialize(ConfigurableApplicationContext applicationContext) {
        System.out.println("ApplicationContextInitializer....initialize");
    }
}

MySpringApplicationRunListener的使用要添加构造器

public class MySpringApplicationRunListener implements SpringApplicationRunListener {

    public MySpringApplicationRunListener(SpringApplication application, String[] args) {
    }

    @Override
    public void starting() {
        System.out.println("starting...项目启动中");
    }

    @Override
    public void environmentPrepared(ConfigurableEnvironment environment) {
        System.out.println("environmentPrepared...环境对象开始准备");
    }

    @Override
    public void contextPrepared(ConfigurableApplicationContext context) {
        System.out.println("contextPrepared...上下文对象开始准备");
    }

    @Override
    public void contextLoaded(ConfigurableApplicationContext context) {
        System.out.println("contextLoaded...上下文对象开始加载");
    }

    @Override
    public void started(ConfigurableApplicationContext context) {
        System.out.println("started...上下文对象加载完成");
    }

    @Override
    public void running(ConfigurableApplicationContext context) {
        System.out.println("running...项目启动完成,开始运行");
    }

    @Override
    public void failed(ConfigurableApplicationContext context, Throwable exception) {
        System.out.println("failed...项目启动失败");
    }
}

猜你喜欢

转载自blog.csdn.net/aa2528877987/article/details/131545515