SpringBoot 监听机制

Java 监听机制

SpringBoot 的监听机制，其实是对Java提供的事件监听机制的封装。
Java中的事件监听机制定义了以下几个角色：

• 事件：Event，继承 java.util.EventObject 类的对象
• 事件源：Source ，任意对象Object
• 监听器：Listener，实现 java.util.EventListener 接口 的对象

SpringBoot 监听机制

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

META-INF/spring.factories

org.springframework.context.ApplicationContextInitializer=com.release.springbootlistener.listener.MyApplicationContextInitializer

org.springframework.boot.SpringApplicationRunListener=com.release.springbootlistener.listener.MySpringApplicationRunListener

• ApplicationContextInitializer

  @Component
  public class MyApplicationContextInitializer implements ApplicationContextInitializer {
      @Override
      public void initialize(ConfigurableApplicationContext applicationContext) {
          System.out.println("ApplicationContextInitializer....initialize");
      }
  }
  

• SpringApplicationRunListener

  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...项目启动失败");
      }
  }
  
  

• ApplicationRunner

  /**
   * 当项目启动后执行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()));
      }
  }
  
  

• CommandLineRunner

  @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));
      }
  }
  

• InitializingBean

  @Component
  public class MyBean implements InitializingBean {
      @Override
      public void afterPropertiesSet() throws Exception {
          System.out.println("afterPropertiesSet 执行");
      }
  }
  

说明：

顺序	接口/注解	执行时机	说明
1️⃣	ApplicationContextInitializer	Spring 容器 refresh() 之前	最早执行，用于在容器创建前进行环境配置、注册 Bean 定义等，此时 Bean 还未实例化
2️⃣	@PostConstruct	Bean 实例化并依赖注入完成后	在 Bean 初始化阶段执行，优先于 InitializingBean
3️⃣	InitializingBean.afterPropertiesSet()	Bean 属性设置完成后	在 @PostConstruct 之后执行
4️⃣	ApplicationRunner.run()	容器完全启动后	在 CommandLineRunner 之前执行
5️⃣	CommandLineRunner.run()	容器完全启动后	最后执行，通常用于启动后任务

• InitializingBean
  • 用于执行 Bean 的初始化逻辑，比如连接数据库、初始化缓存等。
• CommandLineRunner
  • 用于执行一些应用启动后的任务，比如启动后打印日志、初始化数据、执行定时任务等。