Spring中的事件机制

Spring中通过事件与对应的监听器可以完成很多操作,比如关于context容器的的事件有如下4个:

ContextStartedEvent

明确调用ConfigurableApplicationContext.start()才会触发. 在spring boot中可以使用如下方法触发

@SpringBootApplication
public class DemoApplication {

    public static void main(String[] args) {
        SpringApplication.run(DemoApplication.class, args).start();
    }
}
ContextRefreshedEvent:

当ApplicationContext初始化结束或者刷新的时候触发. 这里的初始化结束是指所有的bean已经加载完毕, post-processor bean被激活, 单例bean被初始化, 同时ApplicationContext对象可以被使用了.
也可以明确调用refresh()方法触发. 但是要注意, 并不是所有的ApplicationContext实例都支持hot refresh的, 比如GenericApplicationContext是不支持hot refresh的, 所以Spring boot中如果直接调用

SpringApplication.run(DemoApplication.class, args).refresh();

就会报
Exception in thread "main" java.lang.IllegalStateException: GenericApplicationContext does not support multiple refresh attempts: just call 'refresh' once
错误, 因为Spring boot中的ApplicationContext实例是AnnotationConfigEmbeddedWebApplicationContext, 是继承于GenericApplicationContext的. 但是XmlWebApplicationContext就是支持hot refresh

ContextStoppedEvent

可以通过调用ConfigurableApplicationContext.stop()触发. 当ApplicationContext调用了stop()之后, 可以重新调用start()启动context.

ContextClosedEvent

当ApplicationContextclose时触发, 可以手动调用close()方法或者直接退出应用来触发.


除了这些已有的事件,我们也可以通过继承ApplicationEvent类来自己定义事件,再使用publishEvent方法来发布事件,这样就可以使用@EventListener定义监听器来进行相关处理了。下面举一个例子:

先定义一个Event事件:

public class MyEvent extends ApplicationEvent {
private String index;
//构造器必须要有Object参数并调用父构造器,这个source就是生成该event的那个对象
MyEvent(Object source,String s) {
    super(source);
    this.index = s;
}

public String getIndex() {
    return index;
}
}

然后我们通过ApplicationContext发布这个事件并添加监听器:

@Configuration
public class Config {

@Autowired
private ApplicationContext context;

//填加一个监听器监听我们的事件,监听到就做相关操作
@EventListener
public void onApplicationEvent(MyEvent event){
    System.out.println("Get My Event !!!!!!");
    System.out.println(event.getIndex());
}
//在容器初始化的时候发布我们定义的事件
@EventListener({EmbeddedServletContainerInitializedEvent.class})
public void onApplicationEvent(EmbeddedServletContainerInitializedEvent event) {
     //发布,其实就是将该event放到一个Set<ApplicationEvent>里
    this.context.publishEvent(new MyEvent(this,"hello jWang"));
}
}

这样我们启动应用,会发现控制台打印了:

Get My Event !!!!!!
hello jWang

如果不使用@EventListener注解(Spring 4.2以后可以用),也可以单独的定义一个监听器类:

@Component
public class Listener implements ApplicationListener<MyEvent> {

@Override
public void onApplicationEvent(MyEvent event) {
    System.out.println("Get My Event Via Listener!!!!!!");
    System.out.println(event.getIndex());
}
}

说了事件机制的使用方法后,再说说它的原理.
可以看出事件机制就是一个Event被发布的时候,Listener会执行相应的操作,这很像一个观察者的设计模式。

查看源码可以发现Listener注册后会被放入一个集合中:

 public final Set<ApplicationListener<?>> applicationListeners = new LinkedHashSet();

然后我们看发布事件的时候发生了什么:

    protected void publishEvent(Object event, ResolvableType eventType) {
    ... ...

    if (this.earlyApplicationEvents != null) {
        this.earlyApplicationEvents.add(applicationEvent);
    } else {
      
       //这一句进去看看
        this.getApplicationEventMulticaster().multicastEvent((ApplicationEvent)applicationEvent, eventType);
    }

    if (this.parent != null) {
        if (this.parent instanceof AbstractApplicationContext) {
            ((AbstractApplicationContext)this.parent).publishEvent(event, eventType);
        } else {
            this.parent.publishEvent(event);
        }
    }
}

事件机制的逻辑核心在类SimpleApplicationEventMulticaster中,那进入multicastEvent方法:

public void multicastEvent(final ApplicationEvent event, ResolvableType eventType) {
    ResolvableType type = eventType != null ? eventType : this.resolveDefaultEventType(event);

    //获取了该事件的Listener集合
    Iterator var4 = this.getApplicationListeners(event, type).iterator();

     //对每个Listener进行处理
    while(var4.hasNext()) {
        final ApplicationListener<?> listener = (ApplicationListener)var4.next();
        Executor executor = this.getTaskExecutor();
        if (executor != null) {
            executor.execute(new Runnable() {
                public void run() {

                    //invokeListener里面就是调用该Listener的onApplicationEvent方法
                    SimpleApplicationEventMulticaster.this.invokeListener(listener, event);
                }
            });
        } else {
            this.invokeListener(listener, event);
        }
    }
}

可以看出事件机制中的观察者模式的实现方式是事件发生时主动推送“通知”观察者调用其处理逻辑(还有一种是观察者自己去轮询查有没有新事件)。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,189评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,577评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,857评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,703评论 1 276
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,705评论 5 366
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,620评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,995评论 3 396
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,656评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,898评论 1 298
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,639评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,720评论 1 330
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,395评论 4 319
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,982评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,953评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,195评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 44,907评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,472评论 2 342

推荐阅读更多精彩内容

  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,732评论 6 342
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,594评论 18 139
  • 标准定制事件 在ApplicationContext中,事件的处理是通过ApplicationEvent和Appl...
    braveheart075阅读 711评论 0 0
  • Spring中的事件机制 Spring中的事件机制是一个观察者模式的实现.观察者模式就是一个目标对象管理所有相依于...
    Haipo阅读 3,365评论 0 0
  • 月纠缠着我 令我烦忧 菊占领了绿洲 我看着窗外 一阵秋风 抖了抖
    恋伊宛似风吹雪阅读 359评论 11 16