我是陈皮，一个在互联网 Coding 的 ITer，微信搜索「陈皮的JavaLib」第一时间阅读最新文章，回复【资料】，即可获得我精心整理的技术资料，电子书籍，一线大厂面试资料和优秀简历模板。

目录

Spring 提供了 ApplicationContext 事件机制，可以发布和监听事件，这个特性非常有用。

Spring 内置了一些事件和监听器，例如在 Spring 容器启动前，Spring 容器启动后，应用启动失败后等事件发生后，监听在这些事件上的监听器会做出相应的响应处理。

当然，我们也可以自定义监听器，监听 Spring 原有的事件。或者自定义我们自己的事件和监听器，在必要的时间点发布事件，然后监听器监听到事件就做出响应处理。

ApplicationContext 事件机制采用观察者设计模式来实现，通过 ApplicationEvent 事件类和 ApplicationListener 监听器接口，可以实现 ApplicationContext 事件发布与处理。

每当 ApplicationContext 发布 ApplicationEvent 时，如果 Spring 容器中有 ApplicationListener bean，则监听器会被触发执行相应的处理。当然，ApplicationEvent 事件的发布需要显示触发，要么 Spring 显示触发，要么我们显示触发。

定义应用监听器需要实现的接口。此接口继承了 JDK 标准的事件监听器接口 EventListener，EventListener 接口是一个空的标记接口，推荐所有事件监听器必须要继承它。

  1. package org.springframework.context;
  3. import java.util.EventListener;
  5. @FunctionalInterface
  6. public interface ApplicationListener<E extends ApplicationEvent> extends EventListener {
  8. 	/**
  9. 	 * 处理应用事件
  10. 	 */
  11. 	void onApplicationEvent(E event);
  12. }
  1. package java.util;
  3. public interface EventListener {
  4. }

ApplicationListener 是个泛型接口，我们自定义此接口的实现类时，如果指定了泛型的具体事件类，那么只会监听此事件。如果不指定具体的泛型，则会监听 ApplicationEvent 抽象类的所有子类事件。

如下我们定义一个监听器，监听具体的事件，例如监听 ApplicationStartedEvent 事件。

  1. package com.chenpi;
  3. import lombok.extern.slf4j.Slf4j;
  4. import org.springframework.boot.context.event.ApplicationStartedEvent;
  5. import org.springframework.context.ApplicationListener;
  6. import org.springframework.stereotype.Component;
  8. /**
  9.  * @Description
  10.  * @Author 陈皮
  11.  * @Date 2021/6/26
  12.  * @Version 1.0
  13.  */
  14. @Slf4j
  15. @Component
  16. public class MyApplicationListener implements ApplicationListener<ApplicationStartedEvent> {
  17.     @Override
  18.     public void onApplicationEvent(ApplicationStartedEvent event) {
  19.         log.info(">>> MyApplicationListener：{}", event);
  20.     }
  21. }

启动服务，会发现在服务启动后，此监听器被触发了。

在这里插入图片描述

如果不指定具体的泛型类，则会监听 ApplicationEvent 抽象类的所有子类事件。如下所示：

  1. package com.chenpi;
  3. import lombok.extern.slf4j.Slf4j;
  4. import org.springframework.context.ApplicationEvent;
  5. import org.springframework.context.ApplicationListener;
  6. import org.springframework.stereotype.Component;
  8. /**
  9.  * @Description
  10.  * @Author 陈皮
  11.  * @Date 2021/6/26
  12.  * @Version 1.0
  13.  */
  14. @Slf4j
  15. @Component
  16. public class MyApplicationListener implements ApplicationListener {
  17.     @Override
  18.     public void onApplicationEvent(ApplicationEvent event) {
  19.         log.info(">>> MyApplicationListener：{}", event);
  20.     }
  21. }

在这里插入图片描述

注意，监听器类的 bean 要注入到 Spring 容器中，不然不会生效。一种是使用注解注入，例如 @Component。另外可以使用 SpringApplicationBuilder.listeners() 方法添加，不过这两种方式有区别的，看以下示例。

