理解 Spring ApplicationListener

落日映苍穹つ 2022-12-20 03:15 167阅读 0赞

ApplicationContext事件机制是观察者设计模式的实现，通过ApplicationEvent类和ApplicationListener接口，可以实现ApplicationContext事件处理。

如果容器中有一个ApplicationListener Bean，每当ApplicationContext发布ApplicationEvent时，ApplicationListener Bean将自动被触发。这种事件机制都必须需要程序显示的触发。

其中spring有一些内置的事件，当完成某种操作时会发出某些事件动作。比如监听ContextRefreshedEvent事件，当所有的bean都初始化完成并被成功装载后会触发该事件，实现ApplicationListener<ContextRefreshedEvent>接口可以收到监听动作，然后可以写自己的逻辑。

同样事件可以自定义、监听也可以自定义，完全根据自己的业务逻辑来处理。

内置事件

<table> 
 <tbody> 
 <tr> 
 <th>序号</th> 
 <th>Spring 内置事件 &amp; 描述</th> 
 </tr> 
 <tr> 
 <td>1</td> 
 <td> ContextRefreshedEvent ApplicationContext&nbsp;被初始化或刷新时，该事件被发布。这也可以在&nbsp;ConfigurableApplicationContext接口中使用 refresh() 方法来发生。此处的初始化是指：所有的Bean被成功装载，后处理Bean被检测并激活，所有Singleton Bean 被预实例化，ApplicationContext容器已就绪可用 </td> 
 </tr> 
 <tr> 
 <td>2</td> 
 <td> ContextStartedEvent 当使用&nbsp;ConfigurableApplicationContext&nbsp;（ApplicationContext子接口）接口中的 start() 方法启动&nbsp;ApplicationContext&nbsp;时，该事件被发布。你可以调查你的数据库，或者你可以在接受到这个事件后重启任何停止的应用程序。 </td> 
 </tr> 
 <tr> 
 <td>3</td> 
 <td> ContextStoppedEvent 当使用&nbsp;ConfigurableApplicationContext&nbsp;接口中的 stop() 停止&nbsp;ApplicationContext&nbsp;时，发布这个事件。你可以在接受到这个事件后做必要的清理的工作。 </td> 
 </tr> 
 <tr> 
 <td>4</td> 
 <td> ContextClosedEvent 当使用&nbsp;ConfigurableApplicationContext&nbsp;接口中的 close() 方法关闭&nbsp;ApplicationContext&nbsp;时，该事件被发布。一个已关闭的上下文到达生命周期末端；它不能被刷新或重启。 </td> 
 </tr> 
 <tr> 
 <td>5</td> 
 <td> RequestHandledEvent 这是一个 web-specific 事件，告诉所有 bean HTTP 请求已经被服务。只能应用于使用DispatcherServlet的Web应用。在使用Spring作为前端的MVC控制器时，当Spring处理用户请求结束后，系统会自动触发该事件。 </td> 
 </tr> 
 </tbody> 
</table>

业务方监听事件举例

比如要监听ContextRefreshedEvent的时可以实现ApplicationListener接口，并且传入要监听的事件

public class InitTask implements ApplicationListener<ContextRefreshedEvent> {
 
 @Override
 public void onApplicationEvent(ContextRefreshedEvent arg0) {
 // TODO Auto-generated method stub
 QuartzSetService server = (QuartzSetService)arg0.getApplicationContext().getBean("quartzSetService");
 List<QuartzSetVo> jobList = server.getAllTask();
 TaskControlScheduler taskScheduler = (TaskControlScheduler)arg0.getApplicationContext().getBean("taskControlScheduler");
 taskScheduler.init(jobList);
 }
 
 }

自定义事件

可以自定义事件，然后做完业务处理后手动发出。同上集成某个监听接口，接收到事件后进行业务处理

事件定义:

`public class EmailEvent extends ApplicationEvent{`

`　　 private String address;`

`　　 private String text;`

`　　 public EmailEvent(Object source, String address, String text){`

`　　 super(source);`

`　　　　　 this.address = address;`

`　　　　　 this.text = text;`

`　　 }`

`　　 public EmailEvent(Object source) {`