开发文章

spring中自定义Event事件的使用和浅析

在我目前接触的项目中,用到了许多spring相关的技术,框架层面的spring、spring mvc就不说了,细节上的功能也用了不少,如schedule定时任务、Filter过滤器、 interceptor拦截器等等,而这一篇我要说的是spring Event自定义事件,目前的项目中似乎没怎么用,但是这一项技术貌似还蛮重要,所以也不能不掌握。
对于事件驱动模型的解释和理解,我觉得有一篇博客里说的非常好,尤其是在解释这个关系的时候,举的交通信号灯的例子非常贴切,这里就引用做一个简单的解释:

事件驱动模型也就是我们常说的观察者,或者发布-订阅模型;理解它的几个关键点:
1. 首先是一种对象间的一对多的关系;最简单的如交通信号灯,信号灯是目标(一方),行人注视着信号灯(多方);
2. 当目标发送改变(发布),观察者(订阅者)就可以接收到改变;
3. 观察者如何处理(如行人如何走,是快走/慢走/不走,目标不会管的),目标无需干涉;所以就松散耦合了它们之间的关系。

引用的原文地址:http://xls9577087.iteye.com/blog/2121752(这篇文章中还讲解了有序监听和无序监听、异步事件等等,有兴趣的也可以去那里了解学习一下)
当我们对事件驱动有一个简单的理解之后,就能大概知道它应该什么时候用,然后再来研究它该怎么用,单一的文字或许不太容易解释,还是先把代码弄上来,然后再结合起来解释。

首先自定义一个事件,需要继承ApplicationEvent类,相当于安装了一个没有通电,没有灯光的信号灯,需要具有信号灯的基本特征。

复制内容到剪贴板
  1. package springTest5;  
  2. import org.springframework.context.ApplicationEvent;  
  3. public class EventTest extends ApplicationEvent {  
  4.     private static final long serialVersionUID = 1L;  
  5.     private String message;  
  6.     public EventTest(Object source, String message) {  
  7.         super(source);  
  8.         this.message = message;  
  9.     }  
  10.     public String getMessage() {  
  11.         return message;  
  12.     }  
  13.     public void setMessage(String message) {  
  14.         this.message = message;  
  15.     }  
  16. }  

然后再创建一个监听类,相当于行人(不管是否使用交通工具),需要实现ApplicationListener接口,并且重写onApplicationEvent方法,可以理解成这个行人需要看信号灯,并且能理解信号灯的意思才行。否则不看信号灯跟没有信号灯没有区别,看了不理解也没用。

复制内容到剪贴板
  1. package springTest5;  
  2. import org.springframework.context.ApplicationListener;  
  3. import org.springframework.stereotype.Component;  
  4. @Component  
  5. public class ListenerTest1 implements ApplicationListener<EventTest> {  
  6.     public void onApplicationEvent(EventTest event) {  
  7.         System.out.println("test1:" + event.getMessage());  
  8.     }  
  9. }  

这里的注解就只是简单的声明一个bean,应该不需要太多的解释。
那么第三步自然是需要一个控制信号灯变化的东西,相当于是给他接好电线,给他一个正常变换红黄绿的程序和电路。

复制内容到剪贴板
  1. package springTest5;  
  2. import org.springframework.beans.factory.annotation.Autowired;  
  3. import org.springframework.context.ApplicationContext;  
  4. import org.springframework.stereotype.Component;  
  5. @Component  
  6. public class EventPbulish {  
  7.     @Autowired  
  8.     ApplicationContext context;  
  9.     public void publish(String message) {  
  10.         context.publishEvent(new EventTest(this, message));  
  11.     }  
  12. }  

到这里,实际上已经写完了,但是呢很明显,我们合理没有配置文件,那么这里的注解也是不能被spring使用的,纯粹是个摆设,所以还需要一个配置文件,或者说相当于配置文件的配置类,要让相关的类生效。

复制内容到剪贴板
  1. package springTest5;  
  2. import org.springframework.context.annotation.ComponentScan;  
  3. import org.springframework.context.annotation.Configuration;  
  4. @Configuration  
  5. @ComponentScan("springTest5")  
  6. public class ConfigTest {  
  7.   
  8. }  

对于这里两个注解的意思,前几天的文章曾多次解释,因此这里便不说了,真有不懂得,可以翻一下前几天的博客。
走到这里,相当于我们创建好了一个可以正常运行的信号灯,创建好了一个正常的行人,但是呢都是静止不动的,我们需要让他动起来,也就是main方法的测试,相当于让行人开始看灯,让电路开始通电。

复制内容到剪贴板
  1. package springTest5;  
  2. import org.springframework.context.annotation.AnnotationConfigApplicationContext;  
  3. public class MainTest {  
  4.     public static void main(String[] args) {  
  5.         AnnotationConfigApplicationContext context = new AnnotationConfigApplicationContext(ConfigTest.class);  
  6.         EventPbulish eventPbulish = context.getBean(EventPbulish.class);  
  7.         eventPbulish.publish("zhangsan");  
  8.         context.close();  
  9.     }  
  10. }  

