spring---ApplicationListener,ApplicationEvent
Spring中ApplicationContext的事件机制(自定义事件)
如果仅仅使用Spring的内定事件,那显然是远远不够的,幸好,Spring为我们提供了中自定义发布事件的能力。下面通过例程来展示如何发布并监听自定义的事件。
在工程中,我们定义一个Animal类,为受管Bean,它具有一个Speak方法,我们要做的就是监视该方法,当用户调用该方法时触发AnimalSpeakEvent事件。具体操作如下:
新建名字为IoC_Test3.9的java工程,添加Spring开发能力后,建立ioc.test包。新建一个事件类AnimalSpeakEvent,它继承自ApplicationEvent,重载其默认的构造方法。再添加一个String成员animalName和它的Geter方法。添加一个构造方法,此方法有两个参数,一个为source,一个为animalName。代码如下:
1 package ioc.test;
2
3 import org.springframework.context.ApplicationEvent;
4
5 public class AnimalSpeakEvent extends ApplicationEvent {
6
7 private static final long serialVersionUID = 1L;
8
9 private String animalName;
10
11 public AnimalSpeakEvent(Object source) {
12 super(source);
13 }
14
15 public AnimalSpeakEvent(Object source,String animalName) {
16 super(source);
17 this.animalName = animalName;
18 }
19
20 public String getAnimalName() {
21 return animalName;
22 }
23
24 }
25
创建好该事件类后,就应该把它再合适的时候发布出去。既然它是一个“动物讲话事件”,那么就应该在动物“讲话”的时候发布,如何发布呢?我们知道要发布一个事件,就必须要调用ApplicationContext的publishEvent方法。要在Animal类中获得ApplicationContext的实例,就要实现ApplicationContextAware接口,代码如下:
1 package ioc.test;
2
3 //import省略
4
5 public class Animal implements ApplicationContextAware {
6
7 private ApplicationContext ac;
8
9 private String name;
10
11 private int age;
12
13 public String speak(){
14
15 ac.publishEvent(new AnimalSpeakEvent(this,this.name));
16 return " 我的名字是;"+this.name+",我的年龄是:"+this.age;
17 }
18
19
20 public void setApplicationContext(ApplicationContext arg0) throws BeansException {
21 this.ac = arg0;
22 }
23
24 //Getet和Seter省略
25
26 }
27
到目前为之,我们已经在Animal类中把事件发布出去了,现在要监听该事件的发生了,至于监听方法,前面已经演示过,直接上代码:
1 ackage ioc.test;
2
3 import org.springframework.context.ApplicationEvent;
4 import org.springframework.context.ApplicationListener;
5
6 public class AnimalEventListener implements ApplicationListener {
7
8 public void onApplicationEvent(ApplicationEvent event) {
9 if (event instanceof AnimalSpeakEvent) {
10 AnimalSpeakEvent a = (AnimalSpeakEvent) event;
11 System.out.println("事件监听器" + this.getClass().getSimpleName()+":有一个动物在讲话!它的名字是:"+ a.getAnimalName());
12 }
13 }
14 }
15
配置好Bean,为AnimalBean注入值,配置文件如下:
1 <?xml version="1.0" encoding="UTF-8"?>
2 <beans …………>
3
4 <bean id="Listener" class="ioc.test.AnimalEventListener" />
5
6 <bean id="Animal" class="ioc.test.Animal">
7 <property name="name" value="老虎" />
8 <property name="age" value="5" />
9 </bean>
10
11 </beans>
12
现在应该来测试一下了,看看我们的自定义的事件是不是会在动物“讲话”的时候发生,测试类TestMain代码如下:
1 package ioc.test;
2
3 import org.springframework.context.support.AbstractApplicationContext;
4 import org.springframework.context.support.ClassPathXmlApplicationContext;
5
6 public class TestMain {
7
8 public static void main(String[] args) {
9
10 AbstractApplicationContext ac = new ClassPathXmlApplicationContext(
11 "applicationContext.xml");
12
13 //从容器获取动物实例
14 Animal animal = (Animal)ac.getBean("Animal");
15
16 //让动物讲话
17 System.out.println(animal.speak());
18 }
19 }
20
运行该类中的主方法,输出结果如下:
可以看到,再动物“讲话“之前,我们的事件监听器监听到“动物讲话”,并输出了讲话动物的名字。
ApplicationContextAware
Spring中提供一些Aware相关接口,像是BeanFactoryAware、 ApplicationContextAware、ResourceLoaderAware、ServletContextAware等等,实现这些Aware接口的Bean在被初始之后,可以取得一些相对应的资源,例如实现BeanFactoryAware的Bean在初始后,Spring容器将会注入BeanFactory的实例,而实现ApplicationContextAware的Bean,在Bean被初始后,将会被注入 ApplicationContext的实例等等。
Bean取得BeanFactory、ApplicationContextAware的实例目的是什么,一般的目的就是要取得一些档案资源的存取、相关讯息资源或是那些被注入的实例所提供的机制,例如ApplicationContextAware提供了publishEvent()方法,可以支持基于Observer观察者模式的事件传播机制。
ApplicationContextAware接口的定义如下:
ApplicationContextAware.java
public interface ApplicationContextAware {
void setApplicationContext(ApplicationContext context);
}
ApplicationContextAware注入ApplicationContext来实现事件传播,当ApplicationContext执行publishEvent()后(通知观察者),会自动寻找实现ApplicationListener接口的对象(观察者)并通知其发生对应事件。