SpringBoot——》监听器

小灰灰 2024-03-23 10:54 183阅读 0赞

> 推荐链接：  
> [总结——》【Java】][Java]  
> [总结——》【Mysql】][Mysql]  
> [总结——》【Redis】][Redis]  
> [总结——》【Kafka】][Kafka]  
> [总结——》【Spring】][Spring]  
> [总结——》【SpringBoot】][SpringBoot]  
> [总结——》【MyBatis、MyBatis-Plus】][MyBatis_MyBatis-Plus]

#### SpringBoot——》监听器 ####

*  一、SpringBoot启动时监听器的设计
 *   *  1、执行构造方法
     *   *  （1）加载的监听器
         *  （2）监听器相关类
     *  2、执行run方法
     *   *  （1）实例化监听器
         *  （2）发布事件
 *  二、SpringBoot监听器
 *  三、SpringBoot事件
 *  四、自定义监听器和事件
 *   *  1、自定义监听器 && 监听所有事件
     *   *  （1）创建自定义监听器
         *  （2）在spring.factories中注册自定义的监听器
         *  （3）启动服务
     *  2、自定义监听器 && 监听指定事件
     *   *  （1）创建自定义监听器
         *  （2）在spring.factories中注册自定义的监听器
         *  （3）启动服务
     *  3、自定义监听器 && 监听自定义事件
     *   *  （1）创建自定义事件
         *  （2）创建自定义监听器
         *  （3）在spring.factories中注册自定义的监听器
         *  （4）发布自定义事件
         *  （5）启动服务，访问请求

