隨着互聯網的發展,傳統的HTTP協議已經很難滿足Web應用日益復雜的需求了。近年來,隨着HTML5的誕生,WebSocket協議被提出,它實現了瀏覽器與服務器的全雙工通信,擴展了瀏覽器與服務端的通信功能,使服務端也能主動向客戶端發送數據。
我們知道,傳統的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上才能運行。
新建一個dynamic web項目:
客戶端(Web主頁)代碼:
1 <%@ page language="java" import="java.util.*" pageEncoding="UTF-8"%> 2 <% 3 String path = request.getContextPath(); 4 String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/"; 5 %> 6 7 <!DOCTYPE HTML> 8 <html> 9 <head> 10 <base href="<%=basePath%>"> 11 <title>My WebSocket</title> 12 </head> 13 14 <body> 15 Welcome<br/> 16 <input id="text" type="text" /><button onclick="send()">Send</button> <button onclick="closeWebSocket()">Close</button> 17 <div id="message"> 18 </div> 19 </body> 20 21 <script type="text/javascript"> 22 var websocket = null; 23 24 //判斷當前瀏覽器是否支持WebSocket 25 if('WebSocket' in window){ 26 websocket = new WebSocket("ws://localhost:8080/MyWebSocket/websocket"); 27 } 28 else{ 29 alert('Not support websocket') 30 } 31 32 //連接發生錯誤的回調方法 33 websocket.onerror = function(){ 34 setMessageInnerHTML("error"); 35 }; 36 37 //連接成功建立的回調方法 38 websocket.onopen = function(event){ 39 setMessageInnerHTML("open"); 40 } 41 42 //接收到消息的回調方法 43 websocket.onmessage = function(event){ 44 setMessageInnerHTML(event.data); 45 } 46 47 //連接關閉的回調方法 48 websocket.onclose = function(){ 49 setMessageInnerHTML("close"); 50 } 51 52 //監聽窗口關閉事件,當窗口關閉時,主動去關閉websocket連接,防止連接還沒斷開就關閉窗口,server端會拋異常。 53 window.onbeforeunload = function(){ 54 websocket.close(); 55 } 56 57 //將消息顯示在網頁上 58 function setMessageInnerHTML(innerHTML){ 59 document.getElementById('message').innerHTML += innerHTML + '<br/>'; 60 } 61 62 //關閉連接 63 function closeWebSocket(){ 64 websocket.close(); 65 } 66 67 //發送消息 68 function send(){ 69 var message = document.getElementById('text').value; 70 websocket.send(message); 71 } 72 </script> 73 </html>
Java Web后端代碼
1 package com.chen.websocket; 2 import java.io.IOException; 3 import java.util.concurrent.CopyOnWriteArraySet; 4 5 import javax.websocket.OnClose; 6 import javax.websocket.OnError; 7 import javax.websocket.OnMessage; 8 import javax.websocket.OnOpen; 9 import javax.websocket.Session; 10 import javax.websocket.server.ServerEndpoint; 11 12 //該注解用來指定一個URI,客戶端可以通過這個URI來連接到WebSocket。類似Servlet的注解mapping。無需在web.xml中配置。 13 @ServerEndpoint("/websocket") 14 public class MyWebSocket { 15 //靜態變量,用來記錄當前在線連接數。應該把它設計成線程安全的。 16 private static int onlineCount = 0; 17 18 //concurrent包的線程安全Set,用來存放每個客戶端對應的MyWebSocket對象。若要實現服務端與單一客戶端通信的話,可以使用Map來存放,其中Key可以為用戶標識 19 private static CopyOnWriteArraySet<MyWebSocket> webSocketSet = new CopyOnWriteArraySet<MyWebSocket>(); 20 21 //與某個客戶端的連接會話,需要通過它來給客戶端發送數據 22 private Session session; 23 24 /** 25 * 連接建立成功調用的方法 26 * @param session 可選的參數。session為與某個客戶端的連接會話,需要通過它來給客戶端發送數據 27 */ 28 @OnOpen 29 public void onOpen(Session session){ 30 this.session = session; 31 webSocketSet.add(this); //加入set中 32 addOnlineCount(); //在線數加1 33 System.out.println("有新連接加入!當前在線人數為" + getOnlineCount()); 34 } 35 36 /** 37 * 連接關閉調用的方法 38 */ 39 @OnClose 40 public void onClose(){ 41 webSocketSet.remove(this); //從set中刪除 42 subOnlineCount(); //在線數減1 43 System.out.println("有一連接關閉!當前在線人數為" + getOnlineCount()); 44 } 45 46 /** 47 * 收到客戶端消息后調用的方法 48 * @param message 客戶端發送過來的消息 49 * @param session 可選的參數 50 */ 51 @OnMessage 52 public void onMessage(String message, Session session) { 53 System.out.println("來自客戶端的消息:" + message); 54 55 //群發消息 56 for(MyWebSocket item: webSocketSet){ 57 try { 58 item.sendMessage(message); 59 } catch (IOException e) { 60 e.printStackTrace(); 61 continue; 62 } 63 } 64 } 65 66 /** 67 * 發生錯誤時調用 68 * @param session 69 * @param error 70 */ 71 @OnError 72 public void onError(Session session, Throwable error){ 73 System.out.println("發生錯誤"); 74 error.printStackTrace(); 75 } 76 77 /** 78 * 這個方法與上面幾個方法不一樣。沒有用注解,是根據自己需要添加的方法。 79 * @param message 80 * @throws IOException 81 */ 82 public void sendMessage(String message) throws IOException{ 83 this.session.getBasicRemote().sendText(message); 84 //this.session.getAsyncRemote().sendText(message); 85 } 86 87 public static synchronized int getOnlineCount() { 88 return onlineCount; 89 } 90 91 public static synchronized void addOnlineCount() { 92 MyWebSocket.onlineCount++; 93 } 94 95 public static synchronized void subOnlineCount() { 96 MyWebSocket.onlineCount--; 97 } 98 }
該Demo在以下環境測試過:
1.Jdk7+Tomcat7.0.47
2.Jdk7+Tomcat7.0.52
3.Jdk7+Tomcat8.0.3
4.Jdk7+Glassfish4
注意事項:在Eclipse或者MyEclipse中,需要添加Tomcat的library。直接拷貝Tomcat里lib目錄下的jar包有時會出錯。
文章轉載於: http://blog.chenzuhuang.com/archive/28.html