首先我们使用 @Component 注解方式，服务启动时，监视到了2个事件：

  • ApplicationStartedEvent
  • ApplicationReadyEvent
  1. package com.chenpi;
  3. import lombok.extern.slf4j.Slf4j;
  4. import org.springframework.boot.context.event.SpringApplicationEvent;
  5. import org.springframework.context.ApplicationListener;
  6. import org.springframework.stereotype.Component;
  8. /**
  9.  * @Description
  10.  * @Author 陈皮
  11.  * @Date 2021/6/26
  12.  * @Version 1.0
  13.  */
  14. @Slf4j
  15. @Component
  16. public class MyApplicationListener implements ApplicationListener<SpringApplicationEvent> {
  17.     @Override
  18.     public void onApplicationEvent(SpringApplicationEvent event) {
  19.         log.info(">>> MyApplicationListener：{}", event);
  20.     }
  21. }

在这里插入图片描述

而使用 SpringApplicationBuilder.listeners() 方法添加监听器，服务启动时，监听到了5个事件：

  • ApplicationEnvironmentPreparedEvent
  • ApplicationContextInitializedEvent
  • ApplicationPreparedEvent
  • ApplicationStartedEvent
  • ApplicationReadyEvent
  1. package com.chenpi;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  5. import org.springframework.boot.builder.SpringApplicationBuilder;
  6. import org.springframework.context.ConfigurableApplicationContext;
  8. @SpringBootApplication
  9. public class Application {
  11.     public static void main(String[] args) {
  12.         // SpringApplication.run(Application.class, args);
  14.         SpringApplication app = new SpringApplicationBuilder(Application.class)
  15.                 .listeners(new MyApplicationListener()).build();
  16.         app.run(args);
  17.     }
  18. }

在这里插入图片描述

其实这是和监听器 bean 注册的时机有关，@component 注解的监听器 bean 只有在 bean 初始化注册完后才能使用；而通过 SpringApplicationBuilder.listeners() 添加的监听器 bean 是在容器启动前，所以监听到的事件比较多。但是注意，这两个不要同时使用，不然监听器会重复执行两遍。

如果你想在监听器 bean 中注入其他 bean（例如 @Autowired），那最好是使用注解形式，因为如果太早发布监听器，可能其他 bean 还未初始化完成，可能会报错。

ApplicationEvent 是所有应用事件需要继承的抽象类。它继承了 EventObject 类，EventObject 是所有事件的根类，这个类有个 Object 类型的对象 source，代表事件源。所有继承它的类的构造函数都必须要显示传递这个事件源。

  1. package org.springframework.context;
  3. import java.util.EventObject;
  5. public abstract class ApplicationEvent extends EventObject {
  7. 	private static final long serialVersionUID = 7099057708183571937L;
  9. 	// 发布事件的系统时间
  10. 	private final long timestamp;
  12. 	public ApplicationEvent(Object source) {
  13. 		super(source);
  14. 		this.timestamp = System.currentTimeMillis();
  15. 	}
  17. 	public final long getTimestamp() {
  18. 		return this.timestamp;
  19. 	}
  20. }
  1. package java.util;
  3. public class EventObject implements java.io.Serializable {
  5.     private static final long serialVersionUID = 5516075349620653480L;
  7.     protected transient Object  source;
  9.     public EventObject(Object source) {
  10.         if (source == null)
  11.             throw new IllegalArgumentException("null source");
  13.         this.source = source;
  14.     }
  16.     public Object getSource() {
  17.         return source;
  18.     }
  20.     public String toString() {
  21.         return getClass().getName() + "[source=" + source + "]";
  22.     }
  23. }

