Spring-boot事件監(jiān)聽(tīng)和源碼分析

springboot的事件監(jiān)聽(tīng):為bean之間的消息通信提供支持骑歹。當(dāng)一個(gè)bean做完一件事以后,通知另一個(gè)bean知曉并做出相應(yīng)處理。這時(shí)负懦,我們需要另一個(gè)bean,監(jiān)聽(tīng)當(dāng)前bean所發(fā)生的事件柏腻。

實(shí)現(xiàn)步驟:四個(gè)步驟纸厉,五種方式

第一種方式

  1、自定義事件五嫂,一般是繼承ApplicationEvent抽象類(lèi)
  2颗品、定義事件監(jiān)聽(tīng)器,一般是實(shí)現(xiàn)ApplicationListener接口
  3沃缘、 1)把監(jiān)聽(tīng)器加入到SpringApplication中:ApplicationListener.addListener();然后發(fā)布事件
      2)或放置到spring容器:@Conponent
      3)或在application.properties配置文件中配置context.listener.classes=監(jiān)聽(tīng)器全類(lèi)名
      4)或在META-INF/spring.factories配置文件中配置org.springframework.context.ApplicationListener=監(jiān)聽(tīng)器全類(lèi)名
      5)或編寫(xiě)一個(gè)類(lèi)躯枢,納入spring容器中,編寫(xiě)一個(gè)帶參的方法槐臀,參數(shù)為事件的父類(lèi)或需要監(jiān)聽(tīng)的事件锄蹂,加上@EventListener
  3、發(fā)布事件

第一步:自定義事件水慨,繼承ApplicationEvent抽象類(lèi)

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

第二步:自定義事件監(jiān)聽(tīng)器得糜,實(shí)現(xiàn)ApplicationListener接口

public class MyApplicationListener implements ApplicationListener<MyApplicationEvent> {
    @Override
    public void onApplicationEvent(MyApplicationEvent myApplicationEvent) {
        System.out.println(myApplicationEvent.getClass().getName() + "被監(jiān)聽(tīng)......");
    }
}

第三、四步:把監(jiān)聽(tīng)器加入spring中晰洒,然后發(fā)布事件

@SpringBootApplication
public class BlogApplication {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(BlogApplication.class, args);
        //把監(jiān)聽(tīng)器加入到SpringApplication中
        context.addApplicationListener(new MyApplicationListener());
        //發(fā)布事件
        context.publishEvent(new MyApplicationEvent(new Object()));
        context.close();
    }
}
console result

第二種方式:換一種方式將監(jiān)聽(tīng)器加入spring容器中(只需修改BlogApplication)

通過(guò)@component注解朝抖,將監(jiān)聽(tīng)器加入spring容器中

BlogApplication.class

第三種方式:在application.properties配置文件中配置context.listener.classes=監(jiān)聽(tīng)器全類(lèi)名

application.properties

第四種方式:在META-INF/spring.factories配置文件中配置org.springframework.context.ApplicationListener=監(jiān)聽(tīng)器全類(lèi)名

第五種方式:編寫(xiě)一個(gè)類(lèi)MyEventHandler,替代上文中的MyApplicationListener欢顷,將其納入spring容器中,編寫(xiě)一個(gè)帶參的方法捉蚤,參數(shù)為需要監(jiān)聽(tīng)的事件的父類(lèi)或需要監(jiān)聽(tīng)的事件抬驴,加上@EventListener。(參數(shù)的范圍越廣泛缆巧,監(jiān)聽(tīng)到的事件越多)

MyEventHandler.class

實(shí)現(xiàn)原理

第三種方式:配置application.properties的方式的實(shí)現(xiàn)原理布持,
參照DelegatingApplicationListener.class的源碼:

DelegatingApplicationListener.class

我們發(fā)現(xiàn)這個(gè)類(lèi)中申明了一個(gè)常量PROPERTY_NAME = "context.listener.classes",接著往下看onApplicationEvent方法陕悬,源碼作者首先從application.properties配置文件中讀取到以"context.listener.classes"為key的Listener全類(lèi)名题暖,通過(guò)ClassLoader把他們實(shí)例化成Listener對(duì)象,繼而存入一個(gè)List<ApplicationListener<ApplicationEvent>> listeners集合中,最后將他們排序后將他們挨個(gè)加入事件廣播中胧卤。有興趣的讀者可以結(jié)合我的解析閱讀以下源碼唯绍!

實(shí)際工作如何使用

上文我們說(shuō)到了如何定義一個(gè)事件和監(jiān)聽(tīng)器,那在工作中枝誊,如果我們要使用事件為我們達(dá)到一些目的况芒,難道需要實(shí)現(xiàn)這么麻煩的過(guò)程嘛?答案是no叶撒!spring和springboot已經(jīng)給我們編寫(xiě)好了豐富的事件供我們使用绝骚。

spring提供的event

springboot提供的event

我們這里做一個(gè)簡(jiǎn)單的小范例,監(jiān)聽(tīng)一個(gè)ContextClosedEvent事件祠够。
編寫(xiě)監(jiān)聽(tīng)器

@Component
public class ContextClosedEventHandler {
    @EventListener
    public void listener(ContextClosedEvent event) {
        System.out.println("spring context stop...." + event.getClass().getName());
    }
}

編寫(xiě)B(tài)logApplication

