关于JAVA中事件分发和监听机制实现的代码实例-绝对原创实用

转载：http://blog.youkuaiyun.com/5iasp/article/details/37054171

谢谢博主

=======================================================================================================

文章标题：关于Java中事件分发和监听机制实现的代码实例

文章地址: http://blog.youkuaiyun.com/5iasp/article/details/37054171

作者： javaboy2012
Email：yanek@163.com
qq:    1046011462

 

 

一、场景假设

假设有博客系统中需要实现如下功能：

系统中用户发布文章，修改文章，删除文章时，需要一些相关的操作需要执行。

发布文章后，给好友发送邮件通知，给用户加积分，对文章做全文索引。
修改文章后，给好友发送邮件修改通知，给用户加积分，对文章重新做全文索引。
删除文章后，给好友发送邮件修改通知，给用户减少积分，对文章重新做全文索引。

 

二、相关的概念解析

   分析如上场景，可以采用事件分发和监听机制来实现。

 
  事件分发和监听有如下几个概念：

 事件源：触发事件的对象 如上场景中我们把实体对象作为事件源，发布的文章就是事件源

 事件： 对事件源的操作产生事件，例如 发表文章 修改文章，删除文章这些操作就会触发相关的 文章被发表事件，文章被删除事件，文章被修改事件

 事件监听器：对事件源各种事件触发执行行为的抽象，包括接口和若干实现类。

    比如： 接口需要定义事件源相关事件触发时需要实现的操作接口。

 事件分发器：事件分发器主要处理事件的分发和事件监听器的管理，注册和删除事件监听器等。   

 

三、 代码示例

 

项目结构：

 

根据上述概念相关代码如下：

  包括如下代码

  1. 博客文章类  属于事件源

[java]  view plain  copy

 

1. package com.yanek.event;  
2. /** 
3.  * 博客文章 
4.  * @author Administrator 
5.  * 
6.  */  
7. public class Entry {  
8.       
9.       
10.     public long getId() {  
11.         return id;  
12.     }  
13.     public void setId(long id) {  
14.         this.id = id;  
15.     }  
16.     public String getName() {  
17.         return name;  
18.     }  
19.     public void setName(String name) {  
20.         this.name = name;  
21.     }  
22.     private long id; // 编号  
23.     private String name; //标题  
24.       
25. }  

 

2. 博客文章事件类 属于事件对象

其中定义了事件的类型和事件源，事件参数

[java]  view plain  copy

 

1. package com.yanek.event;  
2.   
3. import java.util.Collections;  
4. import java.util.Date;  
5. import java.util.Map;  
6. /** 
7.  * 博客文章事件 
8.  * @author Administrator 
9.  * 
10.  */  
11. public class EntryEvent  
12.   
13. {  
14.   
15.     public static final int ENTRY_ADDED = 100; //事件类型:博客文章被创建  
16.     public static final int ENTRY_DELETED = 101;//事件类型:博客文章被删除  
17.     public static final int ENTRY_MODIFIED = 102;//事件类型:博客文章被修改  
18.   
19.     private int eventType; //事件类型  
20.     private Entry entry; //博客文章对象  
21.     private Date date; //事件触发日期  
22.     private Map params; //事件辅助参数  
23.   
24.     public EntryEvent(int eventType, Entry entry, Map params) {  
25.         this.eventType = eventType;  
26.         this.entry = entry;  
27.         this.params = params != null ? Collections.unmodifiableMap(params)  
28.                 : null;  
29.         date = new Date();  
30.     }  
31.   
32.     public int getEventType() {  
33.         return eventType;  
34.     }  
35.   
36.     public Entry getEntry() {  
37.         return entry;  
38.     }  
39.   
40.     public Map getParams() {  
41.         return params;  
42.     }  
43.   
44.     public Date getDate() {  
45.         return date;  
46.     }  
47. }  

 

3. 事件监听器接口和实现类：

定义各种事件发生时需要处理的接口方法

[java]  view plain  copy

 

1. package com.yanek.event;  
2. /** 
3.  * 博客文章监听器接口 
4.  * @author Administrator 
5.  * 
6.  */  
7. public interface EntryListener  
8. {  
9.     /** 
10.      * 博客文章被创建 
11.      * @param entryevent 
12.      */  
13.     public abstract void entryAdded(EntryEvent entryevent);   
14.       
15.     /** 
16.      * 博客文章被删除 
17.      * @param entryevent 
18.      */  
19.   
20.     public abstract void entryDeleted(EntryEvent entryevent);  
21.       
22.       
23.     /** 
24.      * 博客文章被修改 
25.      * @param entryevent 
26.      */  
27.     public abstract void entryModified(EntryEvent entryevent);  
28.   
29. }  

 

事件监听器接口的实现类：

   实现场景中的三类操作，监听器接口实现包括如下三个类实现

   
  IndexManager 索引管理器类 
  ScoreManager 积分管理器类
  EmailManager 邮件管理器类

  三个类都实现监听器接口EntryListener。具体代码如下：

[java]  view plain  copy

 