运行main方法后结果如下:

运行main方法后.png

根据上边的代码可以知道代表这个事件正常运行了,也就是信号灯正常发出了光,行人正常接收到了消息。
那么还有一个细节在于,信号灯对行人,是一对多的关系,那么这里的事件是否确实如此呢?为了验证,我便再写一个监听,再new一个行人,其他一切不变。

复制内容到剪贴板
  1. package springTest5;  
  2. import org.springframework.context.ApplicationListener;  
  3. @Component  
  4. public class ListenerTest2 implements ApplicationListener<EventTest> {  
  5.     public void onApplicationEvent(EventTest event) {  
  6.         System.out.println("tst2:" + event.getMessage());  
  7.     }  
  8. }  

再次运行main方法,结果如下:‘

运行main方法.png

很明显,两个行人都正常接收到了信号灯的信号。
那么,根据上边一开始的解释,再加上之后的例子,我们应该大概知道了这里的一个完整的事件包含些什么内容:即要有目标,也就是一个事件;还要有接受目标信息的对象,也就是一种监听;还要有改变或者说发出信息的一个控制体。
到这里基本上就算是完工了,这算是最简单的实现方式,像一些细节上的,把配置类改配置文件等等,都可以自己适当的变型。
在结尾处,结合@PropertySource注解,我把上边的列子做了个小小的变型,模拟一个找人的广播,喊一个人的名字,然后听到的人进行相应的回答。
这个例子和上边的不同在于,增加了一个properties配置,用来给接收对象初始化名称,顺便练习@PropertySource注解。

name1=zhangsan name2=lisi

然后修改了一下监听类,从properties文件中获取自己的名字。

复制内容到剪贴板
  1. package springTest5;  
  2. import org.springframework.beans.factory.annotation.Value;  
  3. import org.springframework.context.ApplicationListener;  
  4. import org.springframework.context.annotation.Bean;  
  5. import org.springframework.context.annotation.PropertySource;  
  6. import org.springframework.context.support.PropertySourcesPlaceholderConfigurer;  
  7. import org.springframework.stereotype.Component;  
  8. @Component  
  9. @PropertySource("test.properties")  
  10. public class ListenerTest1 implements ApplicationListener<EventTest> {  
  11.     @Value("${name1}")  
  12.     String name;  
  13.   
  14.     public void onApplicationEvent(EventTest event) {  
  15.         if (event.getMessage().equals(name)) {  
  16.             System.out.println("you need to find " + event.getMessage() + ",yes, I'am " + name);  
  17.         } else {  
  18.             System.out  
  19.                 .println("you need to find " + event.getMessage() + ",but I'am not " + event.getMessage() + ",I'am " + name);  
  20.         }  
  21.     }  
  22.   
  23.     @Bean  
  24.     public static PropertySourcesPlaceholderConfigurer propertyConfigure() {  
  25.         return new PropertySourcesPlaceholderConfigurer();  
  26.     }  
  27.   
  28. }  

其中propertyConfigure()是必须的,只有写了这个才能正产刚从properties中获取数据,但是经过测试,这一段代码只需要有一个地方出现了就可以,因此第二个监听类就不用再写:

复制内容到剪贴板
  1. package springTest5;  
  2. import org.springframework.beans.factory.annotation.Value;  
  3. import org.springframework.context.ApplicationListener;  
  4. import org.springframework.context.annotation.PropertySource;  
  5. import org.springframework.stereotype.Component;  
  6. @Component  
  7. @PropertySource("test.properties")  
  8. public class ListenerTest2 implements ApplicationListener<EventTest> {  
  9.     @Value("${name2}")  
  10.     String name;  
  11.     public void onApplicationEvent(EventTest event) {  
  12.         if (event.getMessage().equals(name)) {  
  13.             System.out.println("you need to find " + event.getMessage() + ",yes, I'am" + name);  
  14.         } else {  
  15.             System.out  
  16.                 .println("you need to find " + event.getMessage() + ",but I'am not " + event.getMessage() + ",I'am " + name);  
  17.         }  
  18.     }  
  19. }  

在运行之前的main方法后,结果如下:

main方法后.png

这个例子已经打包上传,有兴趣的可以看看,其中只有springTest5这个包里是这个例子,其他几个包里的内容则是对前几天的博文中对profile等技术点的练习,有兴趣的也可以看看。
http://download.csdn.net/detail/tuzongxun/9711034

感谢 生_若蜉蝣 支持 磐实编程网 原文地址:
blog.csdn.net/tuzongxun/article/details/53637159

文章信息

发布时间:2016-12-19

作者:生_若蜉蝣

发布者:aquwcw

浏览次数: