破·新 | 初探spring事件applicationEvent

前言

不知道各位小伙伴对事件（event）这个比较抽象的名词如何理解，从我实际开发和使用经验来说，事件通常指的是某一特定条件下触发的一组操作。

做过生态开发（ISV）的小伙伴一定对事件不陌生，因为在和这些生态厂商（钉钉、企微、飞书等）进行业务交互的时候，总是避不开事件的，我们总是要对接他们的各种事件，比如入职事件、离职事件、用户变更事件、部门变更事件等等。

今天我们就来通过一个简单的示例，来演示下ApplicationListener应用级事件的使用流程。

ApplicationEvent

是什么

一个事件主要包括以下几个要素：

事件注册
事件监听
事件触发

所以ApplicationEvent就是spring提供的一套集事件注册、监听、触发为一体的事件实现。

如何用

创建项目及模块配置

首先我们需要创建一个spring-boot项目，然后在项目的resouces/META-INF文件夹下增加名为spring.factories的文件，如果文件夹不存在，需要手动创建。

这个文件的作用是配置spring boot的常用组件，当然我们也可以通过注解的方式进行配置，关于注解的说明我们后面再说。

我们需要在文件中增加如下配置：

org.springframework.context.ApplicationListener=io.github.syske.springbootbeanlisttest.listener.SyskeApplicationListener

这个文件除了可以配置ApplicationListener之外，还可以配置EnvironmentPostProcessor、PropertySourceLoader、SpringApplicationRunListener，这几个组件的应用，我们后期也会逐一分享。

这种配置方式其实就是SPI机制，这种配置的好处是，可以在不变更项目代码的基础上实现组件的增加和移除。

创建自己的ApplicationListener，这里需要实现ApplicationListener接口，并实现onApplicationEvent方法，事件触发时，会执行该方法。

public class SyskeApplicationListener implements ApplicationListener<SyskeApplicationEvent> {
    @Override
    public void onApplicationEvent(SyskeApplicationEvent event) {
        String eventName = event.getEventName();
        System.out.println(eventName);
        Object eventBody = event.getEventBody();
        System.out.println(eventBody);
    }
}

这个方法的入参是ApplicationEvent或者它的子类，所以这里我们可以根据需要自定义自己的事件，并继承ApplicationEvent

public class SyskeApplicationEvent extends ApplicationEvent {
  
    public SyskeApplicationEvent(Object source) {
        super(source);
    }

    private String eventName;

    private Object eventBody;
    // getter/setter方法省略
}

事件注册

因为我们是直接在spring boot项目中使用的spring的事件组件，所以我们并不需要自己去做时间的注册，因为在spring boot的启动过程中，会帮我们把事件进行注册，关于这块的内容，我在之前分享spring boot启动过程的时候已经分享过了，感兴趣的小伙伴可以去看下（时间久到我都忘记了🐶）：

这里放一个启动流程的图：从上面这个图中，我们可以清楚地看到，这里获取了所有的SpringApplicationRunListener，并分别执行了他们的starting和started方法，但是这里的listener并不是我们的事件监听器，而是spring boot的运行监听器，但是我们事件监听器的初始化确实是在这里完成的，因为这里也初始化了我们事件的运行监听器，并执行了它的的starting和started方法：好了，至此，我们知道spring boot的事件是何时注册的，下面我们来一起看下事件如何触发。

事件触发

事件的触发，没啥好解释的，就是让事件监听器的onApplicationEvent方法执行

 SyskeApplicationEvent syskeApplicationEvent = new SyskeApplicationEvent("test");
        syskeApplicationEvent.setEventName("sysk-event");
        syskeApplicationEvent.setEventBody("sysk-body");
        applicationContext.publishEvent(syskeApplicationEvent);

测试

@GetMapping("/event")
    public Object testEvent() {
        SyskeApplicationEvent syskeApplicationEvent = new SyskeApplicationEvent("test");
        syskeApplicationEvent.setEventName("sysk-event");
        syskeApplicationEvent.setEventBody("sysk-body");
        applicationContext.publishEvent(syskeApplicationEvent);
        return "success";
    }

运行结果：

其实，除了我们上面展示的这种配置方式，spring boot还提供了另一套更简单便捷的事件实现方式：

@Component
public class Syske2ApplicationListenerConfig {

    @EventListener
    public void onApplicationEvent(Syske2ApplicationEvent event) {
        String eventName = event.getEventName();
        System.out.println(eventName);
        Object eventBody = event.getEventBody();
        System.out.println(eventBody);
        System.out.println("Syske2ApplicationEvent");
    }
}