1.  package com.yanek.event;  
2.   
3.   
4.   
5. /** 
6.  * 邮件管理器 
7.  * @author Administrator 
8.  * 
9.  */  
10. public class EmailManager implements EntryListener{  
11.   
12.     @Override  
13.     public void entryAdded(EntryEvent entryevent) {  
14.   
15.         System.out.println("EmailManager 处理 博客文章被创建事件。");  
16.           
17.     }  
18.       
19.     @Override  
20.     public void entryDeleted(EntryEvent entryevent) {  
21.   
22.         System.out.println("EmailManager 处理 博客文章被删除事件。");  
23.     }  
24.     @Override  
25.     public void entryModified(EntryEvent entryevent) {  
26.       
27.         System.out.println("EmailManager 处理 博客文章被修改事件。");  
28.           
29.     }  
30.   
31.   
32. }  
33.   
34.   
35.   
36. package com.yanek.event;  
37. /** 
38.  * 索引管理器 
39.  * @author Administrator 
40.  * 
41.  */  
42. public class IndexManager implements EntryListener {  
43.   
44.     @Override  
45.     public void entryAdded(EntryEvent entryevent) {  
46.   
47.   
48.         System.out.println("IndexManager 处理 博客文章被创建事件。");  
49.           
50.     }  
51.   
52.     @Override  
53.     public void entryDeleted(EntryEvent entryevent) {  
54.         // TODO Auto-generated method stub  
55.         System.out.println("IndexManager 处理 博客文章被删除事件。");  
56.           
57.     }  
58.   
59.     @Override  
60.     public void entryModified(EntryEvent entryevent) {  
61.         // TODO Auto-generated method stub  
62.         System.out.println("IndexManager 处理 博客文章被修改事件。");  
63.     }  
64.   
65. }  
66.   
67.   
68.   
69. package com.yanek.event;  
70. /** 
71.  * 积分管理器 
72.  * @author Administrator 
73.  * 
74.  */  
75. public class ScoreManager implements EntryListener {  
76.   
77.     @Override  
78.     public void entryAdded(EntryEvent entryevent) {  
79.         System.out.println("ScoreManager 处理 博客文章被创建事件。");  
80.           
81.     }  
82.   
83.     @Override  
84.     public void entryDeleted(EntryEvent entryevent) {  
85.         // TODO Auto-generated method stub  
86.         System.out.println("ScoreManager 处理 博客文章被删除事件。");  
87.     }  
88.   
89.     @Override  
90.     public void entryModified(EntryEvent entryevent) {  
91.         // TODO Auto-generated method stub  
92.           
93.         System.out.println("ScoreManager 处理 博客文章被修改事件。");  
94.           
95.     }  
96.   
97. }  

4. 博客文章事件分发器类

 

[java]  view plain  copy

 

1. package com.yanek.event;  
2.   
3. import java.util.ArrayList;  
4. /** 
5.  * 博客文章事件分发器 
6.  * @author Administrator 
7.  * 
8.  */  
9. public class EntryEventDispatcher {  
10.   
11.     private static EntryEventDispatcher instance = new EntryEventDispatcher();  
12.     private ArrayList listeners=new ArrayList();  
13.   
14.     public static EntryEventDispatcher getInstance() {  
15.         return instance;  
16.     }  
17.   
18.     private EntryEventDispatcher() {  
19.           
20.         String[] observers = PropertyMgr.getProperty("observers").split(",");  
21.         for(String s : observers) {  
22.               
23.             System.out.println(s);  
24.             try {  
25.                 this.addListener((EntryListener)(Class.forName(s).newInstance()));  
26.             } catch (InstantiationException e) {  
27.                 e.printStackTrace();  
28.             } catch (IllegalAccessException e) {  
29.                 e.printStackTrace();  
30.             } catch (ClassNotFoundException e) {  
31.                 e.printStackTrace();  
32.             }  
33.         }  
34.           
35.   
36.     }  
37.   
38.     public synchronized void addListener(EntryListener listener) {  
39.         System.out.println(":"+listener);  
40.         if (listener == null) {  
41.             System.out.println(":"+listener);  
42.             throw new NullPointerException();  
43.         } else {  
44.             listeners.add(listener);  
45.             return;  
46.         }  
47.     }  
48.   
49.     public synchronized void removeListener(EntryListener listener) {  
50.         listeners.remove(listener);  
51.     }  
52.   
53.     public void dispatchEvent(EntryEvent event) {  
54.         // System.out.println("msgDispatchEvent");  
55.         int eventType = event.getEventType();  
56.         long t1=System.currentTimeMillis();  
57.         System.out.println("kaishi="+t1);  
58.         for (int i = 0; i < listeners.size(); i++) {  
59.             try {  
60.                 EntryListener listener = (EntryListener) listeners.get(i);  
61.                 String name = listener.getClass().getName();  
62.                 name = name.substring(name.lastIndexOf('.') + 1);  
63.   
64.                 switch (eventType) {  
65.                 case EntryEvent.ENTRY_ADDED: // 创建博客文章  
66.                     listener.entryAdded(event);  
67.                     break;  
68.   
69.                 case EntryEvent.ENTRY_DELETED: // 删除博客文章  
70.                     listener.entryDeleted(event);   
71.                     break;  
72.   
73.                 case EntryEvent.ENTRY_MODIFIED: //修改 博客文章  
74.                     listener.entryModified(event);  
75.                     break;  
76.   
77.                 }  
78.   
79.             } catch (Exception e) {  
80.                 // logger.error(e);  
81.             }  
82.   
83.         }  
84.           
85.         System.out.println("cost time="+(System.currentTimeMillis()-t1));  
86.   
87.         // Profiler.end("msgDispatchEvent");  
88.     }  
89. }  

