Java WebSocket的Tomcat實現

一、概述:       

       我們知道,傳統的HTTP協議是無狀態的,每次請求(request)都要由客戶端(如瀏覽器)主動發起,服務端進行處理後返回response結果,而服務端很難主動向客戶端發送數據;這種客戶端是主動方,服務端是被動方的傳統Web模式對於信息變化不頻繁的Web應用來說造成的麻煩較小,而對於涉及實時信息的Web應用卻帶來了很大的不便,如帶有即時通信、實時數據、訂閱推送等功能的應用。在WebSocket規範提出之前,開發人員若要實現這些實時性較強的功能,經常會使用折衷的解決方法:輪詢(polling)Comet技術。其實後者本質上也是一種輪詢,只不過有所改進。

        輪詢是最原始的實現實時Web應用的解決方案。輪詢技術要求客戶端以設定的時間間隔週期性地向服務端發送請求,頻繁地查詢是否有新的數據改動。明顯地,這種方法會導致過多不必要的請求,浪費流量和服務器資源。

        Comet技術又可以分爲長輪詢流技術長輪詢改進了上述的輪詢技術,減小了無用的請求。它會爲某些數據設定過期時間,當數據過期後纔會向服務端發送請求;這種機制適合數據的改動不是特別頻繁的情況。流技術通常是指客戶端使用一個隱藏的窗口與服務端建立一個HTTP長連接,服務端會不斷更新連接狀態以保持HTTP長連接存活;這樣的話,服務端就可以通過這條長連接主動將數據發送給客戶端;流技術在大併發環境下,可能會考驗到服務端的性能。

       這兩種技術都是基於請求-應答模式,都不算是真正意義上的實時技術;它們的每一次請求、應答,都浪費了一定流量在相同的頭部信息上,並且開發複雜度也較大。伴隨着HTML5推出的WebSocket,真正實現了Web的實時通信,使B/S模式具備了C/S模式的實時通信能力。WebSocket的工作流程是這樣的:瀏覽器通過JavaScript向服務端發出建立WebSocket連接的請求,在WebSocket連接建立成功後,客戶端和服務端就可以通過TCP連接傳輸數據。因爲WebSocket連接本質上是TCP連接,不需要每次傳輸都帶上重複的頭部數據,所以它的數據傳輸量比輪詢和Comet技術小了很多。本文不詳細地介紹WebSocket規範,主要介紹下WebSocket在Java Web中的實現。


        JavaEE 7中出了JSR-356:Java API for WebSocket規範。不少Web容器,如Tomcat,Nginx,Jetty等都支持WebSocket。Tomcat從7.0.27開始支持WebSocket,從7.0.47開始支持JSR-356,下面的Demo代碼也是需要部署在Tomcat7.0.47上才能運行。

二、Java Websocket Demo示例:

         新建一個dynamic web項目:


客戶端(Web主頁)代碼:

