Java WebSocket - JavaShuo

本示例的目的，就是經過webSocket向客戶端（瀏覽器端）發送消息.

1、什麼是WebSocket

　　WebSocket協議是基於TCP的一種新的網絡協議。它實現了瀏覽器與服務器全雙工(full-duplex)通訊——容許服務器主動發送信息給客戶端。

WebSocket通訊協議於2011年被 IETF定爲標準RFC 6455，並被RFC7936所補充規範。

2、經過Java代碼實現從服務端發消息給客戶端

3、環境說明

　　java1.七、apache-tomcat-7.0.7八、maven

　　依賴

　　<dependency>
    　　<groupId>javax</groupId>
    　　<artifactId>javaee-api</artifactId>
    　　<version>7.0</version>
    　　<scope>provided</scope>
　　</dependency>
4、代碼

import javax.websocket.*; import javax.websocket.server.PathParam; import javax.websocket.server.ServerEndpoint; import java.io.IOException; import java.util.Map; import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentMap; /** * @ServerEndpoint 註解是一個類層次的註解，它的功能主要是將目前的類定義成一個websocket服務器端, * 註解的值將被用於監聽用戶鏈接的終端訪問URL地址,客戶端能夠經過這個URL來鏈接到WebSocket服務器端 */ @ServerEndpoint("/websocket/{userId}") public class NoticeWebSocket { //靜態變量，用來記錄當前在線鏈接數。應該把它設計成線程安全的。
    private static int onlineCount = 0; //concurrent包的線程安全map，用來存放每一個客戶端對應的NoticeWebSocket對象
    private static ConcurrentMap<String, NoticeWebSocket> webSocketSet = new ConcurrentHashMap<String, NoticeWebSocket>(); //與某個客戶端的鏈接會話，須要經過它來給客戶端發送數據
    private Session session; /** * 鏈接創建成功調用的方法 * * @param session 可選的參數。session爲與某個客戶端的鏈接會話，須要經過它來給客戶端發送數據 */ @OnOpen public void onOpen(@PathParam(value = "userId") String userId, Session session) { this.session = session; webSocketSet.put(userId, this);     //加入set中
        addOnlineCount();                   //在線數加1
        System.out.println("有新鏈接加入！當前在線人數爲" + getOnlineCount()); } /** * 鏈接關閉調用的方法 */ @OnClose public void onClose(@PathParam(value = "userId") String userId) { webSocketSet.remove(userId); //從set中刪除
        subOnlineCount();               //在線數減1
        System.out.println("有一鏈接關閉！當前在線人數爲" + getOnlineCount()); } /** * 收到客戶端消息後調用的方法 * * @param message 客戶端發送過來的消息 * @param session 可選的參數 */ @OnMessage public void onMessage(String message, Session session) { System.out.println("來自客戶端的消息:" + message); //羣發消息
        for (Map.Entry entry : webSocketSet.entrySet()) { try { NoticeWebSocket item = (NoticeWebSocket) entry.getValue(); item.sendMessage(message); } catch (IOException e) { e.printStackTrace(); continue; } } } /** * 發生錯誤時調用 * * @param session * @param error */ @OnError public void onError(Session session, Throwable error) { System.out.println("發生錯誤"); error.printStackTrace(); } /** * 這個方法與上面幾個方法不同。沒有用註解，是根據本身須要添加的方法。 * * @param message * @throws IOException */
    public void sendMessage(String message) throws IOException { this.session.getBasicRemote().sendText(message); //this.session.getAsyncRemote().sendText(message);
 } public static synchronized int getOnlineCount() { return onlineCount; } public static synchronized void addOnlineCount() { NoticeWebSocket.onlineCount++; } public static synchronized void subOnlineCount() { NoticeWebSocket.onlineCount--; } public static ConcurrentMap<String, NoticeWebSocket> getWebSocketSet() { return webSocketSet; } public static void setWebSocketSet(ConcurrentMap<String, NoticeWebSocket> webSocketSet) { NoticeWebSocket.webSocketSet = webSocketSet; } }

頁面Jsjava

var websocket = null; //判斷當前瀏覽器是否支持WebSocket
    if ('WebSocket' in window) { websocket = new WebSocket("ws://localhost:8080/websocket/xxx"); } else { alert('當前瀏覽器 Not support websocket') } //鏈接發生錯誤的回調方法
    websocket.onerror = function () { setMessageInnerHTML("WebSocket鏈接發生錯誤"); }; //鏈接成功創建的回調方法
    websocket.onopen = function () { setMessageInnerHTML("WebSocket鏈接成功"); } //接收到消息的回調方法
    websocket.onmessage = function (event) { setMessageInnerHTML(event.data); } //鏈接關閉的回調方法
    websocket.onclose = function () { setMessageInnerHTML("WebSocket鏈接關閉"); } //監聽窗口關閉事件，當窗口關閉時，主動去關閉websocket鏈接，防止鏈接還沒斷開就關閉窗口，server端會拋異常。
    window.onbeforeunload = function () { closeWebSocket(); } //將消息顯示在網頁上
    function setMessageInnerHTML(innerHTML) { console.log(innerHTML); } //關閉WebSocket鏈接
    function closeWebSocket() { websocket.close(); } //發送消息
    function send() { var message = "牛。。"; websocket.send(message); }

測試web

我是用了SpringMvc 寫了一個Controllerapache

/** * 發送消息給當前登陸人 TEST * * @return
     */ @RequestMapping(value = "/free/sendMessageTest", method = RequestMethod.GET) @ResponseBody public Map<String, Object> sendMessageTest(String userId) { Map<String, Object> map = new HashMap<String, Object>(); ConcurrentMap<String, NoticeWebSocket> noticeWebSockets = NoticeWebSocket.getWebSocketSet(); try { map.put("status", 0); NoticeWebSocket noticeWebSocket = noticeWebSockets.get(userId); if (null != noticeWebSocket) { noticeWebSocket.sendMessage("牛逼Class UserId=" + userId); } } catch (IOException e) { e.printStackTrace(); map.put("status", -1); } return map; }

說明後端

websocket = new WebSocket("ws://localhost:8080/websocket/xxx"); xxx 表明一個用戶惟一標識，當頁面加載這段Js時會和服務端創建鏈接調用後端onOpen(String userId)方法會把"xxx"傳到後臺去，而後用map保存，userId 就是key,登陸的session 就是value。（若是有多個頁面訪問就會有多個session）,我這裏之全部用ConcurrentMap 是由於它是線程安全的。