@SpringBootApplication
public class BlogApplication {
    public static void main(String[] args) {
        ConfigurableApplicationContext context = SpringApplication.run(BlogApplication.class, args);
        context.close();
    }
}
console result

至此压汪,springboot的五種事件監(jiān)聽(tīng)方式就介紹完畢啦~,如果有對(duì)springboot非常感興趣的讀者古瓤,可以關(guān)注我的springboot系列博客止剖,里面有更多的干貨分享給大家!

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
  • 序言:七十年代末湿滓,一起剝皮案震驚了整個(gè)濱河市滴须,隨后出現(xiàn)的幾起案子,更是在濱河造成了極大的恐慌叽奥,老刑警劉巖扔水,帶你破解...
    沈念sama閱讀 217,509評(píng)論 6 504
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件,死亡現(xiàn)場(chǎng)離奇詭異朝氓,居然都是意外死亡魔市,警方通過(guò)查閱死者的電腦和手機(jī),發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 92,806評(píng)論 3 394
  • 文/潘曉璐 我一進(jìn)店門(mén)赵哲,熙熙樓的掌柜王于貴愁眉苦臉地迎上來(lái)待德,“玉大人,你說(shuō)我怎么就攤上這事枫夺〗埽” “怎么了?”我有些...
    開(kāi)封第一講書(shū)人閱讀 163,875評(píng)論 0 354
  • 文/不壞的土叔 我叫張陵橡庞,是天一觀的道長(zhǎng)较坛。 經(jīng)常有香客問(wèn)我,道長(zhǎng)扒最,這世上最難降的妖魔是什么丑勤? 我笑而不...
    開(kāi)封第一講書(shū)人閱讀 58,441評(píng)論 1 293
  • 正文 為了忘掉前任,我火速辦了婚禮吧趣,結(jié)果婚禮上法竞,老公的妹妹穿的比我還像新娘耙厚。我一直安慰自己,他們只是感情好岔霸,可當(dāng)我...
    茶點(diǎn)故事閱讀 67,488評(píng)論 6 392
  • 文/花漫 我一把揭開(kāi)白布薛躬。 她就那樣靜靜地躺著,像睡著了一般秉剑。 火紅的嫁衣襯著肌膚如雪泛豪。 梳的紋絲不亂的頭發(fā)上,一...
    開(kāi)封第一講書(shū)人閱讀 51,365評(píng)論 1 302
  • 那天侦鹏,我揣著相機(jī)與錄音诡曙,去河邊找鬼。 笑死略水,一個(gè)胖子當(dāng)著我的面吹牛价卤,可吹牛的內(nèi)容都是我干的。 我是一名探鬼主播渊涝,決...
    沈念sama閱讀 40,190評(píng)論 3 418
  • 文/蒼蘭香墨 我猛地睜開(kāi)眼慎璧,長(zhǎng)吁一口氣:“原來(lái)是場(chǎng)噩夢(mèng)啊……” “哼!你這毒婦竟也來(lái)了跨释?” 一聲冷哼從身側(cè)響起胸私,我...
    開(kāi)封第一講書(shū)人閱讀 39,062評(píng)論 0 276
  • 序言:老撾萬(wàn)榮一對(duì)情侶失蹤,失蹤者是張志新(化名)和其女友劉穎鳖谈,沒(méi)想到半個(gè)月后岁疼,有當(dāng)?shù)厝嗽跇?shù)林里發(fā)現(xiàn)了一具尸體,經(jīng)...
    沈念sama閱讀 45,500評(píng)論 1 314
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡缆娃,尸身上長(zhǎng)有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 37,706評(píng)論 3 335
  • 正文 我和宋清朗相戀三年捷绒,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片贯要。...
    茶點(diǎn)故事閱讀 39,834評(píng)論 1 347
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡暖侨,死狀恐怖,靈堂內(nèi)的尸體忽然破棺而出崇渗,到底是詐尸還是另有隱情字逗,我是刑警寧澤,帶...
    沈念sama閱讀 35,559評(píng)論 5 345
  • 正文 年R本政府宣布宅广,位于F島的核電站葫掉,受9級(jí)特大地震影響,放射性物質(zhì)發(fā)生泄漏乘碑。R本人自食惡果不足惜挖息,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 41,167評(píng)論 3 328
  • 文/蒙蒙 一金拒、第九天 我趴在偏房一處隱蔽的房頂上張望兽肤。 院中可真熱鬧套腹,春花似錦、人聲如沸资铡。這莊子的主人今日做“春日...
    開(kāi)封第一講書(shū)人閱讀 31,779評(píng)論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽(yáng)笤休。三九已至尖飞,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間店雅,已是汗流浹背政基。 一陣腳步聲響...
    開(kāi)封第一講書(shū)人閱讀 32,912評(píng)論 1 269
  • 我被黑心中介騙來(lái)泰國(guó)打工, 沒(méi)想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留闹啦,地道東北人沮明。 一個(gè)月前我還...
    沈念sama閱讀 47,958評(píng)論 2 370
  • 正文 我出身青樓,卻偏偏與公主長(zhǎng)得像窍奋,于是被迫代替她去往敵國(guó)和親荐健。 傳聞我的和親對(duì)象是個(gè)殘疾皇子,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 44,779評(píng)論 2 354

推薦閱讀更多精彩內(nèi)容