WebSocket實現Java後臺消息推送

1.什麼是WebSocket

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

2.實現原理

　　在實現websocket連線過程當中，須要經過瀏覽器發出websocket連線請求，而後服務器發出迴應，這個過程一般稱爲「握手」 。在 WebSocket API，瀏覽器和服務器只須要作一個握手的動做，而後，瀏覽器和服務器之間就造成了一條快速通道。二者之間就直接能夠數據互相傳送。

　　　　　　　　　　　　　　　　　　　　　　　 

3.優勢

　　在之前的消息推送機制中，用的都是 Ajax 輪詢（polling），在特定的時間間隔由瀏覽器自動發出請求，將服務器的消息主動的拉回來，這種方式是很是消耗資源的，由於它本質仍是http請求，並且顯得很是笨拙。而WebSocket 在瀏覽器和服務器完成一個握手的動做，在創建鏈接以後，服務器能夠主動傳送數據給客戶端，客戶端也能夠隨時向服務器發送數據。

4.WebSocket和Socket的區別

　　1.WebSocket:

1. 1. websocket通信的創建階段是依賴於http協議的。最初的握手階段是http協議，握手完成後就切換到websocket協議，並徹底與http協議脫離了。

   2. 創建通信時，也是由客戶端主動發起鏈接請求，服務端被動監聽。

   3. 通信一旦創建鏈接後，通信就是「全雙工」模式了。也就是說服務端和客戶端都能在任什麼時候間自由得發送數據，很是適合服務端要主動推送實時數據的業務場景。

   4. 交互模式再也不是「請求-應答」模式，徹底由開發者自行設計通信協議。

   5. 通訊的數據是基於「幀(frame)」的，能夠傳輸文本數據，也能夠直接傳輸二進制數據，效率高。固然，開發者也就要考慮封包、拆包、編號等技術細節。

　　2.Socket:

1. 1. 服務端監聽通信，被動提供服務；客戶端主動向服務端發起鏈接請求，創建起通信。

   2. 每一次交互都是：客戶端主動發起請求（request），服務端被動應答（response）。

   3. 服務端不能主動向客戶端推送數據。

   4. 通訊的數據是基於文本格式的。二進制數據（好比圖片等）要利用base64等手段轉換爲文本後才能傳輸。

5.WebSocket客戶端：

var websocket = null;
var host = document.location.host;  
var username = "${loginUsername}"; // 得到當前登陸人員的userName  
 // alert(username)
//判斷當前瀏覽器是否支持WebSocket  
if ('WebSocket' in window) {  
	alert("瀏覽器支持Websocket")
    websocket = new WebSocket('ws://'+host+'/mm-dorado/webSocket/'+username);  
} else {  
    alert('當前瀏覽器 Not support websocket')  
}  

//鏈接發生錯誤的回調方法  
websocket.onerror = function() {  
　　alert("WebSocket鏈接發生錯誤")
   setMessageInnerHTML("WebSocket鏈接發生錯誤");  
};   
  
//鏈接成功創建的回調方法  
websocket.onopen = function() {
　　alert("WebSocket鏈接成功")  
   setMessageInnerHTML("WebSocket鏈接成功");  
}  
  
//接收到消息的回調方法  
websocket.onmessage = function(event) {
	alert("接收到消息的回調方法")  
	alert("這是後臺推送的消息："+event.data); 
　　　　 websocket.close();
　　　　alert("webSocket已關閉！")
}  
  
//鏈接關閉的回調方法  
websocket.onclose = function() {  
    setMessageInnerHTML("WebSocket鏈接關閉");  
}  
  
//監聽窗口關閉事件，當窗口關閉時，主動去關閉websocket鏈接，防止鏈接還沒斷開就關閉窗口，server端會拋異常。  
window.onbeforeunload = function() {  
    closeWebSocket();  
}  
  
//關閉WebSocket鏈接  
function closeWebSocket() {  
    websocket.close();  
}  

//將消息顯示在網頁上
    function setMessageInnerHTML(innerHTML) {
        document.getElementById('message').innerHTML += innerHTML + '<br/>';
    }

　　6.WebSocket服務端（java後臺）：

　　　　1.核心類：

package com.mes.util;

import java.io.IOException;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

import javax.websocket.OnClose;
import javax.websocket.OnError;
import javax.websocket.OnMessage;
import javax.websocket.OnOpen;
import javax.websocket.Session;
import javax.websocket.server.PathParam;
import javax.websocket.server.ServerEndpoint;

import org.springframework.stereotype.Component;
import org.springframework.stereotype.Service;

import com.google.gson.JsonObject;

import net.sf.json.JSONObject;
@ServerEndpoint("/webSocket/{username}")   
	public class WebSocket {  
	    private static int onlineCount = 0;  
	    private static Map<String, WebSocket> clients = new ConcurrentHashMap<String, WebSocket>();  
	    private Session session;  
	    private String username;  
	      
	    @OnOpen  
	    public void onOpen(@PathParam("username") String username, Session session) throws IOException {  
	  
	        this.username = username;  
	        this.session = session;  
	          
	        addOnlineCount();  
	        clients.put(username, this); 
	        System.out.println("已鏈接");
	    }  
	  
	    @OnClose  
	    public void onClose() throws IOException {  
	        clients.remove(username);  
	        subOnlineCount();  
	    }  
	  
	    @OnMessage  
	    public void onMessage(String message) throws IOException {  
	  
	        JSONObject jsonTo = JSONObject.fromObject(message);  
	        String mes = (String) jsonTo.get("message");
	        
	        if (!jsonTo.get("To").equals("All")){  
	            sendMessageTo(mes, jsonTo.get("To").toString());  
	        }else{  
	            sendMessageAll("給全部人");  
	        }  
	    }  
	  
	    @OnError  
	    public void onError(Session session, Throwable error) {  
	        error.printStackTrace();  
	    }  
	  
	    public void sendMessageTo(String message, String To) throws IOException {  
	        // session.getBasicRemote().sendText(message);  
	        //session.getAsyncRemote().sendText(message);  
	        for (WebSocket item : clients.values()) {  
	            if (item.username.equals(To) )  
	                item.session.getAsyncRemote().sendText(message);  
	        }  
	    }  
	      
	    public void sendMessageAll(String message) throws IOException {  
	        for (WebSocket item : clients.values()) {  
	            item.session.getAsyncRemote().sendText(message);  
	        }  
	    }  
	  
	    public static synchronized int getOnlineCount() {  
	        return onlineCount;  
	    }  
	  
	    public static synchronized void addOnlineCount() {  
	        WebSocket.onlineCount++;  
	    }  
	  
	    public static synchronized void subOnlineCount() {  
	        WebSocket.onlineCount--;  
	    }  
	  
	    public static synchronized Map<String, WebSocket> getClients() {  
	        return clients;  
	    }  
}

　　2.在本身代碼中的調用：

WebSocket ws = new WebSocket();
JSONObject jo = new JSONObject();
jo.put("message", "這是後臺返回的消息！");
jo.put("To",invIO.getIoEmployeeUid());
ws.onMessage(jo.toString());

　　7.所需maven依賴：

<!-- webSocket 開始-->
<dependency>
    <groupId>javax.websocket</groupId>
    <artifactId>javax.websocket-api</artifactId>
    <version>1.1</version>
    <scope>provided</scope>
</dependency>

<dependency>
    <groupId>javax</groupId>
    <artifactId>javaee-api</artifactId>
    <version>7.0</version>
    <scope>provided</scope>
</dependency>
<!-- webSocket 結束-->