[html] view plain copy
 在CODE上查看代碼片派生到我的代碼片
  1. <%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%>  
  2.   
  3. <%  
  4.   
  5. String path = request.getContextPath();  
  6.   
  7. String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";  
  8.   
  9. %>  
  10.   
  11.    
  12.   
  13. <!DOCTYPE HTML>  
  14.   
  15. <html>  
  16.   
  17.   <head>  
  18.   
  19.     <base href="<%=basePath%>">  
  20.   
  21.     <title>My WebSocket</title>  
  22.   
  23.   </head>  
  24.   
  25.      
  26.   
  27.   <body>  
  28.   
  29.     Welcome<br/>  
  30.   
  31.     <input id="text" type="text" /><button onclick="send()">Send</button>    <button onclick="closeWebSocket()">Close</button>  
  32.   
  33.     <div id="message">  
  34.   
  35.     </div>  
  36.   
  37.   </body>  
  38.   
  39.      
  40.   
  41.   <script type="text/javascript">  
  42.   
  43.       var websocket = null;  
  44.   
  45.          
  46.   
  47.       //判斷當前瀏覽器是否支持WebSocket  
  48.   
  49.       if('WebSocket' in window){  
  50.   
  51.           websocket = new WebSocket("ws://localhost:8080/MyWebSocket/websocket");  
  52.   
  53.       }  
  54.   
  55.       else{  
  56.   
  57.           alert('Not support websocket')  
  58.   
  59.       }  
  60.   
  61.          
  62.   
  63.       //連接發生錯誤的回調方法  
  64.   
  65.       websocket.onerror = function(){  
  66.   
  67.           setMessageInnerHTML("error");  
  68.   
  69.       };  
  70.   
  71.          
  72.   
  73.       //連接成功建立的回調方法  
  74.   
  75.       websocket.onopen = function(event){  
  76.   
  77.           setMessageInnerHTML("open");  
  78.   
  79.       }  
  80.   
  81.          
  82.   
  83.       //接收到消息的回調方法  
  84.   
  85.       websocket.onmessage = function(event){  
  86.   
  87.           setMessageInnerHTML(event.data);  
  88.   
  89.       }  
  90.   
  91.          
  92.   
  93.       //連接關閉的回調方法  
  94.   
  95.       websocket.onclose = function(){  
  96.   
  97.           setMessageInnerHTML("close");  
  98.   
  99.       }  
  100.   
  101.          
  102.   
  103.       //監聽窗口關閉事件,當窗口關閉時,主動去關閉websocket連接,防止連接還沒斷開就關閉窗口,server端會拋異常。  
  104.   
  105.       window.onbeforeunload = function(){  
  106.   
  107.           websocket.close();  
  108.   
  109.       }  
  110.   
  111.          
  112.   
  113.       //將消息顯示在網頁上  
  114.   
  115.       function setMessageInnerHTML(innerHTML){  
  116.   
  117.           document.getElementById('message').innerHTML += innerHTML + '<br/>';  
  118.   
  119.       }  
  120.   
  121.          
  122.   
  123.       //關閉連接  
  124.   
  125.       function closeWebSocket(){  
  126.   
  127.           websocket.close();  
  128.   
  129.       }  
  130.   
  131.          
  132.   
  133.       //發送消息  
  134.   
  135.       function send(){  
  136.   
  137.           var message = document.getElementById('text').value;  
  138.   
  139.           websocket.send(message);  
  140.   
  141.       }  
  142.   
  143.   </script>  
  144.   
  145. </html>  

 

Java Web後端代碼:

[html] view plain copy
 在CODE上查看代碼片派生到我的代碼片
  1. package com.chen.websocket;  
  2.   
  3. import java.io.IOException;  
  4.   
  5. import java.util.concurrent.CopyOnWriteArraySet;  
  6.   
  7.    
  8.   
  9. import javax.websocket.OnClose;  
  10.   
  11. import javax.websocket.OnError;  
  12.   
  13. import javax.websocket.OnMessage;  
  14.   
  15. import javax.websocket.OnOpen;  
  16.   
  17. import javax.websocket.Session;  
  18.   
  19. import javax.websocket.server.ServerEndpoint;  
  20.   
  21.    
  22.   
  23. //該註解用來指定一個URI,客戶端可以通過這個URI來連接到WebSocket。類似Servlet的註解mapping。無需在web.xml中配置。  
  24.   
  25. @ServerEndpoint("/websocket")  
  26.   
  27. public class MyWebSocket {  
  28.   
  29.     //靜態變量,用來記錄當前在線連接數。應該把它設計成線程安全的。  
  30.   
  31.     private static int onlineCount = 0;  
  32.   
  33.        
  34.   
  35.     //concurrent包的線程安全Set,用來存放每個客戶端對應的MyWebSocket對象。若要實現服務端與單一客戶端通信的話,可以使用Map來存放,其中Key可以爲用戶標識  
  36.   
  37.     private static CopyOnWriteArraySet<MyWebSocket> webSocketSet = new CopyOnWriteArraySet<MyWebSocket>();  
  38.   
  39.        
  40.   
  41.     //與某個客戶端的連接會話,需要通過它來給客戶端發送數據  
  42.   
  43.     private Session session;  
  44.   
  45.        
  46.   
  47.     /**  
  48.   
  49.      * 連接建立成功調用的方法  
  50.   
  51.      * @param session  可選的參數。session爲與某個客戶端的連接會話,需要通過它來給客戶端發送數據  
  52.   
  53.      */  
  54.   
  55.     @OnOpen  
  56.   
  57.     public void onOpen(Session session){  
  58.   
  59.         this.session = session;  
  60.   
  61.         webSocketSet.add(this);    //加入set中  
  62.   
  63.         addOnlineCount();          //在線數加1  
  64.   
  65.         System.out.println("有新連接加入!當前在線人數爲" + getOnlineCount());  
  66.   
  67.     }  
  68.   
  69.        
  70.   
  71.     /**  
  72.   
  73.      * 連接關閉調用的方法  
  74.   
  75.      */  
  76.   
  77.     @OnClose  
  78.   
  79.     public void onClose(){  
  80.   
  81.         webSocketSet.remove(this); //從set中刪除  
  82.   
  83.         subOnlineCount();          //在線數減1      
  84.   
  85.         System.out.println("有一連接關閉!當前在線人數爲" + getOnlineCount());  
  86.   
  87.     }  
  88.   
  89.        
  90.   
  91.     /**  
  92.   
  93.      * 收到客戶端消息後調用的方法  
  94.   
  95.      * @param message 客戶端發送過來的消息  
  96.   
  97.      * @param session 可選的參數  
  98.   
  99.      */  
  100.   
  101.     @OnMessage  
  102.   
  103.     public void onMessage(String message, Session session) {  
  104.   
  105.         System.out.println("來自客戶端的消息:" + message);  
  106.   
  107.            
  108.   
  109.         //羣發消息  
  110.   
  111.         for(MyWebSocket item: webSocketSet){               
  112.   
  113.             try {  
  114.   
  115.                 item.sendMessage(message);  
  116.   
  117.             } catch (IOException e) {  
  118.   
  119.                 e.printStackTrace();  
  120.   
  121.                 continue;  
  122.   
  123.             }  
  124.   
  125.         }  
  126.   
  127.     }  
  128.   
  129.        
  130.   
  131.     /**  
  132.   
  133.      * 發生錯誤時調用  
  134.   
  135.      * @param session  
  136.   
  137.      * @param error  
  138.   
  139.      */  
  140.   
  141.     @OnError  
  142.   
  143.     public void onError(Session session, Throwable error){  
  144.   
  145.         System.out.println("發生錯誤");  
  146.   
  147.         error.printStackTrace();  
  148.   
  149.     }  
  150.   
  151.        
  152.   
  153.     /**  
  154.   
  155.      * 這個方法與上面幾個方法不一樣。沒有用註解,是根據自己需要添加的方法。  
  156.   
  157.      * @param message  
  158.   
  159.      * @throws IOException  
  160.   
  161.      */  
  162.   
  163.     public void sendMessage(String message) throws IOException{  
  164.   
  165.         this.session.getBasicRemote().sendText(message);  
  166.   
  167.         //this.session.getAsyncRemote().sendText(message);  
  168.   
  169.     }  
  170.   
  171.    
  172.   
  173.     public static synchronized int getOnlineCount() {  
  174.   
  175.         return onlineCount;  
  176.   
  177.     }  
  178.   
  179.    
  180.   
  181.     public static synchronized void addOnlineCount() {  
  182.   
  183.         MyWebSocket.onlineCount++;  
  184.   
  185.     }  
  186.   
  187.        
  188.   
  189.     public static synchronized void subOnlineCount() {  
  190.   
  191.         MyWebSocket.onlineCount--;  
  192.   
  193.     }  
  194.   
  195. }  
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章