用java实现comet，基于HTTP长连接的实现，用于从服务端实时发送信息到客户端

http://www.iteye.com/topic/293328

 

 参考文档 http://www.ibm.com/developerworks/cn/web/wa-lo-comet/

 

        comet是HTTP长连接，就是在HTTP发送请求时，服务器不立刻发送响应信息给客户端， 而是保持着连接，等待一定情况发生后才把数据发送回去给客户端。所以用comet可以实现服务器端的数据实时地发送给客户端。

        本文主要是用java和js来简单地实现comet，最后附上源码和使用例子。

        在客户端用XMLRequest发送请求到服务器，在服务器端用一个servlet来接收XMLRequest的请求，当接收到请求时，并不立刻响应客户端，而是把该servlet线程阻塞，等到一定事件发生后，再响应客户端。当客户端接收到服务端的响应后，调用自定义的回调函数来处理服务器发送回来的数据，处理完成后，再发送一个XMLRequest请求到服务端，这样循环下去，就可以实现数据的实时更新，又不必要在客户端不断地轮循（polling）。

         利用该comet的实现（以后简称为keeper）时，只要在客户端注册事件和写一个处理返回数据的回调函数，然后在服务端实现keeper中的EventListener接口，调用Controller.action(eventListener,eventType)就可以了。

        keeper分成两大部分，第一部分为客户端的javascript,第二部分是服务端的servlet和事件处理。

        一.客户端

        建立一个XMLRequest对象池，每发送一次请求，从对象池中取一个XMLRequest对象，如果没有可用的对象，则创建一个，把它加入到对象池中。这部分的代码来自于网络。

        为了使用方便，再添加一些方法，用来注册事件。这样只要调用注册函数来注册事件，并且把回调函数传给注册事件函数就行了，处理数据的事情，交给回调函数，并由用户来实现。

        keeper为了方便使用，把客户端的javascript代码集成在servlet中，当配置好keeper的servlet，启动HTTP服务器时，keeper会根据用户的配置，在相应的目录下生成客户端的javascript代码。

    二.服务端

        服务端的servlet初始化时，根据配置来生成相应的客户端javascript代码。

        servlet的入口由keeper.servlet.Keeper.java中的doGet进入。在Keeper的doGet中，从请求中获取用户注册事件的名称（字符串类型），然后根据事件的名称，构造一个事件（Event类型），再把它注册到NameRegister中，注册完成后，该servlet线程调用wait(),把自已停止。等待该servlet线程被唤醒后，从Event中调用事件的EventListener接口的process(request,response)来处理客户端的请求。

        

1.     protected void doGet(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
2.         String eventName = request.getParameter("event");
3.         NameRegister reg = NameRegister.getInstance();
4.         Event event = null;
5.         try {
6.             event = reg.getEvent(eventName);
7.             if(event == null) {
8.                 event = new Event(eventName,this);
9.                 reg.registeEvent(eventName, event);
10.             }
11.             if(event.getServlet() == null) {
12.                 event.setServlet(this);
13.             }
14.             
15.         } catch (RegistException e1) {
16.             e1.printStackTrace();
17.         }
18.         synchronized(this) {
19.             while(!event.isProcess()) {
20.                 try {
21.                     wait();
22.                 } catch (InterruptedException e) {
23.                     e.printStackTrace();
24.                 }
25.             }
26.         }
27.         EventListener listener = event.getListener();
28.         if(listener != null) {
29.            listener.process(request,response);
30.         }   
31.     }

        在服务端处理事件时，调用了keeper.control.Controller中的静态方法action(EventListener listener,String eventName)来处理。如下所示。

 

 

1.     public static boolean action(EventListener listener,String eventName){
2.         NameRegister reg = NameRegister.getInstance();
3.         HttpServlet servlet = null;
4.         Event e = null;
5.         try {
6.             e = reg.getEvent(eventName,true);
7.             if(e == null) {
8.                 return false;
9.             }
10.             e.setListener(listener);
11.             servlet = e.getServlet();
12.             e.setProcess(true);
13.             synchronized(servlet) {
14.                 servlet.notifyAll();
15.             }
16.         } catch (RegistException ex) {
17.             ex.printStackTrace();
18.             }
19.         if(servlet != null && e != null) {
20.             e = null;
21.             return true;
22.         } else {
23.             return false;
24.         }
25.     }

下面开始用keeper来写一个简单的网页聊天程序和基于服务端的时间。

 

 

 

    1.客户端设置

        注册两个事件，一个用于是时间事件，一个是消息事件。同时还要写两个回调函数，用于处理服务端返回的时间和聊天消息。如下所于：

 

 

1. <script type="text/javascript">
2.     Keeper.addListener('timer',showTime);//注册时间事件
3.     function showTime(obj){ //时间处理回调函数
4.         var sp = document.getElementById("dateTime");
5.         if(sp){
6.             sp.innerHTML = obj.responseText;
7.         }
8.     }
9.     function startOrStop(obj){
10.         var btn = document.getElementById("controlBtn")
11.         btn.value=obj.responseText;
12.     }
13.     Keeper.addListener('msg',showMsg,"GBK");//注册消息事件，最后一个参数是
14. //字符串编码
15.     function showMsg(obj){//处理消息的回调函数
16.         var msg = document.getElementById("msg");
17.         if(msg){
18.             
19.                 msg.value = obj.responseText+"\n"+msg.value;
20.             
21.         }
22.     }
23.     function sendMsg() {
24.         var msg = document.getElementById("sendMsg");
25.         if(msg){
26.             var d = "msg="+msg.value;
27.             sendReq('POST','./demo',d,startOrStop);
28.             msg.value = "";
29.         }
30.     }
31.     
32. </script>

    2.配置服务端

    服务端的配置在web.xml文件中，如下所示

1.   <servlet>
2.     <servlet-name>keeper</servlet-name>
3.     <servlet-class>keeper.servlet.Keeper</servlet-class>
4.     <init-param>
5. <!--可选项，设置生成客户端的JavaScript路径和名字，默认置为/keeper.js-->
6.       <param-name>ScriptName</param-name>
7.       <param-value>/keeperScript.js</param-value>
8.     </init-param>
9. <!--这个一定要设置，否则不能生成客户端代码-->
10.     <load-on-startup>1</load-on-startup>
11.   </servlet>
12.   <servlet-mapping>
13.     <servlet-name>keeper</servlet-name>
14.     <url-pattern>/keeper</url-pattern>
15.   </servlet-mapping>

 

        用<script type="text/javascript" src="./keeperScript.js"></script>在页面包含JavaScript时，这里的src一定要和上面配置的一至。上面的设置除了<init-param></init-param>为可选的设置外，其他的都是必要的，而且不能改变。

 

 

        3.编写事件处理代码，消息的处理代码如下：

 

 

    

1.     protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
2.         System.out.println("Post..");
3.         String msg = request.getParameter("msg");
4.         Controller.action(new SendMsg(msg),"msg");
5.     }

 

1. class SendMsg implements EventListener{
2.     private String msg;
3.     public SendMsg(String msg) {
4.         this.msg = msg;
5.     }
6.     @Override
7.     public void process(HttpServletRequest request, HttpServletResponse response) {
8.         response.setCharacterEncoding("UTF-8");
9.         PrintWriter out = null;
10.         try {
11.             out = response.getWriter();
12.             if(msg!=null){
13.                 out.write(msg);
14.             }
15.         } catch (IOException e) {   
16.             e.printStackTrace();
17.         }
18.         finally{
19.             if(out != null) {
20.                 out.close();
21.             }
22.         }       
23.     }
24. }

 

 

 

 到这时，一个基本的keeper应用就完成了。其它部分请参考附件中的例子源码。