5. 博客文章管理器类

 

 

[java]  view plain  copy

 

1. package com.yanek.event;  
2.   
3. /** 
4.  * 博客文章管理器 
5.  * @author Administrator 
6.  * 
7.  */  
8.   
9. public class EntryManager {  
10.   
11.  /** 
12.   * @param args 
13.   */  
14.  public static void main(String[] args) {  
15.   
16.   
17.   EntryManager eventManager=new EntryManager();  
18.   Entry entry=new Entry();  
19.   entry.setId(1);  
20.   entry.setName("test");  
21.     
22.   eventManager.addEntry(entry);  //创建  
23.     
24.   eventManager.modifyEntry(entry); //修改  
25.     
26.   eventManager.deleteEntry(entry); //删除  
27.  }  
28.    
29.  public void addEntry(Entry entry) {  
30.   System.out.println("add entry ...id="+entry.getId());  
31.     
32.   // 事件分发  
33.   EntryEvent event = new EntryEvent(EntryEvent.ENTRY_ADDED, entry, null);  
34.   EntryEventDispatcher.getInstance().dispatchEvent(event);  
35.     
36.  }  
37.    
38.  public void deleteEntry(Entry entry) {  
39.   System.out.println("delete entry ...id="+entry.getId());  
40.     
41.   // 事件分发  
42.   EntryEvent event = new EntryEvent(EntryEvent.ENTRY_DELETED, entry, null);  
43.   EntryEventDispatcher.getInstance().dispatchEvent(event);  
44.     
45.  }  
46.    
47.  public void modifyEntry(Entry entry) {  
48.   System.out.println("modify entry ...id="+entry.getId());  
49.   // 事件分发  
50.   EntryEvent event = new EntryEvent(EntryEvent.ENTRY_MODIFIED, entry, null);  
51.   EntryEventDispatcher.getInstance().dispatchEvent(event);  
52.     
53.  }  
54.   
55. }  

6. 辅助工具类：

[java]  view plain  copy

 

1.   package com.yanek.event;  
2.   
3. import java.io.IOException;  
4. import java.util.Properties;  
5.   
6. public class PropertyMgr {  
7.  private static Properties props = new Properties();  
8.    
9.  static {  
10.   try {  
11.    props.load(PropertyMgr.class.getClassLoader().getResourceAsStream("com/yanek/event/config.properties"));  
12.   } catch (IOException e) {  
13.    e.printStackTrace();  
14.   }  
15.  }  
16.    
17.  public static String getProperty(String key) {  
18.   return props.getProperty(key);  
19.  }  
20. }  

 7.相关配置文件：

 

配置分发器处理时需要的监听器实现类的列表。

config.properties

内容如下：

observers=com.yanek.event.IndexManager,com.yanek.event.ScoreManager,com.yanek.event.EmailManager

 

 

 四 测试运行结果：

 

执行： EntryManager 即可看到效果：

 

add entry ...id=1
com.yanek.event.IndexManager
:com.yanek.event.IndexManager@3d3c53
com.yanek.event.ScoreManager
:com.yanek.event.ScoreManager@3d3f58
com.yanek.event.EmailManager
:com.yanek.event.EmailManager@3d425b
kaishi=1404547648004
IndexManager 处理 博客文章被创建事件。
ScoreManager 处理 博客文章被创建事件。
EmailManager 处理 博客文章被创建事件。
cost time=1
modify entry ...id=1
kaishi=1404547648006
IndexManager 处理 博客文章被修改事件。
ScoreManager 处理 博客文章被修改事件。
EmailManager 处理 博客文章被修改事件。
cost time=1
delete entry ...id=1
kaishi=1404547648007
IndexManager 处理 博客文章被删除事件。
ScoreManager 处理 博客文章被删除事件。
EmailManager 处理 博客文章被删除事件。
cost time=0

 

五。关于该方案系统如何实现灵活扩展

假设有如下需求增加了，比如 发表文章，修改文章，删除文章后需要需要给好友发短信通知或其他相关功能，则只需要再写一个监听器的实现类，加入到配置文件中即可。

具体就不写代码了，大家可以自己加上测试。

 

 
六、关于资源下载：

地址： http://download.youkuaiyun.com/detail/5iasp/7596885

 

 本篇博文参加了优快云博文大赛，如果您觉得这篇博文不错，希望您能帮我投一票，谢谢！

投票地址：http://vote.blog.youkuaiyun.com/Article/Details?articleid=37054171

学习是一种信仰，分享是一种美德