websocket協議解析
wensocket協議包含兩部分:一部分是“握手”，一部分是“數據傳輸”。
爲了便於演示，我們採用swoole建立一個websocket服務器來演示。
第一步、握手
①客戶端向服務端發起連接請求
如圖，我們在請求服務器的時候，發送了這樣的request header。
下面我們就一些比較重要的字段信息進行說明：
Connection:Upgrade #通知服務器協議升級 Upgrade:websocket #協議升級爲websocket協議
Host:0.0.0.0:9501 #升級協議的服務主機:端口地址
Sec-WebSocket-Key:K8o1cNIxO2pR6inTIDBSgg== #傳輸給服務器的key
Sec-WebSocket-Version:13 #websocket協議版本13
Sec-WebSocket-Key有什麼用呢？
客戶端將這個key發送給服務器，服務器將這個key進行處理，將處理後的key返回給客戶端，客戶端根據這個key是否正確來判斷是否建立連接。
②：服務端返回握手應答 
如圖，我們看到websocket協議狀態碼是101.
101表示協議切換成功。- 1
我們查看websocket的response header。如圖： 
下面解釋下reponse header字段的含義
Connection:Upgrade #協議升級成功
Sec-WebSocket-Accept:GnoYH/ip/ZMh+a5rX5P/YR6e68g= #服務端處理之後的key
Sec-WebSocket-Version:13#websocket 協議版本號
Upgrade:websocket#協議升級爲websocket
至此，websocket握手成功！下面就盡情的傳輸數據吧！
第二步、數據傳輸
連接建立成功之後，就可以進行數據傳輸了，不同的客戶端有不同的實現方案，在Android、iOS、網頁（通過js）都可以向服務器發送數據，當然服務器可以是java、PHP等，客戶端和服務器端都有相應的解決方案。
三、實現方案概述
通過上面對websocket的瞭解，websocket是一種類似http新的協議，代替以前網絡輪訓或長連接代碼的資源消耗，專門用來做一些實時性很強的數據傳輸，可以建立webSocket連接，然後數據通過建立的webSocket通道進行傳輸。大致流程如下：
如上圖，app和服務器建立websocket連接後，會得到websocket對象，然後app端通過websocket對象向服務器發送數據。網頁端建立websocket的過程和app端一致，得到websocket對象後，這個websocket通過會處於監聽狀態，一致監聽服務器是否有數據到來。當圖中app發送數據到服務器（標號爲3，綠色線），服務器會通過和網頁端建立的websocket對象向網頁發送一條數據（標號爲6，綠色線），然後網頁端會收到服務器發送的數據。
注：上圖通信過程中總共建立2個websocket連接，一個是app端和服務器端建立的連接，建立後app端會有一個websocket對象，服務器端有一個websocket對象。一個是網頁端和服務器端建立的連接，建立後網頁會有一個websocket對象，服務器端有一個websocket對象。所以，服務器端此時有2個websocket對象，達到app端的數據向網頁端轉發的功能。
三、實現細節（app、網頁、服務器）
1. app
app端採用Android技術實現，Android端提供websocket通信相關的庫，爲JavaWebSocket_fat.jar，可以導入進來直接使用。
public class WebSocketUtil {
private static final String TAG = "WebSocketUtil";
public WebSocketClient mWebSocketClient;
public boolean isStartDataTransfer;
public String mCurBrowserClientID;
public String mCurAppClientID;
//建立websocket連接
public void connectWebSocket(String address) {
try {
initSocketClient(address);
} catch (URISyntaxException e) {
e.printStackTrace();
}
new Thread(){
@Override
public void run() {
mWebSocketClient.connect();
}
}.start();
}
public void initSocketClient(String address) throws URISyntaxException {
if(mWebSocketClient == null) {
//建立成功會得到一個websocket的客戶端對象，以後發消息都是通過這個對象來發送
mWebSocketClient = new WebSocketClient(new URI(address)) {
@Override
public void onOpen(ServerHandshake serverHandshake) {
//連接成功
Log.i(TAG,"opened connection");
}
@Override
public void onMessage(String s) {
//收到服務端消息
Log.i(TAG,"received:" + s);
}
@Override
public void onClose(int i, String s, boolean remote) {
//連接斷開，remote判定是客戶端斷開還是服務端斷開
Log.i(TAG,"Connection closed by " + ( remote ? "remote peer" : "us" ) + ", info=" + s);
}
@Override
public void onError(Exception e) {
Log.e(TAG,"error:" + e);
}
};
}
}
//給服務器發送消息
public void sendSocketMsg(String msg) {
Log.i(TAG,"sendSocketMsg");
if (mWebSocketClient!=null && mWebSocketClient.isOpen()){
mWebSocketClient.send(msg); //通過mWebSocketClient發送數據
Log.i(TAG,"msg:"+msg);
}
}
//斷開連接
public void closeConnectWebSocket() {
try {
if(mWebSocketClient!=null){
mWebSocketClient.close();
mWebSocketClient = null;
}
} catch(Exception e) {
e.printStackTrace();
} finally {
mWebSocketClient = null;
isStartDataTransfer = false;
}
}- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
2. 網頁
網頁端端HTML5提供了websocket的實現方案，直接調用js的函數即可建立連接、發送數據等，會發現網頁端和app的websocket建立連接過程極爲相似。
<%@ page language="java" pageEncoding="UTF-8" %>
<!DOCTYPE html>
<html>
<head>
<title>Java後端WebSocket的Tomcat實現</title>
</head>
<body>
Welcome<br/><input id="text" type="text"/>
<button onclick="send()">發送消息</button>
<hr/>
<button onclick="closeWebSocket()">關閉WebSocket連接</button>
<hr/>
<div id="message"></div>
</body>
<script type="text/javascript">
var websocket = null;
//判斷當前瀏覽器是否支持WebSocket
if ('WebSocket' in window) {
websocket = new WebSocket("ws://localhost:8080/websocket");
}
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) {
document.getElementById('message').innerHTML += innerHTML + '<br/>';
}
//關閉WebSocket連接
function closeWebSocket() {
websocket.close();
}
//發送消息
function send() {
var message = document.getElementById('text').value;
websocket.send(message);
}
</script>
</html>
- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
3. 服務器
服務器端使用Java來寫後臺，用tomcat做服務器，tomcat7.0以上都提供了websocket實現庫，這個庫是tomcat自帶的，直接使用即可，無需導入，如圖：
所以這個功能比較常用，tomcat都列爲自帶庫名單了。
package me.gacl.websocket;
import java.io.IOException;
import java.util.concurrent.CopyOnWriteArraySet;
import javax.websocket.*;
import javax.websocket.server.ServerEndpoint;
/**
* @ServerEndpoint 註解是一個類層次的註解，它的功能主要是將目前的類定義成一個websocket服務器端,
* 註解的值將被用於監聽用戶連接的終端訪問URL地址,客戶端可以通過這個URL來連接到WebSocket服務器端
*/
@ServerEndpoint("/websocket")
public class WebSocketTest {
//靜態變量，用來記錄當前在線連接數。應該把它設計成線程安全的。
private static int onlineCount = 0;
//concurrent包的線程安全Set，用來存放每個客戶端對應的MyWebSocket對象。若要實現服務端與單一客戶端通信的話，可以使用Map來存放，其中Key可以爲用戶標識
private static CopyOnWriteArraySet<WebSocketTest> webSocketSet = new CopyOnWriteArraySet<WebSocketTest>();
//與某個客戶端的連接會話，需要通過它來給客戶端發送數據
private Session session;
/**
* 連接建立成功調用的方法
* @param session 可選的參數。session爲與某個客戶端的連接會話，需要通過它來給客戶端發送數據
*/
@OnOpen
public void onOpen(Session session){
this.session = session;
webSocketSet.add(this); //加入set中
addOnlineCount(); //在線數加1
System.out.println("有新連接加入！當前在線人數爲" + getOnlineCount());
}
/**
* 連接關閉調用的方法
*/
@OnClose
public void onClose(){
webSocketSet.remove(this); //從set中刪除
subOnlineCount(); //在線數減1
System.out.println("有一連接關閉！當前在線人數爲" + getOnlineCount());
}
/**
* 收到客戶端消息後調用的方法
* @param message 客戶端發送過來的消息
* @param session 可選的參數
*/
@OnMessage
public void onMessage(String message, Session session) {
System.out.println("來自客戶端的消息:" + message);
//羣發消息
for(WebSocketTest item: webSocketSet){
try {
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() {
WebSocketTest.onlineCount++;
}
public static synchronized void subOnlineCount() {
WebSocketTest.onlineCount--;
}
}- 1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
- 10
- 11
- 12
- 13
- 14
- 15
- 16
- 17
- 18
- 19
- 20
- 21
- 22
- 23
- 24
- 25
- 26
- 27
- 28
- 29
- 30
- 31
- 32
- 33
- 34
- 35
- 36
- 37
- 38
- 39
- 40
- 41
- 42
- 43
- 44
- 45
- 46
- 47
- 48
- 49
- 50
- 51
- 52
- 53
- 54
- 55
- 56
- 57
- 58
- 59
- 60
- 61
- 62
- 63
- 64
- 65
- 66
- 67
- 68
- 69
- 70
- 71
- 72
- 73
- 74
- 75
- 76
- 77
- 78
- 79
- 80
- 81
- 82
- 83
- 84
- 85
- 86
- 87
- 88
- 89
- 90
- 91
- 92
- 93
- 94
- 95
- 96
- 97
看完三個代碼，會發現app、網頁、服務器的websocket代碼極爲相似，知道原理後代碼寫起來很簡單。