細說websocket - php篇

cucumber 發布于2019-06-27 10:37 / 3330人閱讀

摘要：發送加密返回本地校驗看了我寫的上一篇文章的同學應該是對上圖有了比較全面的理解。前文中也提到了請求的格式如上，首先建立一個連接，監聽端口的信息。數據幀解析代碼本文沒有給出這樣數據幀解析代碼，前文中給出了數據幀的格式，解析純屬體力活。

本文同步自我的博客園：http://hustskyking.cnblogs.com

下面我畫了一個圖演示 client 和 server 之間建立 websocket 連接時握手部分，這個部分在 node 中可以十分輕松的完成，因為 node 提供的 net 模塊已經對 socket 套接字做了封裝處理，開發者使用的時候只需要考慮數據的交互而不用處理連接的建立。而 php 沒有，從 socket 的連接、建立、綁定、監聽等，這些都需要我們自己去操作，所以有必要拿出來再說一說。

+--------+   ① 發送Sec-WebSocket-Key         +--------+
|        | --------------------------------> |        |
|        |   ② 加密返回Sec-WebSocket-Accept  |        |
| client | <-------------------------------- | server |
|        |   ③ 本地校驗                      |        |
|        | --------------------------------> |        |
+--------+                                   +--------+

看了我寫的上一篇文章的同學應該是對上圖有了比較全面的理解。① 和 ② 實際上就是一個 HTTP 的請求和響應，只不過我們在處理的過程中我們拿到的是沒有經過解析的字符串。如：

GET /chat HTTP/1.1
Host: server.example.com
Origin: http://example.com

我們往常看到的請求是這個樣子，當這東西到了服務器端，我們可以通過一些代碼庫直接拿到這些信息。

一、php 中處理 websocket

WebSocket 連接是由客戶端主動發起的，所以一切要從客戶端出發。第一步是要解析拿到客戶端發過來的 Sec-WebSocket-Key 字符串。

GET /chat HTTP/1.1
Host: server.example.com
Upgrade: websocket
Connection: Upgrade
Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==
Origin: http://example.com
Sec-WebSocket-Protocol: chat, superchat
Sec-WebSocket-Version: 13

前文中也提到了 client 請求的格式（如上），首先 php 建立一個 socket 連接，監聽端口的信息。

1. socket 連接的建立

關于 socket 套接字的建立，相信很多大學修過計算機網絡的人都知道了，下面是一張連接建立的過程：

// 建立一個 socket 套接字
$master = socket_create(AF_INET, SOCK_STREAM, SOL_TCP);
socket_set_option($master, SOL_SOCKET, SO_REUSEADDR, 1);
socket_bind($master, $address, $port);
socket_listen($master);

相比 node，這個地方的處理實在是太麻煩了，上面幾行代碼并未建立連接，只不過這些代碼是建立一個 socket 套接字必須要寫的東西。由于處理過程稍微有復雜，所以我把各種處理寫進了一個類中，方便管理和調用。

//demo.php
Class WS {
    var $master;  // 連接 server 的 client
    var $sockets = array(); // 不同狀態的 socket 管理
    var $handshake = false; // 判斷是否握手

    function __construct($address, $port){
        // 建立一個 socket 套接字
        $this->master = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)   
            or die("socket_create() failed");
        socket_set_option($this->master, SOL_SOCKET, SO_REUSEADDR, 1)  
            or die("socket_option() failed");
        socket_bind($this->master, $address, $port)                    
            or die("socket_bind() failed");
        socket_listen($this->master, 2)                               
            or die("socket_listen() failed");

        $this->sockets[] = $this->master;

        // debug
        echo("Master socket  : ".$this->master."
");

        while(true) {
            //自動選擇來消息的 socket 如果是握手 自動選擇主機
            $write = NULL;
            $except = NULL;
            socket_select($this->sockets, $write, $except, NULL);

            foreach ($this->sockets as $socket) {
                //連接主機的 client 
                if ($socket == $this->master){
                    $client = socket_accept($this->master);
                    if ($client < 0) {
                        // debug
                        echo "socket_accept() failed";
                        continue;
                    } else {
                        //connect($client);
                        array_push($this->sockets, $client);
                        echo "connect client
";
                    }
                } else {
                    $bytes = @socket_recv($socket,$buffer,2048,0);
                    if($bytes == 0) return;
                    if (!$this->handshake) {
                        // 如果沒有握手，先握手回應
                        //doHandShake($socket, $buffer);
                        echo "shakeHands
";
                    } else {
                        // 如果已經握手，直接接受數據，并處理
                        $buffer = decode($buffer);
                        //process($socket, $buffer); 
                        echo "send file
";
                    }
                }
            }
        }
    }
}

上面這段代碼是經過我調試了的，沒太大的問題，如果想測試的話，可以在 cmd 命令行中鍵入 php /path/to/demo.php;當然，上面只是一個類，如果要測試的話，還得新建一個實例。

$ws = new WS("localhost", 4000);

客戶端代碼可以稍微簡單點：

var ws = new WebSocket("ws://localhost:4000");
ws.onopen = function(){
    console.log("握手成功");
};
ws.onerror = function(){
    console.log("error");
};

