SpringApplicationEvent的使用方式

SpringApplicationEvent 是Spring提供的事件的一种编程范式，基于此我们可以监听SpringApplication的一些事件，或者自定事件来实现解耦操作。
对于自定义SpringEvent而言，我们可以定义自己的事件，比如

  1. public class CustomerEvent extends ApplicationEvent {
  3.   public CustomerEvent(Object source) {
  4.     super(source);
  5.   }
  6. }

对于此类事件，如果需要对其事件进行监听，我们可以通过三种方式来实现。

  1. /** 自定义事件监听器,继承ApplicationLitener */
  2. @Component
  3. class CustomerEventListener implements ApplicationListener<CustomerEvent> {
  5.   @Override
  6.   public void onApplicationEvent(@NotNull CustomerEvent event) {}
  7. }
  10. // 在一个普通方法上标注注解 @EventListener
  11. @Component
  12. public class CustomerEventListener {
  14.   @EventListener
  15.   public void handler(CustomerEvent event) {}
  16. }
  18. // 或者在SPring启动的代码中添加监听器
  19. public static void main(){
  20.     ConfigurableApplicationContext context = new SpringApplicationBuilder(Application.class).run(args);
  21.     context.addApplicationListener(new CustomerEventListener());
  22. }    
  25. // 或者在application.ymal文件中配置context.lsitener.classes=xxxx 
  26. // 或者在WEB-INF/spring.factories文件中配置 org.springframework.context.ApplicationListener=xxx

如果要测试事件的发送以及处理，则可以使用上下文发送事件,比如 context.publishEvent(new CustomerEvent());

SpringApplicationEvent的实现原理

这里以SpringApplicationStartingEvent事件为例，展示SpringBoot在启动中是如何触发。SpringApplication 对象构建完成之后，在调用的run()方法中，有以下代码

  1.     public ConfigurableApplicationContext run(String... args) {
  2.         // .....
  3.         SpringApplicationRunListeners listeners = getRunListeners(args);
  4.         listeners.starting();
  5.         // .....
  6.     }
  8.     // getSpringFactoriesInstances 中获取  SpringApplicationRunListener 
  9.     // getSpringFactoriesInstances 方法已经看到，就是从spring.factories 中获取RunListener
  10.     private SpringApplicationRunListeners getRunListeners(String[] args) {
  11.         Class<?>[] types = new Class<?>[] { SpringApplication.class, String[].class };
  12.         // 构造一个 SpringApplicationRunListeners 对象    
  13.         return new SpringApplicationRunListeners(logger,
  14.                 getSpringFactoriesInstances(SpringApplicationRunListener.class, types, this, args));
  15.     }
  17.     class SpringApplicationRunListeners {
  19.         private final Log log;
  21.         private final List<SpringApplicationRunListener> listeners;
  23.         SpringApplicationRunListeners(Log log, Collection<? extends SpringApplicationRunListener> listeners) {
  24.             this.log = log;
  25.             this.listeners = new ArrayList<>(listeners);
  26.         }
  28.         void starting() {
  29.             // 遍历发送
  30.             for (SpringApplicationRunListener listener : this.listeners) {
  31.                 listener.starting();
  32.             }
  33.         }
  34.     }
  36.     public class EventPublishingRunListener implements SpringApplicationRunListener, Ordered {
  38.         @Override
  39.         public void starting() {
  40.             // 调用  initialMulticaster 广播器 发送
  41.             this.initialMulticaster.multicastEvent(new ApplicationStartingEvent(this.application, this.args));
  42.         }
  44.         @Override
  45.         public void environmentPrepared(ConfigurableEnvironment environment) {
  46.             // 和Starting类似，构造环境准备完成
  47.             this.initialMulticaster
  48.                 .multicastEvent(new ApplicationEnvironmentPreparedEvent(this.application, this.args, environment));
  49.         }        
  50.    }

比如后台任务就对 SpringApplicationEvent 感兴趣，所以其可以注册到该事件

  1. public class BackgroundPreinitializer implements ApplicationListener<SpringApplicationEvent> {}

  • 这里我们也可以定义一个ApplicationListener 对 ApplicationEvent 监控，代码如下: ```java public class SelfApplicationEventListener implements ApplicationListener {

    private static final Logger log = LoggerFactory.getLogger(SelfApplicationEventListener.class);

    @Override public void onApplicationEvent(ApplicationEvent event) { log.info(“接收到 :{} “, event.getClass()); } }

// 同时需要添加到 META-INF/spring.factories 文件中 org.springframework.context.ApplicationListener=\ com.zhoutao123.spring.springboot.event.SelfApplicationEventListener

// 或者在SpringApplication中添加 public static void main(String[] args) { SpringApplication application = new SpringApplication(Application.class); application.addListeners(new SelfApplicationEventListener()); application.run(args); }

```

控制台日志中，就可以看到：