> 代码地址：[https://gitee.com/xiaoxianwansui/springboot-event-listener.git][https_gitee.com_xiaoxianwansui_springboot-event-listener.git]

## 一、SpringBoot启动时监听器的设计 ##

### 1、执行构造方法 ###

构造方法中会加载所有声明在spring.factories中的监听器。  
key为ApplicationListener的value  
![image.png][]

#### （1）加载的监听器 ####

![image.png][image.png 1]  
![image.png][image.png 2]

#### （2）监听器相关类 ####

监听器都实现了 `ApplicationEvent`接口，都会监听 `ApplicationEvent`发布的相关的事件。ApplicationContext事件机制是观察者设计模式的实现，通过ApplicationEvent类和ApplicationListener接口，可以实现ApplicationContext事件处理。

![ApplicationListener.png][]

### 2、执行run方法 ###

#### （1）实例化监听器 ####

通过getRunListeners方法来获取我们在spring.factories中定义的SpringApplicationRunListener类型的实例，也就是EventPublishingRunListener。

SpringApplicationRunListeners listeners = getRunListeners(args);

![getRunListeners.png][]  
![image.png][image.png 3]  
![image.png][image.png 4]

#### （2）发布事件 ####

listeners.starting();

![image.png][image.png 5]  
![starting.png][]

## 二、SpringBoot监听器 ##

<table> 
 <thead> 
  <tr> 
   <th align="left">监听器</th> 
   <th align="left">监听事件</th> 
   <th align="left">说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td align="left">ClearCachesApplicationListener</td> 
   <td align="left">ContextRefreshedEvent</td> 
   <td align="left">当触发ContextRefreshedEvent事件会清空应用的缓存</td> 
  </tr> 
  <tr> 
   <td align="left">ParentContextCloserApplicationListener</td> 
   <td align="left">ParentContextAvailableEvent</td> 
   <td align="left">触发ParentContextAvailableEvent事件会完成父容器关闭的监听器</td> 
  </tr> 
  <tr> 
   <td align="left">CloudFoundryVcapEnvironmentPostProcessor</td> 
   <td align="left">ApplicationPreparedEvent</td> 
   <td align="left">判断环境中是否存在VCAP_APPLICATION或者VCAP_SERVICES。如果有就添加Cloud Foundry的配置；没有就不执行任何操作。</td> 
  </tr> 
  <tr> 
   <td align="left">FileEncodingApplicationListener</td> 
   <td align="left">ApplicationEnvironmentPreparedEvent</td> 
   <td align="left">文件编码的监听器</td> 
  </tr> 
  <tr> 
   <td align="left">AnsiOutputApplicationListener</td> 
   <td align="left">ApplicationEnvironmentPreparedEvent</td> 
   <td align="left">根据 <code>spring.output.ansi.enabled</code>参数配置 <code>AnsiOutput</code></td> 
  </tr> 
  <tr> 
   <td align="left">ConfigFileApplicationListener</td> 
   <td align="left">ApplicationEnvironmentPreparedEvent<br>ApplicationPreparedEvent</td> 
   <td align="left">完成相关属性文件的加载，application.properties，application.yml</td> 
  </tr> 
  <tr> 
   <td align="left">DelegatingApplicationListener</td> 
   <td align="left">ApplicationEnvironmentPreparedEvent</td> 
   <td align="left">监听到事件后转发给环境变量 <code>context.listener.classes</code>指定的那些事件监听器</td> 
  </tr> 
  <tr> 
   <td align="left">ClasspathLoggingApplicationListener</td> 
   <td align="left">ApplicationEnvironmentPreparedEvent<br>ApplicationFailedEvent</td> 
   <td align="left">一个SmartApplicationListener,对环境就绪事件ApplicationEnvironmentPreparedEvent/应用失败事件ApplicationFailedEvent做出响应，往日志DEBUG级别输出TCCL(thread context class loader)的classpath。</td> 
  </tr> 
  <tr> 
   <td align="left">LoggingApplicationListener</td> 
   <td align="left">ApplicationStartingEvent<br>ApplicationEnvironmentPreparedEvent<br>ApplicationPreparedEvent<br>ContextClosedEvent<br>ApplicationFailedEvent</td> 
   <td align="left">配置 <code>LoggingSystem</code>。使用 <code>logging.config</code>环境变量指定的配置或者缺省配置</td> 
  </tr> 
  <tr> 
   <td align="left">LiquibaseServiceLocatorApplicationListener</td> 
   <td align="left">ApplicationStartingEvent</td> 
   <td align="left">使用一个可以和Spring Boot可执行jar包配合工作的版本替换liquibase ServiceLocator</td> 
  </tr> 
  <tr> 
   <td align="left">BackgroundPreinitializer</td> 
   <td align="left">ApplicationStartingEvent<br>ApplicationReadyEvent<br>ApplicationFailedEvent</td> 
   <td align="left">尽早触发一些耗时的初始化任务，使用一个后台线程</td> 
  </tr> 
 </tbody> 
</table>

## 三、SpringBoot事件 ##

SpringBoot中的所有的事件都是继承于 `ApplicationEvent`这个抽象类，在SpringBoot启动的时候会发布如下的相关事件，而这些事件其实都实现了 `SpringApplicationContext`接口。

<table> 
 <thead> 
  <tr> 
   <th>事件</th> 
   <th>说明</th> 
  </tr> 
 </thead> 
 <tbody> 
  <tr> 
   <td>ApplicationStartingEvent</td> 
   <td>容器启动的事件</td> 
  </tr> 
  <tr> 
   <td>ApplicationEnvironmentPreparedEvent</td> 
   <td>应用处理环境变量相关的事件</td> 
  </tr> 
  <tr> 
   <td>ApplicationContextInitializedEvent</td> 
   <td>容器初始化的事件</td> 
  </tr> 
  <tr> 
   <td>ApplicationPreparedEvent</td> 
   <td>应用准备的事件</td> 
  </tr> 
  <tr> 
   <td>ApplicationFailedEvent</td> 
   <td>应用启动出错的事件</td> 
  </tr> 
  <tr> 
   <td>ApplicationStartedEvent</td> 
   <td>应用Started状态事件</td> 
  </tr> 
  <tr> 
   <td>ApplicationReadyEvent</td> 
   <td>应用准备就绪的事件</td> 
  </tr> 
 </tbody> 
</table>

## 四、自定义监听器和事件 ##

### 1、自定义监听器 && 监听所有事件 ###

#### （1）创建自定义监听器 ####

ApplicationEvent：表示监听所有事件

package com.xiaoxian.eventlistener.listener;
    
    import org.springframework.context.ApplicationEvent;
    import org.springframework.context.ApplicationListener;
    
    /*
     * @author      :xiaoixan
     * @date        :2023/04/12 9:56
     * @class       :MySpringApplicationListener
     * @description :自定义监听器
     *               1.实现 ApplicationListener接口，ApplicationEvent表示监听所有的事件
     *               2.把自定义的监听器添加到spring.factories文件中
     * @version     :1.0
     **/
    public class MySpringApplicationListener
    		implements ApplicationListener<ApplicationEvent> {
        
    	@Override
    	public void onApplicationEvent(ApplicationEvent event) {
        
    		System.out.println("自定义监听器--->" + event);
    	}
    }

#### （2）在spring.factories中注册自定义的监听器 ####

org.springframework.context.ApplicationListener=\
    com.xiaoxian.eventlistener.listener.MySpringApplicationListener

![image.png][image.png 6]

#### （3）启动服务 ####

启动服务，可以看到相关事件发布的时候，自定义的MySpringApplicationListener监听器被触发了。  
![image.png][image.png 7]

### 2、自定义监听器 && 监听指定事件 ###

#### （1）创建自定义监听器 ####

ApplicationStartingEvent：表示监听指定的ApplicationStartingEvent事件

package com.xiaoxian.eventlistener.listener;
    
    import org.springframework.boot.context.event.ApplicationStartingEvent;
    import org.springframework.context.ApplicationListener;
    /*
     * @author      :xiaoixan
     * @date        :2023/04/12 9:56
     * @class       :MySpringApplicationStartingListener
     * @description :自定义监听器
     *               1.实现 ApplicationListener接口，ApplicationStartingEvent表示监听指定的ApplicationStartingEvent事件
     *               2.把自定义的监听器添加到spring.factories文件中
     * @version     :1.0
     **/
    public class MySpringApplicationStartingListener implements ApplicationListener<ApplicationStartingEvent> {
        
    	@Override
    	public void onApplicationEvent(ApplicationStartingEvent event) {
        
    		System.out.println("MySpringApplicationStartingListener--->" + event);
    	}
    }

#### （2）在spring.factories中注册自定义的监听器 ####

org.springframework.context.ApplicationListener=\
    com.xiaoxian.eventlistener.listener.MySpringApplicationListener,\
    com.xiaoxian.eventlistener.listener.MySpringApplicationStartingListener

![image.png][image.png 8]

#### （3）启动服务 ####

启动服务，可以看到ApplicationStartingEvent事件发布的时候，自定义的MySpringApplicationStartingListener监听器被触发了。  
![image.png][image.png 9]

### 3、自定义监听器 && 监听自定义事件 ###

#### （1）创建自定义事件 ####

继承ApplicationEvent

package com.xiaoxian.eventlistener.event;
    
    import org.springframework.context.ApplicationEvent;
    
    /*
     * @author      :xiaoixan
     * @date        :2023/04/12 9:56
     * @class       :MyEvent
     * @description :自定义事件
     * @version     :1.0
     **/
    public class MyEvent extends ApplicationEvent {
        
    
        public MyEvent(Object source) {
        
            super(source);
        }
    }

#### （2）创建自定义监听器 ####

MyEvent：表示监听指定的MyEvent事件

package com.xiaoxian.eventlistener.listener;
    
    import com.xiaoxian.eventlistener.event.MyEvent;
    import org.springframework.context.ApplicationListener;
    
    /*
     * @author      :xiaoixan
     * @date        :2023/04/12 9:56
     * @class       :MySpringApplicationListener
     * @description :自定义监听器，监听自定义事件
     *               1.实现 ApplicationListener接口，MyEvent表示监听MyEvent事件
     *               2.把自定义的监听器添加到spring.factories文件中
     * @version     :1.0
     **/
    public class MyEventListener implements ApplicationListener<MyEvent> {
        
    	@Override
    	public void onApplicationEvent(MyEvent event) {
        
    		System.out.println("MyEventListener --->自定义事件触发" + event);
    		// 触发对应的事件后 业务处理
    		new Thread(()->{
        
    			// 业务....
    		}).start();
    	}
    }

#### （3）在spring.factories中注册自定义的监听器 ####

org.springframework.context.ApplicationListener=\
    com.xiaoxian.eventlistener.listener.MySpringApplicationListener,\
    com.xiaoxian.eventlistener.listener.MySpringApplicationStartingListener,\
    com.xiaoxian.eventlistener.listener.MyEventListener

![image.png][image.png 10]

#### （4）发布自定义事件 ####

package com.xiaoxian.eventlistener.controller;
    
    import com.xiaoxian.eventlistener.event.MyEvent;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.context.ApplicationContext;
    import org.springframework.web.bind.annotation.GetMapping;
    import org.springframework.web.bind.annotation.RestController;
    
    /*
     * @author      :xiaoixan
     * @date        :2023/04/12 10:03
     * @class       :EventController
     * @description :发布事件
     * @version     :1.0
     **/
    @RestController
    public class EventController {
        
    
        @Autowired
        ApplicationContext context;
    
        @GetMapping("/hello")
        public String hello() {
        
            // 发布自定义事件
            context.publishEvent(new MyEvent(new Object()));
            return "hello";
        }
    }

#### （5）启动服务，访问请求 ####

启动服务访问请求，可以看到自定义的MyEvent事件发布的时候，自定义的MyEventListener监听器被触发了。  
![image.png][image.png 11]  
![image.png][image.png 12]

[Java]: https://blog.csdn.net/weixin_43453386/article/details/84788317
[Mysql]: https://blog.csdn.net/weixin_43453386/article/details/88667709
[Redis]: https://blog.csdn.net/weixin_43453386/article/details/127966762
[Kafka]: https://blog.csdn.net/weixin_43453386/article/details/128189472
[Spring]: https://blog.csdn.net/weixin_43453386/article/details/124900806
[SpringBoot]: https://blog.csdn.net/weixin_43453386/article/details/84788714
[MyBatis_MyBatis-Plus]: https://blog.csdn.net/weixin_43453386/article/details/84788053
[https_gitee.com_xiaoxianwansui_springboot-event-listener.git]: https://gitee.com/xiaoxianwansui/springboot-event-listener.git
[image.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/a690881a96fc41c28e94835bf30f2371.png
[image.png 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/c768d8131d8c45998db6f5cc6396d2f0.png
[image.png 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/24cb16d007524306aa1bbb1a92efbbd2.png
[ApplicationListener.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/b8d7e2e422cf4424a31aaa91186ada9e.png
[getRunListeners.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/1e89d33af94644ec9f13372a9b6ead0a.png
[image.png 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/33776abf71b84b58b7d13011e194d050.png
[image.png 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/34270d6ec7404947b2ed07feb1b9604c.png
[image.png 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/54292e01413e4b27a735a2f92e8bc912.png
[starting.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/800b2cebe66a4ffdb99a19a1bbd35e4d.png
[image.png 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/19d0a141b82143b5b65661d5bbbfac46.png
[image.png 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/969d00a32ec7448b9c0761a1fb8de857.png
[image.png 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/3eec9e1aa60143ebb6d60c78961edd63.png
[image.png 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/088518549e95436d9b914992876b9521.png
[image.png 10]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/36fb8c9c99b34fa69b9e52e87e46a889.png
[image.png 11]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/2e0b3a80fed042ad99363f427959b2e2.png
[image.png 12]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/23/e6c8ded491ba435285cbf6f2c6ff5389.png