在 Spring 中，比较重要的事件类是 SpringApplicationEvent。Spring 有一些内置的事件，当完成某种操作时会触发某些事件。这些内置事件继承 SpringApplicationEvent 抽象类。SpringApplicationEvent 继承 ApplicationEvent 并增加了字符串数组参数字段 args。

  1. /**
  2.  * Base class for {@link ApplicationEvent} related to a {@link SpringApplication}.
  3.  *
  4.  * @author Phillip Webb
  5.  * @since 1.0.0
  6.  */
  7. @SuppressWarnings("serial")
  8. public abstract class SpringApplicationEvent extends ApplicationEvent {
  10. 	private final String[] args;
  12. 	public SpringApplicationEvent(SpringApplication application, String[] args) {
  13. 		super(application);
  14. 		this.args = args;
  15. 	}
  17. 	public SpringApplication getSpringApplication() {
  18. 		return (SpringApplication) getSource();
  19. 	}
  21. 	public final String[] getArgs() {
  22. 		return this.args;
  23. 	}
  24. }

在这里插入图片描述

我们可以编写自己的监听器，然后监听这些事件，实现自己的业务逻辑。例如编写 ApplicationListener 接口的实现类，监听 ContextStartedEvent 事件，当应用容器 ApplicationContext 启动时，会发布该事件，所以我们编写的监听器会被触发。

  • ContextRefreshedEvent：ApplicationContext 被初始化或刷新时，事件被发布。ConfigurableApplicationContext接口中的 refresh() 方法被调用也会触发事件发布。初始化是指所有的 Bean 被成功装载，后处理 Bean 被检测并激活，所有单例 Bean 被预实例化，ApplicationContext 容器已就绪可用。
  • ContextStartedEvent：应用程序上下文被刷新后，但在任何 ApplicationRunner 和 CommandLineRunner 被调用之前，发布此事件。
  • ApplicationReadyEvent：此事件会尽可能晚地被发布，以表明应用程序已准备好为请求提供服务。事件源是SpringApplication 本身，但是要注意修改它的内部状态，因为到那时所有初始化步骤都已经完成了。
  • ContextStoppedEvent：ConfigurableApplicationContext 接口的 stop() 被调用停止 ApplicationContext 时，事件被发布。
  • ContextClosedEvent：ConfigurableApplicationContext 接口的 close() 被调用关闭 ApplicationContext 时，事件被发布。注意，一个已关闭的上下文到达生命周期末端后，它不能被刷新或重启。
  • ApplicationFailedEvent：当应用启动失败后发布事件。
  • ApplicationEnvironmentPreparedEvent：事件是在 SpringApplication 启动时发布的，并且首次检查和修改 Environment 时，此时上 ApplicationContext 还没有创建。
  • ApplicationPreparedEvent：事件发布时，SpringApplication 正在启动，ApplicationContext 已经完全准备好，但没有刷新。在这个阶段，将加载 bean definitions 并准备使用 Environment。
  • RequestHandledEvent：这是一个 web 事件，只能应用于使用 DispatcherServlet 的 Web 应用。在使用 Spring 作为前端的 MVC 控制器时，当 Spring 处理用户请求结束后，系统会自动触发该事件。

前面介绍了自定义监听器，然后监听 Spring 原有的事件。下面介绍自定义事件和自定义监听器，然后在程序中发布事件，触发监听器执行，实现自己的业务逻辑。

首先自定义事件，继承 ApplicationEvent，当然事件可以自定义自己的属性。

  1. package com.chenpi;
  3. import lombok.Getter;
  4. import lombok.Setter;
  5. import lombok.ToString;
  6. import org.springframework.context.ApplicationEvent;
  8. /**
  9.  * @Description 自定义事件
  10.  * @Author 陈皮
  11.  * @Date 2021/6/26
  12.  * @Version 1.0
  13.  */
  14. @Getter
  15. @Setter
  16. public class MyApplicationEvent extends ApplicationEvent {
  18.     // 事件可以增加自己的属性
  19.     private String myField;
  21.     public MyApplicationEvent(Object source, String myField) {
  22.         // 绑定事件源
  23.         super(source);
  24.         this.myField = myField;
  25.     }
  27.     @Override
  28.     public String toString() {
  29.         return "MyApplicationEvent{" + "myField='" + myField + '\'' + ", source=" + source + '}';
  30.     }
  31. }