運行服務器代碼，當客戶端連接的時候，我們可以看到：

通過上面的代碼可以清晰的看到整個交流的過程。首先是建立連接，node 中這一步已經封裝到了 net 和 http 模塊，然后判斷是否握手，如果沒有的話，就 shakeHands。這里的握手我直接就 echo 了一個單詞，表示進行了這個東西，前文我們提到過握手算法，這里就直接寫了。

2. 提取 Sec-WebSocket-Key 信息

function getKey($req) {
    $key = null;
    if (preg_match("/Sec-WebSocket-Key: (.*)
/", $req, $match)) { 
        $key = $match[1]; 
    }
    return $key;
}

這里比較簡單，直接正則匹配，websocket 信息頭一定包含 Sec-WebSocket-Key，所以我們匹配起來也比較快捷~

3. 加密 Sec-WebSocket-Key

function encry($req){
    $key = $this->getKey($req);
    $mask = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";

    return base64_encode(sha1($key . "258EAFA5-E914-47DA-95CA-C5AB0DC85B11", true));
}

將 SHA-1 加密后的字符串再進行一次 base64 加密。如果加密算法錯誤，客戶端在進行校檢的時候會直接報錯：

4. 應答 Sec-WebSocket-Accept

function dohandshake($socket, $req){
    // 獲取加密key
    $acceptKey = $this->encry($req);
    $upgrade = "HTTP/1.1 101 Switching Protocols
" .
               "Upgrade: websocket
" .
               "Connection: Upgrade
" .
               "Sec-WebSocket-Accept: " . $acceptKey . "
" .
               "
";

    // 寫入socket
    socket_write(socket,$upgrade.chr(0), strlen($upgrade.chr(0)));
    // 標記握手已經成功，下次接受數據采用數據幀格式
    $this->handshake = true;
}

這里千萬要注意，每一個請求和相應的格式，最后有一個空行，也就是，開始測試的時候把這東西給弄丟了，糾結了半天。

當客戶端成功校檢key后，會觸發 onopen 函數：

5. 數據幀處理

// 解析數據幀
function decode($buffer)  {
    $len = $masks = $data = $decoded = null;
    $len = ord($buffer[1]) & 127;

    if ($len === 126)  {
        $masks = substr($buffer, 4, 4);
        $data = substr($buffer, 8);
    } else if ($len === 127)  {
        $masks = substr($buffer, 10, 4);
        $data = substr($buffer, 14);
    } else  {
        $masks = substr($buffer, 2, 4);
        $data = substr($buffer, 6);
    }
    for ($index = 0; $index < strlen($data); $index++) {
        $decoded .= $data[$index] ^ $masks[$index % 4];
    }
    return $decoded;
}

這里涉及的編碼問題在前文中已經提到過了，這里就不贅述，php 對字符處理的函數太多了，也記得不是特別清楚，這里就沒有詳細的介紹解碼程序，直接把客戶端發送的數據原樣返回，可以算是一個聊天室的模式吧。

// 返回幀信息處理
function frame($s) {
    $a = str_split($s, 125);
    if (count($a) == 1) {
        return "x81" . chr(strlen($a[0])) . $a[0];
    }
    $ns = "";
    foreach ($a as $o) {
        $ns .= "x81" . chr(strlen($o)) . $o;
    }
    return $ns;
}

// 返回數據
function send($client, $msg){
    $msg = $this->frame($msg);
    socket_write($client, $msg, strlen($msg));
}

客戶端代碼：

var ws = new WebSocket("ws://localhost:4000");
ws.onopen = function(){
    console.log("握手成功");
};
ws.onmessage = function(e){
    console.log("message:" + e.data);
};
ws.onerror = function(){
    console.log("error");
};
ws.send("李靖");

在連通之后發送數據，服務器原樣返回：

二、注意問題 1. websocket 版本問題

客戶端在握手時的請求中有Sec-WebSocket-Version: 13，這樣的版本標識，這個是一個升級版本，現在的瀏覽器都是使用的這個版本。而以前的版本在數據加密的部分更加麻煩，它會發送兩個key：

GET /chat HTTP/1.1
Host: server.example.com
Upgrade: websocket
Connection: Upgrade
Origin: http://example.com
Sec-WebSocket-Protocol: chat, superchat
Sec-WebSocket-Key1: xxxx
Sec-WebSocket-Key2: xxxx

如果是這種版本（比較老，已經沒在使用了），需要通過下面的方式獲取

function encry($key1,$key2,$l8b){
    //Get the numbers
    preg_match_all("/([d]+)/", $key1, $key1_num);
    preg_match_all("/([d]+)/", $key2, $key2_num);
    $key1_num = implode($key1_num[0]);
    $key2_num = implode($key2_num[0]);
    //Count spaces
    preg_match_all("/([ ]+)/", $key1, $key1_spc);
    preg_match_all("/([ ]+)/", $key2, $key2_spc);
    if($key1_spc==0|$key2_spc==0){ $this->log("Invalid key");return; }
    //Some math
    $key1_sec = pack("N",$key1_num / $key1_spc);
    $key2_sec = pack("N",$key2_num / $key2_spc);
    return md5($key1_sec.$key2_sec.$l8b,1);
}

只能無限吐槽這種驗證方式！相比 nodeJs 的 websocket 操作方式：

//服務器程序
var crypto = require("crypto");
var WS = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";
require("net").createServer(function(o){
    var key;
    o.on("data",function(e){
        if(!key){
            //握手
            key = e.toString().match(/Sec-WebSocket-Key: (.+)/)[1];
            key = crypto.createHash("sha1").update(key + WS).digest("base64");
            o.write("HTTP/1.1 101 Switching Protocols
");
            o.write("Upgrade: websocket
");
            o.write("Connection: Upgrade
");
            o.write("Sec-WebSocket-Accept: " + key + "
");
            o.write("
");
        }else{
            console.log(e);
        };
    });
}).listen(8000);

多么簡潔，多么方便！有誰還愿意使用 php 呢。。。。

2. 數據幀解析代碼

本文沒有給出 decodeFrame 這樣數據幀解析代碼，前文中給出了數據幀的格式，解析純屬體力活。

3. 代碼下載

對這部分感興趣的同學，可以再去深究。提供了參考代碼下載。

4. 相關開源庫參考

http://socketo.me Ratchet 為 php 封裝的一個 WebSockets 庫。
Google 上搜索 php+websoket+class，也能找到不少相關的資料。

三、參考資料

http://www.php.net/manual/zh/ref.sockets.php php manual

http://www.rfc-editor.org/rfc/rfc6455.txt RFC6455 WebSocket

GPU云服務器云服務器 php細說細說php 細說php怎么樣 websocket和webrtc php

文章版權歸作者所有，未經允許請勿轉載,若此文章存在違規行為，您可以聯系管理員刪除。

轉載請注明本文地址：http://specialneedsforspecialkids.com/yun/20700.html

細說websocket - php篇

摘要：發送加密返回本地校驗看了我寫的上一篇文章的同學應該是對上圖有了比較全面的理解。前文中也提到了請求的格式如上，首先建立一個連接，監聽端口的信息。數據幀解析代碼本文沒有給出這樣數據幀解析代碼，前文中給出了數據幀的格式，解析純屬體力活。本文同步自我的博客園：http://hustskyking.cnblogs.com 下面我畫了一個圖演示 client 和 server 之間建立 web...

MAX_zuo 2019-08-21 12:12 評論0 收藏0
細說WebSocket - Node篇

摘要：一協議概述協議允許不受信用的客戶端代碼在可控的網絡環境中控制遠程主機。該協議包含一個握手和一個基本消息分幀分層通過。該協議包括兩個方面，握手鏈接和數據傳輸。二注意事項很多人可能只是到，但事實上協議地址是可以加和的。本文同步自我的博客園：http://hustskyking.cnblogs.com P.S：文章代碼格式錯亂，也不知道是什么原因，還望@segmentFault的兄弟看下~...

wapeyang 2019-08-21 12:11 評論0 收藏0
Note: 基本的 WebSocket 的 Nginx 配置

摘要：覺得很容易用到從開始支持現在已經是了相對看過例子發現配置其實比較簡單先用模塊寫一個簡單的服務器然后修改添加比如指向然后是配置然后從瀏覽器控制臺嘗試鏈接或者通過的寫法先是通過建立連接然后通過狀態碼表示切換協議在配置里是不清楚具體里邊發生了什覺得很容易用到.. Nginx 從 1.3 開始支持 WebSocket, 現在已經是 1.4.4 了相對 HTTP, 看過例子發現配置其實比較簡...

tinylcy 2019-07-25 13:22 評論0 收藏0
細說 jQuery Ajax操作篇（二） - 數據傳遞

摘要：在前一篇介紹的數據加載中的例子都是從靜態的文件中取得數據，而更大的價值在于與后端服務器進行數據傳遞，動態地請求和發送數據。首先用方式請求數據方式點擊標簽后，當前頁面為數據請求成功。在前一篇介紹 jQuery Ajax 的數據加載中的例子都是從靜態的文件中取得數據，而 Ajax 更大的價值在于與后端服務器進行數據傳遞，動態地請求和發送數據。請求數據我們可以使用 GET、POST...

paulli3 2019-08-21 12:21 評論0 收藏0
PHP 程序員也能做的 Java 開發 30分鐘使用 netty 輕松打造一個高性能 websock

摘要：唯一的知識點就是的基礎使用。可以簡單的理解下面的代碼就構建了一個服務器。握手完成之后的消息傳遞則在中處理。實際情況下，不可能那么多人同時說話廣播，而是說話的人少，接受廣播的人多。硬廣一波 SF 官方首頁推薦《PHP進階之路》（你又多久沒有投資自己了？先看后買）我們下面則將一些實際場景都添加進去，比如用戶身份的驗證，游客只能瀏覽不能發言，多房間（頻道）的聊天。該博客非常適合 Java...

kviccn 2019-08-15 10:44 評論0 收藏0