一文讲懂Spring Event事件通知机制

一 什么是spring event

        我不会按照官方的解释来说什么是spring event，我只是按照自己的理解来解释，可能原理上会和官方有偏差，但是它的作用和功能就是这个，我更加偏向于从他的功能方面去解释，官方的解释其实有点听不懂。

        ok，说了这么多，到底什么是spring event？我相信event大家都很熟悉，就是事件，那么我么在学前端的时候肯定都知道事件，最常用的就是点击事件，点击一个按钮就触发一个事件。我觉得这里也可以这么理解，只是区别在于这里没有按钮，所以我们只能监听，比如当某个条件达成后，就会自动触发事件。所以，我对于spring event理解就是这样。只是这个监听的对象，在接下来我将一步一步给大家讲清楚。

二 怎么实现spring event

        正如我上面所说的，spring event本身的功能不过就是监听我们设置的某个条件如果触发了，那么就会触发事件，然后执行我们想要执行的代码逻辑。那么很简单，我们只需要定义一个事件，然后监听某个事件，当这个事件被触发，我们就可以执行里面的代码逻辑。

        没错，代码也确实如此，spring提供了一个 ApplicationListener<xxx>接口。只要实现这个接口，就相当于一个事件，尖括号里面的就是我们监听的事件对象，当这个监听的对象达到条件，这个接口里面有一个onApplicationEvent()方法就会被执行，然后我们可以在里面实现我们的逻辑。

        至于监听的对象，我们使用spring的初始化的一些事件，大概都有如下事件：

我们这里就以 ContextRefreshedEvent 当程序上下文初始化后触发这个事件为例，代码如下：

package com.feisi.test.event;

import org.springframework.context.ApplicationListener;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.stereotype.Component;

@Component
public class MyApplicationLister implements ApplicationListener<ContextRefreshedEvent> {
    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
        System.out.println("容器上下文初始化完成后触发，触发的事件源为："+event.getSource());
    }
}

到这里，其实我们就完成了一个事件监听的功能。

但是！！！

我们现在思考一个问题，我们上面这个，当spring上下文初始化后执行，既然是这样，那么我们肯定是需要初始化一些数据，比如往redis缓存一些初始化数据等等，或者是我们自定义的一些数据。

但是上面这个示例，我们得到的参数只是事件源对象，但这个事件源对象，是spring给我们提供，我们肯定没办法自定义我们想要的数据。所以我们想要自定义我们需要的数据，那么只能自己定义一个事件源对象。

但是我们自定义了一个数据源对象，怎么才能发布这个对象呢？

这里我们再来解释一下上面那个示例的执行原理，我们的事件源对象是ContextRefreshEvent,当spring上下文对象 初始化完成后，spring就会自动帮我们发布这个事件，或者是说注册这个事件，这个时候，它就会通知所有spring容器里面实现了接口(ApplicationList)并且监听的事件源对象是ContextRefreshEvent的Bean对象，也就是上面我定义的这个对象，那么它满足条件就会收到这个信号，它就会被执行onApplicationEvent方法。

那么到这里，我们已经明白整个执行流程，那么我现在是不是可以自定义一个事件，并且在里面可以自定我们想要的数据，然后在我上面示例的基础上，我们把onApplicationEvent方法里面的逻辑改成发布/注册我们自定义的事件对象，然后，我们再创建一个类，但是这个类监听的事件源对象是我们自定义的对象，这样我们自定义的事件对象被发布后，那么监听我们自定义事件源的就会被触发，然后执行里面onApplicationEvent方法，这样传来的参数就是我们自定义的事件源对象，这样该对象里面肯定就会有我们自定义的数据，我们就完成了对自定义数据的处理。

所以，在上面的基础上，我们自定义一个事件源对象。

package com.feisi.test.event;

import lombok.Data;
import org.springframework.context.ApplicationEvent;

import java.time.Clock;

public class MyApplicationEvent extends ApplicationEvent {
     private String name ;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    /**
     * 必须要生成有参构造函数
     * @param source 发布这个事件的
     * @param name  我们传入我们自定义的参数
     */
    public MyApplicationEvent(Object source, String name) {
        super(source);
        this.name = name ; 
    }
}

自定义事件对象完成后，我们需要把上面示例中的里面的onApplicationEvent方法中的逻辑代码改一下。应该改成，当容器上下文初始化完成后，调用这个方法，然后在这个方法发布我们自定义的事件对象。

package com.feisi.test.event;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.context.event.ApplicationReadyEvent;
import org.springframework.context.ApplicationContext;
import org.springframework.context.ApplicationListener;
import org.springframework.context.event.ContextRefreshedEvent;
import org.springframework.stereotype.Component;

import java.util.concurrent.atomic.AtomicBoolean;

@Component
public class MyApplicationLister implements ApplicationListener<ContextRefreshedEvent> {
    @Autowired
    private ApplicationContext applicationContext ; //用于发布我们自定义的事件对象

    private AtomicBoolean flag = new AtomicBoolean(false);  // 用于防止二次触发事件

    @Override
    public void onApplicationEvent(ContextRefreshedEvent event) {
        System.out.println("容器初始化完成后，触发事件....");
        //发布我们自定义的事件
        if(flag.compareAndSet(false,true)){  //true: 修改成功  false: 没修改
            applicationContext.publishEvent(new MyApplicationEvent(this,"zhangsan"));
        }
    }
}

到这里，当spring初始化完成后，就会触发，然后将我们自定义的事件发布，这个时候，spring就会通知自己容器里面所有的bean，如果你实现了ApplicationEvent事件接口，并且你监听的对象是刚刚已经发布的MyApplicatioinEvent对象，那么你就已经达到了触发的调用，就会被自动执行。

所以，我们现在只需要再自定义一个类实现接口，并且监听我们自定义的事件对象，我们这个就会被触发，我们传入的参数也是我们自定义的事件，我们就可以执行相关的逻辑代码：

package com.feisi.test.demo;

import com.feisi.test.event.MyApplicationEvent;
import org.springframework.context.ApplicationListener;
import org.springframework.stereotype.Component;

@Component
public class MyApplicationEventListerTest implements ApplicationListener<MyApplicationEvent> {
    @Override
    public void onApplicationEvent(MyApplicationEvent event) {
        System.out.println("自定义事件源发布，开始触发事件，初始化自定义数据:"+event.getName());
    }
}

整体大概执行流程图如下：