社群 學習 工具庫 休閒
搜尋
繁体中文
首頁 > 後端開發 > php教程 > php篇之細說websocket

php篇之細說websocket

coldplay.xixi
發布： 2023-04-08 22:16:02
轉載
3320 人瀏覽過

php篇之細說websocket

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

    +--------+    1.发送Sec-WebSocket-Key        +---------+
    |        | --------------------------------> |        |
    |        |    2.加密返回Sec-WebSocket-Accept  |        |
    | client | <-------------------------------- | server |
    |        |    3.本地校验                      |        |
    |        | --------------------------------> |        |
    +--------+                                   +--------+
登入後複製

看了我寫的上一篇文章的同學應該是對上圖有了比較全面的理解。 ① 和 ② 其實就是一個 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."\n");

        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\n";
                    }
                } else {
                    $bytes = @socket_recv($socket,$buffer,2048,0);
                    if($bytes == 0) return;
                    if (!$this->handshake) {
                        // 如果没有握手，先握手回应
                        //doHandShake($socket, $buffer);
                        echo "shakeHands\n";
                    } else {
                        // 如果已经握手，直接接受数据，并处理
                        $buffer = decode($buffer);
                        //process($socket, $buffer); 
                        echo "send file\n";
                    }
                }
            }
        }
    }
}
登入後複製

demo.php 握手連接測試程式碼

 

上面這段程式碼是經過我調試了的，沒太大的問題，如果想測試的話，可以在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: (.*)\r\n/", $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\r\n" .
               "Upgrade: websocket\r\n" .
               "Connection: Upgrade\r\n" .
               "Sec-WebSocket-Accept: " . $acceptKey . "\r\n" .
               "\r\n";

    // 写入socket
    socket_write(socket,$upgrade.chr(0), strlen($upgrade.chr(0)));
    // 标记握手已经成功，下次接受数据采用数据帧格式
    $this->handshake = true;
}
登入後複製

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

當客戶端成功校檢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\r\n');
            o.write('Upgrade: websocket\r\n');
            o.write('Connection: Upgrade\r\n');
            o.write('Sec-WebSocket-Accept: ' + key + '\r\n');
            o.write('\r\n');
        }else{
            console.log(e);
        };
    });
}).listen(8000);
登入後複製

多么简洁，多么方便！有谁还愿意使用 php 呢。。。。

2. 数据帧解析代码

本文没有给出 decodeFrame 这样数据帧解析代码，前文中给出了数据帧的格式，解析纯属体力活。

3. 代码下载

对这部分感兴趣的同学，可以再去深究。提供了参考代码下载。

4. 相关开源库参考

socketo.me Ratchet 为 php 封装的一个 WebSockets 库。 ]

Google 上搜索 php+websoket+class，也能找到不少相关的资料。

三、参考资料

  • www.php.net/manual/zh/r… php manual
  • www.rfc-editor.org/rfc/rfc6455…  [RFC6455] WebSocket

推荐教程：《php教程》

以上是php篇之細說websocket的詳細內容。更多資訊請關注PHP中文網其他相關文章！

相關標籤：
node.js php websocket 後端
來源：juejin.im
上一篇：PHP實作搜尋聯想功能（基於字典樹演算法） 下一篇：PHP實戰之Redis常見7種使用場景
本網站聲明
本文內容由網友自願投稿，版權歸原作者所有。本站不承擔相應的法律責任。如發現涉嫌抄襲或侵權的內容，請聯絡admin@php.cn
作者最新文章
最新問題
PHP數組從URL參數中取得的行為不如預期 我有一個包含類別ID的URL參數，我想將其視為一個數組，如下所示：http://example.com?cat[]=3,9,13在PHP中，我使用它從URL參數取得數組：$catI...
來自於 2024-04-06 22:09:02
0
1
1428
我應該在 apache 中哪裡放置 CustomLog 指令 我正在使用php:7.2-apachedocker。我需要禁用運行狀況檢查url登入訪問日誌。基於此鏈接，他們提到了有關修改Customlog指令的資訊。我不是關於需要更改Cust...
來自於 2024-04-06 22:03:59
0
1
990
傳回值中變數的格式是什麼？ 我是php的新學習者。我發現有一段程式碼：if($x<time()){return[false,'error'];}邏輯或變數並不重要，但我不明白[false,'error'...
來自於 2024-04-06 21:55:20
0
1
778
使用opentbs產生odt檔案時遇到的問題：相同key的值顯示在同一行而不是單獨的欄位中。 我正在使用一個名為OpenTbs的庫來使用PHP建立odt，我使用它是因為動態生成列和行。我知道如何建立行和列，但我不知道如何組織它們。讓我加入一個例子：所以首先我會將其添加到我的...
來自於 2024-04-06 20:18:18
0
1
483
依照ID對MySQL結果進行分組以便循環遍歷 我有一個表，其中有mysql中的航班資料。我正在編寫一個php程式碼，它將使用codeigniter3對資料進行分組和顯示journey_idair_idFlightDuratio...
來自於 2024-04-06 17:27:56
0
1
406
相關專題
更多>
熱門推薦
熱門教學
更多>
相關教學
熱門推薦
最新課程
最新下載
更多>
網站特效
網站源碼
網站素材
前端模板