Spring 源码分析——Event 事件机制

本篇文章讨论 Spring 源码中 Event 事件机制，Spring 如何提供对事件的发布和监听功能。

对应 Github 源码完整文档：https://github.com/TyCoding/mini-spring/blob/main/docs/ioc/12-spring-event

引言

Spring 中的事件机制是一种基于观察者模式的设计；用于组件之间的松耦合，通过事件机制，可以在一个组件发生变化时通知其他组件进行相应的处理，从而实现组件之间的消息传递和协作。

观察者模式：

主题 Subject：被观察的对象或事件源，维护一个观察者列表，提供注册、删除、通知观察者的方法；
观察者 Observer：表示观察主题的对象或事件处理器，它定义了一个更新接口，在收入主题更新通知时进行相应的处理；
具体主题 Concreate Subject：表示具体的被观察对象或事件源，它实现主题接口，并维护一份观察者列表，负责像观察者发送通知消息；
具体观察者 Concreate Observer：表示具体的观察者对象或事件处理器，它实现观察者接口，并在更新方法中实现自己的业务逻辑；

Spring 事件机制组成：

ApplicationEvent： 表示一个事件，它是所有自定义事件的基类；
ApplicationEventPublisher： 表示一个事件发布者，它负责将事件发布给对应的订阅者；
ApplicationListener： 表示一个事件监听器，负责订阅并处理特定类型的事件；
ApplicationEventMulticaster： 表示事件多路广播器，负责将事件广播给多个监听器；

那么 Spring 事件机制和观察者模式如何对应的

事件源、主题（Subject）—具体主题：ApplicationEvent —— 实现了 ApplicationEvent 的具体事件
事件监听器、观察者（Observer）—具体观察者：ApplicationListener —— 实现了 ApplicationListener 的具体监听器
事件管理器：ApplicationEventPublisher

案例

我们需要自定义一个继承ApplicationEvent的事件 MyEvent，然后再定义一个实现ApplicationListener接口的监听器 MyEventListener，最终通过 Spring 内置的ApplicationEventPublisher发布事件：

public class MyEvent extends ApplicationEvent {

    private final String message;

    public MyEvent(Object source, String message) {
        super(source);
        this.message = message;
    }

    public String getMessage() {
        return message;
    }
}

@Component
public class MyEventListener implements ApplicationListener<MyEvent> {

    @Override
    public void onApplicationEvent(MyEvent event) {
        System.out.println("Received MyEvent: " + event.getMessage());
    }
}

@RestController
public class EventController {

    @Autowired
    private ApplicationEventPublisher publisher;

    @GetMapping("/event")
    public String home() {
        MyEvent event = new MyEvent(this, "Hello World!");
        publisher.publishEvent(event);
        return "Event published";
    }
}

当访问localhost:8080/event的时候会将MyEvent事件发布出去，并被MyEventListener监听器监听到，打印：

Received MyEvent: Hello World!

源码分析

注意：只有继承自ApplicationEvent类的对象才被认为是事件，才能被正确的发布和处理。

因此AplicationEvent是所有事件的基类，我们可以从ApplicationEventPublisher#publishEvent()函数追溯源码：

public interface ApplicationEventPublisher {

 default void publishEvent(ApplicationEvent event) {
  publishEvent((Object) event);
 }

 void publishEvent(Object event);
}

虽然存在一个publishEvent(Object event)函数，但实际上必须是继承ApplicationEvent的事件才能被发布，因此我们使用publishEvent发布自定义事件时其实也是经过publishEvent(ApplicationEvent event)函数。源码中的继承关系如下：

对于ApplicationEventPublisher事件发布器，可以追溯publishEvent实现类AbstractApplicationContext：

其实publishEvent的核心实现就是调用ApplicationEventMulticaster#multicaseEvent()函数，而对于 ApplicationEventMulticaster 接口只有一个默认实现SimpleApplicationEventMulticaster，可以看下是如何实现multicaseEvent()函数的：

其实可以简单理解，Spring 对于事件发布器的实现其实就是广播模式，根据事件 Class 类型从所有 Bean 中符合条件的 Listener，然后循环调用监听器的onApplicationEvent()函数，因此就会执行我们自定义的监听器逻辑；以此实现事件通知功能。

Spring 源码专栏

此专栏将从 Spring 源码角度整体分析 Spring 设计思路以及常见的面试题。

配套作者的手写 Spring 的项目：https://github.com/TyCoding/mini-spring 。该项目中包含各个阶段的开发文档，有关 Spring 源码更详细的分析测试文档请查阅：https://github.com/TyCoding/mini-spring/tree/main/docs