然后自定义监听器，监听我们自定义的事件。

  1. package com.chenpi;
  3. import lombok.extern.slf4j.Slf4j;
  4. import org.springframework.context.ApplicationListener;
  6. /**
  7.  * @Description 自定义监听器
  8.  * @Author 陈皮
  9.  * @Date 2021/6/26
  10.  * @Version 1.0
  11.  */
  12. @Slf4j
  13. public class MyApplicationListener implements ApplicationListener<MyApplicationEvent> {
  14.     @Override
  15.     public void onApplicationEvent(MyApplicationEvent event) {
  16.         log.info(">>> MyApplicationListener：{}", event);
  17.     }
  18. }

注册监听器和发布事件。注册监听器上面讲解了有两种方式。事件的发布可以通过 ApplicationEventPublisher.publishEvent() 方法。此处演示直接用 configurableApplicationContext 发布，它实现了 ApplicationEventPublisher 接口。

  1. package com.chenpi;
  3. import org.springframework.boot.SpringApplication;
  4. import org.springframework.boot.autoconfigure.SpringBootApplication;
  5. import org.springframework.boot.builder.SpringApplicationBuilder;
  6. import org.springframework.context.ConfigurableApplicationContext;
  8. @SpringBootApplication
  9. public class Application {
  11.     public static void main(String[] args) {
  12.         // SpringApplication.run(Application.class, args);
  13.         // 注册监听器
  14.         SpringApplication app = new SpringApplicationBuilder(Application.class)
  15.                 .listeners(new MyApplicationListener()).build();
  16.         ConfigurableApplicationContext configurableApplicationContext = app.run(args);
  17.         // 方便演示，在项目启动后发布事件，当然也可以在其他操作和其他时间点发布事件
  18.         configurableApplicationContext
  19.                 .publishEvent(new MyApplicationEvent("我是事件源，项目启动成功后发布事件", "我是自定义事件属性"));
  20.     }
  21. }

启动服务，结果显示确实监听到发布的事件了。

  1. 2021-06-26 16:15:09.584  INFO 10992 --- [           main] o.s.b.w.embedded.tomcat.TomcatWebServer  : Tomcat started on port(s): 8081 (http) with context path ''
  2. 2021-06-26 16:15:09.601  INFO 10992 --- [           main] com.chenpi.Application                   : Started Application in 2.563 seconds (JVM running for 4.012)
  3. 2021-06-26 16:15:09.606  INFO 10992 --- [           main] com.chenpi.MyApplicationListener         : >>> MyApplicationListener：MyApplicationEvent{myField='我是自定义事件属性', source=我是事件源，项目启动成功后发布事件}

事件监听机制能达到分发，解耦效果。例如可以在业务类中发布事件，让监听在此事件的监听器执行自己的业务处理。例如：

  1. package com.chenpi;
  3. import org.springframework.context.ApplicationEventPublisher;
  4. import org.springframework.context.ApplicationEventPublisherAware;
  5. import org.springframework.stereotype.Service;
  7. /**
  8.  * @Description
  9.  * @Author 陈皮
  10.  * @Date 2021/6/26
  11.  * @Version 1.0
  12.  */
  13. @Service
  14. public class MyService implements ApplicationEventPublisherAware {
  16.     private ApplicationEventPublisher applicationEventPublisher;
  18.     @Override
  19.     public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
  20.         this.applicationEventPublisher = applicationEventPublisher;
  21.     }
  23.     public void testEvent() {
  24.         applicationEventPublisher
  25.                 .publishEvent(new MyApplicationEvent("我是事件源", "我是自定义事件属性"));
  26.     }
  27. }

