Spring中的ApplicationListener以及觀察者模式
1.介紹
在之前的文章從SpringBoot啟動(dòng)過(guò)程分析到自定義一個(gè)springboot-starter中我們看到了Spring監(jiān)聽(tīng)器在SpringApplication得啟動(dòng)過(guò)程中扮演了相當(dāng)重要的角色,
在SpringApplication初始化和ConfigurableApplicationContext創(chuàng)建的不同階段通過(guò)發(fā)布相應(yīng)類(lèi)型的事件,不同的ApplicationListener監(jiān)聽(tīng)到相應(yīng)的Event執(zhí)行從而完成了自己對(duì)應(yīng)的一些初始化操作。
2.spring內(nèi)置的ApplicationListener分析
SpringBoot2.3.3中spring.factories中內(nèi)置了如下的ApplicationListener:
# Application Listeners
org.springframework.context.ApplicationListener=\
org.springframework.boot.ClearCachesApplicationListener,\
org.springframework.boot.builder.ParentContextCloserApplicationListener,\
org.springframework.boot.cloud.CloudFoundryVcapEnvironmentPostProcessor,\
org.springframework.boot.context.FileEncodingApplicationListener,\
org.springframework.boot.context.config.AnsiOutputApplicationListener,\
org.springframework.boot.context.config.ConfigFileApplicationListener,\
org.springframework.boot.context.config.DelegatingApplicationListener,\
org.springframework.boot.context.logging.ClasspathLoggingApplicationListener,\
org.springframework.boot.context.logging.LoggingApplicationListener,\
org.springframework.boot.liquibase.LiquibaseServiceLocatorApplicationListener
來(lái)看下其中一些主要的listener的作用:
ApplicationListener | 作用 | 監(jiān)聽(tīng)事件 |
---|---|---|
ClearCachesApplicationListener | 上下文環(huán)境context加載后清理緩存 | ContextRefreshedEvent |
ParentContextCloserApplicationListener | 如果父對(duì)象關(guān)閉,則關(guān)閉應(yīng)用程序上下文 | ParentContextAvailableEvent |
FileEncodingApplicationListener | 當(dāng)系統(tǒng)屬性file.encoding與spring的強(qiáng)制編碼屬性spring.mandatory-file-encoding不一致時(shí),打印信息,并拋出IllegalStateException異常 | ApplicationEnvironmentPreparedEvent |
AnsiOutputApplicationListener | 根據(jù)屬性spring.output.ansi.enabled來(lái)配置ANSI輸出 | ApplicationEnvironmentPreparedEvent |
ConfigFileApplicationListener | 搜索并加載配置文件,根據(jù)配置文件設(shè)置Environment和SpringApplication | ApplicationEnvironmentPreparedEvent & ApplicationPreparedEvent |
DelegatingApplicationListener | 類(lèi)似于DelegatingApplicationContextInitializer的作用,加載并轉(zhuǎn)發(fā)配置在context.listener.classes屬性的其它ApplicationListener | ApplicationEvent |
ClasspathLoggingApplicationListener | 在DEBUG日志級(jí)別下,對(duì)ApplicationEnvironmentPreparedEvent和ApplicationFailedEvent打印相應(yīng)的日志 | ApplicationEvent |
LoggingApplicationListener | 根據(jù)配置,在合適的時(shí)候初始化和配置系統(tǒng)日志 | ApplicationEvent |
3.ApplicationListener事件監(jiān)聽(tīng)機(jī)制的使用
事件的發(fā)布和監(jiān)聽(tīng)涉及到三個(gè)部分:
- 事件發(fā)布方:spring中的事件發(fā)布最終是由 SimpleApplicationEventMulticaster 類(lèi)中的multicastEvent進(jìn)行發(fā)布操作。一般使用時(shí)直接使用ApplicationContext發(fā)布即可。
- event事件:可以通過(guò)繼承 ApplicationEvent 自定義要接收的event類(lèi)型
- 事件接收方:自定義事件監(jiān)聽(tīng)器listener來(lái)監(jiān)聽(tīng)發(fā)布的事件從而執(zhí)行相應(yīng)的操作,以下兩種方式可以定義listener:
- 實(shí)現(xiàn)ApplicationListener接口并指定要監(jiān)聽(tīng)的事件類(lèi)型
@Component public class MyApplicationListener implements ApplicationListener<MyApplicationEvent> { Logger log = LoggerFactory.getLogger(MyApplicationListener.class); public void onApplicationEvent(MyApplicationEvent event) { log.info("監(jiān)聽(tīng)到event:{}",event); } }
- 使用 @EventListener設(shè)置監(jiān)聽(tīng)方法,比較簡(jiǎn)便,無(wú)需單獨(dú)創(chuàng)建監(jiān)聽(tīng)類(lèi)
@Component public class MyApplicationListener1 { Logger log = LoggerFactory.getLogger(MyApplicationListener1.class); @EventListener public void onApplicationEvent(MyApplicationEvent event) { log.info("監(jiān)聽(tīng)到event:{}",event); } }
4.從觀察者模式分析監(jiān)聽(tīng)器機(jī)制
- 觀察者模式:定義對(duì)象間的一種一對(duì)多依賴(lài)關(guān)系,使得每當(dāng)一個(gè)對(duì)象狀態(tài)發(fā)生改變時(shí),其相關(guān)依賴(lài)對(duì)象皆得到通知并被自動(dòng)更新 對(duì)象行為型模式
- 角色:
- abstractSubject: 抽象主題(抽象被觀察者)
保持觀察者的列表,有權(quán)增刪觀察者,發(fā)生變化時(shí)通知觀察者 - concreteSubject: 具體被觀察者 實(shí)現(xiàn)具體的改變,并在發(fā)生改變時(shí) 通知具體的觀察者
- abstractObserver: 抽象觀察者 定義update()接口,即收到主題通知后的操作
- concreteObserver: 具體觀察者 實(shí)現(xiàn)update()接口,保持與主題的改變相符合的狀態(tài)
- abstractSubject: 抽象主題(抽象被觀察者)
- 推模型和拉模型
- 推模型: push 由subject主題對(duì)象主動(dòng)向觀察者推送改變的數(shù)據(jù)(存在的問(wèn)題,主題對(duì)象不知道觀察者需要哪些數(shù)據(jù)時(shí),只能推送所有)
- 拉模型: pull 主題對(duì)象僅推送少量信息,通過(guò)傳遞subject引用給觀察者,觀察者自己選擇需要獲取的數(shù)據(jù)
- java中對(duì)觀察者模式的支持
- Observer接口:
update()方法,當(dāng)被觀察者對(duì)象的狀態(tài)發(fā)生變化時(shí),被觀察者對(duì)象的notifyObservers()方法就會(huì)調(diào)用這一方法 - Observable 類(lèi):被觀察者類(lèi)都是java.util.Observable類(lèi)的子類(lèi)
setChanged():被調(diào)用之后會(huì)設(shè)置一個(gè)內(nèi)部標(biāo)記變量,代表被觀察者對(duì)象的狀態(tài)發(fā)生了變化
notifyObservers():這個(gè)方法被調(diào)用時(shí),會(huì)調(diào)用所有登記過(guò)的觀察者對(duì)象的update()方法,使這些觀察者對(duì)象可以更新自己。
- Observer接口:
- 角色: