Spring中通過(guò)事件與對(duì)應(yīng)的監(jiān)聽(tīng)器可以完成很多操作还最,比如關(guān)于context容器的的事件有如下4個(gè):
ContextStartedEvent
明確調(diào)用ConfigurableApplicationContext.start()才會(huì)觸發(fā). 在spring boot中可以使用如下方法觸發(fā)
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
SpringApplication.run(DemoApplication.class, args).start();
}
}
ContextRefreshedEvent:
當(dāng)ApplicationContext初始化結(jié)束或者刷新的時(shí)候觸發(fā). 這里的初始化結(jié)束是指所有的bean已經(jīng)加載完畢, post-processor bean被激活, 單例bean被初始化, 同時(shí)ApplicationContext對(duì)象可以被使用了.
也可以明確調(diào)用refresh()方法觸發(fā). 但是要注意, 并不是所有的ApplicationContext實(shí)例都支持hot refresh的, 比如GenericApplicationContext是不支持hot refresh的, 所以Spring boot中如果直接調(diào)用
SpringApplication.run(DemoApplication.class, args).refresh();
就會(huì)報(bào)
Exception in thread "main" java.lang.IllegalStateException: GenericApplicationContext does not support multiple refresh attempts: just call 'refresh' once
錯(cuò)誤, 因?yàn)镾pring boot中的ApplicationContext實(shí)例是AnnotationConfigEmbeddedWebApplicationContext, 是繼承于GenericApplicationContext的. 但是XmlWebApplicationContext就是支持hot refresh
ContextStoppedEvent
可以通過(guò)調(diào)用ConfigurableApplicationContext.stop()觸發(fā). 當(dāng)ApplicationContext調(diào)用了stop()之后, 可以重新調(diào)用start()啟動(dòng)context.
ContextClosedEvent
當(dāng)ApplicationContextclose時(shí)觸發(fā), 可以手動(dòng)調(diào)用close()方法或者直接退出應(yīng)用來(lái)觸發(fā).
除了這些已有的事件劣像,我們也可以通過(guò)繼承ApplicationEvent類(lèi)來(lái)自己定義事件儡率,再使用publishEvent方法來(lái)發(fā)布事件,這樣就可以使用@EventListener定義監(jiān)聽(tīng)器來(lái)進(jìn)行相關(guān)處理了挥唠。下面舉一個(gè)例子:
先定義一個(gè)Event事件:
public class MyEvent extends ApplicationEvent {
private String index;
//構(gòu)造器必須要有Object參數(shù)并調(diào)用父構(gòu)造器,這個(gè)source就是生成該event的那個(gè)對(duì)象
MyEvent(Object source,String s) {
super(source);
this.index = s;
}
public String getIndex() {
return index;
}
}
然后我們通過(guò)ApplicationContext發(fā)布這個(gè)事件并添加監(jiān)聽(tīng)器:
@Configuration
public class Config {
@Autowired
private ApplicationContext context;
//填加一個(gè)監(jiān)聽(tīng)器監(jiān)聽(tīng)我們的事件,監(jiān)聽(tīng)到就做相關(guān)操作
@EventListener
public void onApplicationEvent(MyEvent event){
System.out.println("Get My Event !!!!!!");
System.out.println(event.getIndex());
}
//在容器初始化的時(shí)候發(fā)布我們定義的事件
@EventListener({EmbeddedServletContainerInitializedEvent.class})
public void onApplicationEvent(EmbeddedServletContainerInitializedEvent event) {
//發(fā)布赂蕴,其實(shí)就是將該event放到一個(gè)Set<ApplicationEvent>里
this.context.publishEvent(new MyEvent(this,"hello jWang"));
}
}
這樣我們啟動(dòng)應(yīng)用,會(huì)發(fā)現(xiàn)控制臺(tái)打印了:
Get My Event !!!!!!
hello jWang
如果不使用@EventListener注解(Spring 4.2以后可以用),也可以單獨(dú)的定義一個(gè)監(jiān)聽(tīng)器類(lèi):
@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());
}
}
說(shuō)了事件機(jī)制的使用方法后,再說(shuō)說(shuō)它的原理.
可以看出事件機(jī)制就是一個(gè)Event被發(fā)布的時(shí)候,Listener會(huì)執(zhí)行相應(yīng)的操作,這很像一個(gè)觀察者的設(shè)計(jì)模式舶胀。
查看源碼可以發(fā)現(xiàn)Listener注冊(cè)后會(huì)被放入一個(gè)集合中:
public final Set<ApplicationListener<?>> applicationListeners = new LinkedHashSet();
然后我們看發(fā)布事件的時(shí)候發(fā)生了什么:
protected void publishEvent(Object event, ResolvableType eventType) {
... ...
if (this.earlyApplicationEvents != null) {
this.earlyApplicationEvents.add(applicationEvent);
} else {
//這一句進(jìn)去看看
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);
}
}
}
事件機(jī)制的邏輯核心在類(lèi)SimpleApplicationEventMulticaster中概说,那進(jìn)入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();
//對(duì)每個(gè)Listener進(jìn)行處理
while(var4.hasNext()) {
final ApplicationListener<?> listener = (ApplicationListener)var4.next();
Executor executor = this.getTaskExecutor();
if (executor != null) {
executor.execute(new Runnable() {
public void run() {
//invokeListener里面就是調(diào)用該Listener的onApplicationEvent方法
SimpleApplicationEventMulticaster.this.invokeListener(listener, event);
}
});
} else {
this.invokeListener(listener, event);
}
}
}
可以看出事件機(jī)制中的觀察者模式的實(shí)現(xiàn)方式是事件發(fā)生時(shí)主動(dòng)推送“通知”觀察者調(diào)用其處理邏輯(還有一種是觀察者自己去輪詢(xún)查有沒(méi)有新事件)。