除了实现 ApplicationListener 接口创建监听器外，Spring 还提供了注解 @EventListener 来创建监听器。

  1. package com.chenpi;
  3. import org.springframework.context.event.EventListener;
  4. import org.springframework.stereotype.Component;
  6. import lombok.extern.slf4j.Slf4j;
  8. /**
  9.  * @Description 自定义监听器
  10.  * @Author 陈皮
  11.  * @Date 2021/6/26
  12.  * @Version 1.0
  13.  */
  14. @Slf4j
  15. @Component
  16. public class MyApplicationListener01 {
  17.     @EventListener
  18.     public void onApplicationEvent(MyApplicationEvent event) {
  19.         log.info(">>> MyApplicationListener：{}", event);
  20.     }
  21. }

而且注解还可以通过条件过滤只监听指定条件的事件。例如事件的 myField 属性的值等于”陈皮”的事件。

  1. package com.chenpi;
  3. import org.springframework.context.event.EventListener;
  4. import org.springframework.stereotype.Component;
  6. import lombok.extern.slf4j.Slf4j;
  8. /**
  9.  * @Description 自定义监听器
  10.  * @Author 陈皮
  11.  * @Date 2021/6/26
  12.  * @Version 1.0
  13.  */
  14. @Slf4j
  15. @Component
  16. public class MyApplicationListener01 {
  17.     @EventListener(condition = "#event.myField.equals('陈皮')")
  18.     public void onApplicationEvent(MyApplicationEvent event) {
  19.         log.info(">>> MyApplicationListener：{}", event);
  20.     }
  21. }

还可以在同一个类中定义多个监听，对同一个事件的不同监听还可以指定顺序。order 值越小越先执行。

  1. package com.chenpi;
  3. import org.springframework.context.event.EventListener;
  4. import org.springframework.core.annotation.Order;
  5. import org.springframework.stereotype.Component;
  7. import lombok.extern.slf4j.Slf4j;
  9. /**
  10.  * @Description 自定义监听器
  11.  * @Author 陈皮
  12.  * @Date 2021/6/26
  13.  * @Version 1.0
  14.  */
  15. @Slf4j
  16. @Component
  17. public class MyApplicationListener01 {
  18.     @Order(2)
  19.     @EventListener
  20.     public void onApplicationEvent(MyApplicationEvent event) {
  21.         log.info(">>> onApplicationEvent order=2：{}", event);
  22.     }
  24.     @Order(1)
  25.     @EventListener
  26.     public void onApplicationEvent01(MyApplicationEvent event) {
  27.         log.info(">>> onApplicationEvent order=1：{}", event);
  28.     }
  30.     @EventListener
  31.     public void otherEvent(YourApplicationEvent event) {
  32.         log.info(">>> otherEvent：{}", event);
  33.     }
  34. }

执行结果如下：

  1. >>> onApplicationEvent order=1：MyApplicationEvent{myField='陈皮', source=我是事件源}
  2. >>> onApplicationEvent order=2：MyApplicationEvent{myField='陈皮', source=我是事件源}
  3. >>> otherEvent：MyApplicationEvent{myField='我是自定义事件属性01', source=我是事件源01}

事件的监听处理是同步的，如下：

  1. package com.chenpi;
  3. import lombok.extern.slf4j.Slf4j;
  4. import org.springframework.context.ApplicationEventPublisher;
  5. import org.springframework.context.ApplicationEventPublisherAware;
  6. import org.springframework.stereotype.Service;
  8. /**
  9.  * @Description
  10.  * @Author 陈皮
  11.  * @Date 2021/6/26
  12.  * @Version 1.0
  13.  */
  14. @Service
  15. @Slf4j
  16. public class MyService implements ApplicationEventPublisherAware {
  18.     private ApplicationEventPublisher applicationEventPublisher;
  20.     @Override
  21.     public void setApplicationEventPublisher(ApplicationEventPublisher applicationEventPublisher) {
  22.         this.applicationEventPublisher = applicationEventPublisher;
  23.     }
  25.     public void testEvent() {
  26.         log.info(">>> testEvent begin");
  27.         applicationEventPublisher.publishEvent(new MyApplicationEvent("我是事件源", "陈皮"));
  28.         applicationEventPublisher.publishEvent(new YourApplicationEvent("我是事件源01", "我是自定义事件属性01"));
  29.         log.info(">>> testEvent end");
  30.     }
  31. }

