記一次使用spring事件機(jī)制失效排查修復(fù)

前言

在日常業(yè)務(wù)開發(fā)中過程井氢,我們有時(shí)候?yàn)榱藰I(yè)務(wù)解耦瘪板,會(huì)利用spring的機(jī)制捂龄,就是利用spring提供的ApplicationListener淑仆、ApplicationEventMulticaster等核心API來實(shí)現(xiàn)涝婉。(注: 我這邊列的是核心底層API接口,正常我們會(huì)用監(jiān)聽事件用@EventListener蔗怠,發(fā)布事件用 applicationContext.publishEvent()或者applicationEventPublisher.publishEvent())

本文案例主要來自團(tuán)隊(duì)的小伙伴墩弯,在利用spring事件機(jī)制踩到的坑。直接以案例的形式來講解

示例案例

案例場景:當(dāng)項(xiàng)目啟動(dòng)時(shí)寞射,從數(shù)據(jù)庫加載學(xué)生數(shù)據(jù)渔工,并放到本地緩存。為了業(yè)務(wù)解耦 桥温,團(tuán)隊(duì)小王采用了spring的事件驅(qū)動(dòng)方式來實(shí)現(xiàn)引矩。他的實(shí)現(xiàn)步驟如下

1、定義學(xué)生事件

public class StudentEvent extends ApplicationEvent {
    /**
     * Create a new {@code ApplicationEvent}.
     *
     * @param source the object on which the event initially occurred or with
     *               which the event is associated (never {@code null})
     */
    public StudentEvent(Object source) {
        super(source);
    }
}

2侵浸、創(chuàng)建學(xué)生事件發(fā)布

@Service
@RequiredArgsConstructor
public class StudentServiceImpl extends ServiceImpl<StudentDao, StudentEntity> implements StudentService,InitializingBean {

    private final StudentDao studentDao;
    private final ApplicationContext applicationContext;

    @Override
    public void afterPropertiesSet() throws Exception {
        StudentEvent studentEvent = new StudentEvent(studentDao.listStudents());
        applicationContext.publishEvent(studentEvent);
    }
    @Override
    public List<StudentEntity> listStudents() {
        return studentDao.listStudents();
    }
}

3旺韭、創(chuàng)建事件監(jiān)聽

@Component
public class StudentCache {
    private Map<Integer, StudentEntity> studentMap = new ConcurrentHashMap<>();

    @EventListener
    public void listener(StudentEvent studentEvent){
        if(studentEvent.getSource() instanceof List){
            List<StudentEntity> studentEntityList = (List<StudentEntity>) studentEvent.getSource();
            if(studentEntityList != null){
                studentEntityList.forEach(studentEntity -> {
                    studentMap.put(studentEntity.getSId(), studentEntity);
                });
            }
        }

        System.out.println(studentMap);
    }

}

思考題:StudentCache能否正常接收到學(xué)生事件?

答案: 接收不到

問題解惑

首先我們要先確認(rèn)事件監(jiān)聽的觀察者掏觉,是何時(shí)加入事件監(jiān)聽容器区端?

我們可以從事件監(jiān)聽注解@EventListener入手,通過源碼我們可以發(fā)現(xiàn)事件監(jiān)聽的觀察者澳腹,是通過

org.springframework.context.event.EventListenerMethodProcessor#afterSingletonsInstantiated

方法調(diào)用加入到事件監(jiān)聽容器珊燎,而這個(gè)方法的調(diào)用時(shí)機(jī)是在

org.springframework.beans.factory.support.DefaultListableBeanFactory#preInstantiateSingletons
d705d5d322c623d3e9912bd926087213_b81c20ccc2cd30e48cec68932876d896.png

即在所有非懶加載單例bean加載入spring單例池后才觸發(fā)調(diào)用。而案例中遵湖,事件的發(fā)布放在

com.github.lybgeek.student.service.impl.StudentServiceImpl#afterPropertiesSet

實(shí)現(xiàn)悔政,該方法會(huì)比afterSingletonsInstantiated更先執(zhí)行,而此時(shí)事件監(jiān)聽容器還沒有該事件的觀察者延旧,就會(huì)導(dǎo)致事件發(fā)布了谋国,但是沒有相應(yīng)觀察者進(jìn)行監(jiān)聽

問題修復(fù)

方法有很多種,可以利用spring自帶的事件迁沫,比如監(jiān)聽ContextRefreshedEvent事件后芦瘾,再進(jìn)行事件發(fā)布

@EventListener
    public void afterPropertiesSet(ContextRefreshedEvent contextRefreshedEvent) throws Exception {
        StudentEvent studentEvent = new StudentEvent(studentDao.listStudents());
        applicationContext.publishEvent(studentEvent);
    }

也可以利用spring其他擴(kuò)展點(diǎn),比如SmartInitializingSingleton集畅,如果是springboot應(yīng)用近弟,還可以用CommandLineRunner或者ApplicationRunner

