Spring 事件

Java 事件/监听器编程模型

• 设计模式 - 观察者模式扩展

• 可观者对象（消息发送者） - java.util.Observable
• 观察者 - java.util.Observer

• 标准化接口

• 事件对象 - java.util.EventObject
• 事件监听器 - java.util.EventListener

面向接口的事件/监听器设计模式

• 事件/监听器场景举例

Java 技术规范	事件接口	监听器接口
JavaBeans	java.beans.PropertyChangeEvent	java.beans.PropertyChangeListener
Java AWT	java.awt.event.MouseEvent	java.awt.event.MouseListener
Java Swing	javax.swing.event.MenuEvent	javax.swing.event.MenuListener
Java Preference	java.util.prefs.PreferenceChangeEvent	java.util.prefs.PreferenceChangeListener

面向注解的事件/监听器设计模式

• 事件/监听器注解场景举例

Java 技术规范	事件注解	监听器注解
Servlet 3.0+		@javax.servlet.annotation.WebListener
JPA 1.0+	@javax.persistence.PostPersist
Java Common	@PostConstruct
EJB 3.0+	@javax.ejb.PrePassivate
JSF 2.0+	@javax.faces.event.ListenerFor

Spring 标准事件 - ApplicationEvent

• Java 标准事件 java.util.EventObject 扩展

• 扩展特性：事件发生事件戳

• Spring 应用上下文 ApplicationEvent 扩展 - ApplicationContextEvent

• Spring 应用上下文（ApplicationContext）作为事件源
• 具体实现：
  • org.springframework.context.event.ContextClosedEvent
  • org.springframework.context.event.ContextRefreshedEvent
  • org.springframework.context.event.ContextStartedEvent
  • org.springframework.context.event.ContextStoppedEvent

基于接口的 Spring 事件监听器

Java 标准事件监听器 java.util.EventListener 扩展

• 扩展接口 - org.springframework.context.ApplicationListener
• 设计特点：单一类型事件处理
• 处理方法：onApplicationEvent(ApplicationEvent)
• 事件类型：org.springframework.context.ApplicationEvent

基于注解的 Spring 事件监听器

• Spring 注解 - @org.springframework.context.event.EventListener

特性	说明
设计特点	支持多 ApplicationEvent 类型，无需接口约束
注解目标	方法
是否支持异步执行	支持
是否支持泛型类型事件	支持
是指支持顺序控制	支持，配合 @Order 注解控制

注册 Spring ApplicationListener

• 方法一：ApplicationListener 作为 Spring Bean 注册
• 方法二：通过 ConfigurableApplicationContext API 注册

Spring 事件发布器

• 方法一：通过 ApplicationEventPublisher 发布 Spring 事件

• 获取 ApplicationEventPublisher
  • 依赖注入

• 方法二：通过 ApplicationEventMulticaster 发布 Spring 事件

• 获取 ApplicationEventMulticaster
  • 依赖注入
  • 依赖查找

Spring 层次性上下文事件传播

• 发生说明
当 Spring 应用出现多层次 Spring 应用上下文（ApplicationContext）时，如 Spring WebMVC、
Spring Boot 或 Spring Cloud 场景下，由子 ApplicationContext 发起 Spring 事件可能会传递到其
Parent ApplicationContext（直到 Root）的过程

/**
 * 层次性 Spring 事件传播实例
 */
public class HierarchicalSpringEventPropagateDemo {

    public static void main(String[] args) {
        // 1. 创建 parent Spring 应用上下文
        AnnotationConfigApplicationContext parentContext = new AnnotationConfigApplicationContext();
        parentContext.setId("parent-context");
        // 注册 MyListener 到 parent Spring 应用上下文
        parentContext.register(MyListener.class);

        // 2. 创建 current Spring 应用上下文
        AnnotationConfigApplicationContext currentContext = new AnnotationConfigApplicationContext();
        currentContext.setId("current-context");
        // 3. current -> parent
        currentContext.setParent(parentContext);
        // 注册 MyListener 到 current Spring 应用上下文
        currentContext.register(MyListener.class);

        // 4.启动 parent Spring 应用上下文
        parentContext.refresh();

        // 5.启动 current Spring 应用上下文
        currentContext.refresh();

        // 关闭所有 Spring 应用上下文
        currentContext.close();
        parentContext.close();
    }

    static class MyListener implements ApplicationListener<ApplicationContextEvent> {

        private Set<ApplicationContextEvent> processedEvents = new LinkedHashSet<>();

        @Override
        public void onApplicationEvent(ApplicationContextEvent event) {
            if (processedEvents.add(event)) {
                System.out.printf("监听到 Spring 应用上下文[ ID : %s ] 事件 :%s\n", event.getApplicationContext().getId(),
                        event.getClass().getSimpleName());
            }
        }
    }
}

• 如何避免
定位 Spring 事件源（ApplicationContext）进行过滤处理

Spring 内建事件

ApplicationContextEvent 派生事件

• ContextRefreshedEvent ：Spring 应用上下文就绪事件
• ContextStartedEvent ：Spring 应用上下文启动事件
• ContextStoppedEvent ：Spring 应用上下文停止事件
• ContextClosedEvent ：Spring 应用上下文关闭事件

Spring 4.2 Payload 事件

• Spring Payload 事件 - org.springframework.context.PayloadApplicationEvent
• 使用场景：简化 Spring 事件发送，关注事件源主体
• 发送方法
• ApplicationEventPublisher#publishEvent(java.lang.Object)

//IllegalArgumentException: Mismatched number of generics specified
static class MyPayloadApplicationEvent extends PayloadApplicationEvent<String> {

    /**
     * Create a new PayloadApplicationEvent.
     *
     * @param source  the object on which the event initially occurred (never {@code null})
     * @param payload the payload object (never {@code null})
     */
    public MyPayloadApplicationEvent(Object source, String payload) {
        super(source, payload);
    }
}

自定义 Spring 事件

• 扩展 org.springframework.context.ApplicationEvent
• 实现 org.springframework.context.ApplicationListener
• 注册 org.springframework.context.ApplicationListener

依赖注入 ApplicationEventPublisher

• 通过 ApplicationEventPublisherAware 回调接口

依赖查找 ApplicationEventMulticaster

• 查找条件
• Bean 名称：“applicationEventMulticaster”
• Bean 类型：org.springframework.context.event.ApplicationEventMulticaster

ApplicationEventPublisher 底层实现

• 底层实现
• org.springframework.context.event.ApplicationEventMulticaster 的实现