执行结果如下：

  1. 2021-06-26 20:34:27.990  INFO 12936 --- [nio-8081-exec-1] com.chenpi.MyService                     : >>> testEvent begin
  2. 2021-06-26 20:34:27.990  INFO 12936 --- [nio-8081-exec-1] com.chenpi.MyApplicationListener01       : >>> onApplicationEvent order=1：MyApplicationEvent{myField='陈皮', source=我是事件源}
  3. 2021-06-26 20:34:27.991  INFO 12936 --- [nio-8081-exec-1] com.chenpi.MyApplicationListener01       : >>> onApplicationEvent order=2：MyApplicationEvent{myField='陈皮', source=我是事件源}
  4. 2021-06-26 20:34:27.992  INFO 12936 --- [nio-8081-exec-1] com.chenpi.MyApplicationListener01       : >>> otherEvent：MyApplicationEvent{myField='我是自定义事件属性01', source=我是事件源01}
  5. 2021-06-26 20:34:27.992  INFO 12936 --- [nio-8081-exec-1] com.chenpi.MyService                     : >>> testEvent end

不过，我们也可以显示指定异步方式去执行监听器，记得在服务添加 @EnableAsync 注解开启异步注解。

  1. package com.chenpi;
  3. import org.springframework.context.event.EventListener;
  4. import org.springframework.core.annotation.Order;
  5. import org.springframework.scheduling.annotation.Async;
  6. import org.springframework.stereotype.Component;
  8. import lombok.extern.slf4j.Slf4j;
  10. /**
  11.  * @Description 自定义监听器
  12.  * @Author 陈皮
  13.  * @Date 2021/6/26
  14.  * @Version 1.0
  15.  */
  16. @Slf4j
  17. @Component
  18. public class MyApplicationListener01 {
  20.     @Async
  21.     @Order(2)
  22.     @EventListener
  23.     public void onApplicationEvent(MyApplicationEvent event) {
  24.         log.info(">>> onApplicationEvent order=2：{}", event);
  25.     }
  27.     @Order(1)
  28.     @EventListener
  29.     public void onApplicationEvent01(MyApplicationEvent event) {
  30.         log.info(">>> onApplicationEvent order=1：{}", event);
  31.     }
  33.     @Async
  34.     @EventListener
  35.     public void otherEvent(YourApplicationEvent event) {
  36.         log.info(">>> otherEvent：{}", event);
  37.     }
  38. }

执行结果如下，注意打印的线程名。

  1. 2021-06-26 20:37:04.807  INFO 9092 --- [nio-8081-exec-1] com.chenpi.MyService                     : >>> testEvent begin
  2. 2021-06-26 20:37:04.819  INFO 9092 --- [nio-8081-exec-1] com.chenpi.MyApplicationListener01       : >>> onApplicationEvent order=1：MyApplicationEvent{myField='陈皮', source=我是事件源}
  3. 2021-06-26 20:37:04.831  INFO 9092 --- [         task-1] com.chenpi.MyApplicationListener01       : >>> onApplicationEvent order=2：MyApplicationEvent{myField='陈皮', source=我是事件源}
  4. 2021-06-26 20:37:04.831  INFO 9092 --- [nio-8081-exec-1] com.chenpi.MyService                     : >>> testEvent end
  5. 2021-06-26 20:37:04.831  INFO 9092 --- [         task-2] com.chenpi.MyApplicationListener01       : >>> otherEvent：MyApplicationEvent{myField='我是自定义事件属性01', source=我是事件源01}

版权声明：本文为luciochn原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://www.cnblogs.com/luciochn/p/14940123.html