總結(jié)

本文修復(fù)問題的關(guān)鍵其實(shí)就是在于對(duì)spring一些擴(kuò)展機(jī)制的優(yōu)先調(diào)用順序的了解

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請聯(lián)系作者
  • 序言:七十年代末,一起剝皮案震驚了整個(gè)濱河市挺智,隨后出現(xiàn)的幾起案子祷愉,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 206,968評(píng)論 6 482
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件二鳄,死亡現(xiàn)場離奇詭異赴涵,居然都是意外死亡,警方通過查閱死者的電腦和手機(jī)订讼,發(fā)現(xiàn)死者居然都...
    沈念sama閱讀 88,601評(píng)論 2 382
  • 文/潘曉璐 我一進(jìn)店門髓窜,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人欺殿,你說我怎么就攤上這事寄纵。” “怎么了脖苏?”我有些...
    開封第一講書人閱讀 153,220評(píng)論 0 344
  • 文/不壞的土叔 我叫張陵程拭,是天一觀的道長。 經(jīng)常有香客問我帆阳,道長哺壶,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 55,416評(píng)論 1 279
  • 正文 為了忘掉前任蜒谤,我火速辦了婚禮山宾,結(jié)果婚禮上,老公的妹妹穿的比我還像新娘鳍徽。我一直安慰自己资锰,他們只是感情好,可當(dāng)我...
    茶點(diǎn)故事閱讀 64,425評(píng)論 5 374
  • 文/花漫 我一把揭開白布阶祭。 她就那樣靜靜地躺著绷杜,像睡著了一般。 火紅的嫁衣襯著肌膚如雪濒募。 梳的紋絲不亂的頭發(fā)上鞭盟,一...
    開封第一講書人閱讀 49,144評(píng)論 1 285
  • 那天,我揣著相機(jī)與錄音瑰剃,去河邊找鬼齿诉。 笑死,一個(gè)胖子當(dāng)著我的面吹牛晌姚,可吹牛的內(nèi)容都是我干的粤剧。 我是一名探鬼主播,決...
    沈念sama閱讀 38,432評(píng)論 3 401
  • 文/蒼蘭香墨 我猛地睜開眼挥唠,長吁一口氣:“原來是場噩夢啊……” “哼抵恋!你這毒婦竟也來了?” 一聲冷哼從身側(cè)響起宝磨,我...
    開封第一講書人閱讀 37,088評(píng)論 0 261
  • 序言:老撾萬榮一對(duì)情侶失蹤弧关,失蹤者是張志新(化名)和其女友劉穎盅安,沒想到半個(gè)月后,有當(dāng)?shù)厝嗽跇淞掷锇l(fā)現(xiàn)了一具尸體梯醒,經(jīng)...
    沈念sama閱讀 43,586評(píng)論 1 300
  • 正文 獨(dú)居荒郊野嶺守林人離奇死亡宽堆,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內(nèi)容為張勛視角 年9月15日...
    茶點(diǎn)故事閱讀 36,028評(píng)論 2 325
  • 正文 我和宋清朗相戀三年腌紧,在試婚紗的時(shí)候發(fā)現(xiàn)自己被綠了茸习。 大學(xué)時(shí)的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片。...
    茶點(diǎn)故事閱讀 38,137評(píng)論 1 334
  • 序言:一個(gè)原本活蹦亂跳的男人離奇死亡壁肋,死狀恐怖号胚,靈堂內(nèi)的尸體忽然破棺而出,到底是詐尸還是另有隱情浸遗,我是刑警寧澤猫胁,帶...
    沈念sama閱讀 33,783評(píng)論 4 324
  • 正文 年R本政府宣布,位于F島的核電站跛锌,受9級(jí)特大地震影響弃秆,放射性物質(zhì)發(fā)生泄漏。R本人自食惡果不足惜髓帽,卻給世界環(huán)境...
    茶點(diǎn)故事閱讀 39,343評(píng)論 3 307
  • 文/蒙蒙 一菠赚、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧郑藏,春花似錦衡查、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 30,333評(píng)論 0 19
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至歌粥,卻和暖如春塌忽,著一層夾襖步出監(jiān)牢的瞬間,已是汗流浹背失驶。 一陣腳步聲響...
    開封第一講書人閱讀 31,559評(píng)論 1 262
  • 我被黑心中介騙來泰國打工土居, 沒想到剛下飛機(jī)就差點(diǎn)兒被人妖公主榨干…… 1. 我叫王不留,地道東北人突勇。 一個(gè)月前我還...
    沈念sama閱讀 45,595評(píng)論 2 355
  • 正文 我出身青樓装盯,卻偏偏與公主長得像,于是被迫代替她去往敵國和親甲馋。 傳聞我的和親對(duì)象是個(gè)殘疾皇子埂奈,可洞房花燭夜當(dāng)晚...
    茶點(diǎn)故事閱讀 42,901評(píng)論 2 345

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