ホームページ > 記事 > バックエンド開発 > PHP での WebSocket の詳細な紹介

PHP での WebSocket の詳細な紹介

黄舟オリジナル: 2017-09-18 10:46:511698ブラウズ

以下に、クライアントとサーバーの間で WebSocket 接続を確立するときのハンドシェイク部分を示す図を描きました。これは、ノードによって提供されるネットモジュールが開発者によってすでにカプセル化されているため、この部分はノード内で非常に簡単に完了できます。データの相互作用のみを考慮する必要があり、接続の確立に対処する必要はありません。しかし、PHPはそうではなく、ソケットの接続、確立、バインディング、監視など、これらを自分で操作する必要があるため、それを取り出して話す必要があります。

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

私が書いた前回の記事を読んだ学生は、上の図をより包括的に理解できるはずです。 ①と②は実際にはHTTPリクエストとレスポンスですが、処理中に取得するのは解析されていない文字列です。例:

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

私たちが通常目にするリクエストは次のようになります。これがサーバーに到達すると、いくつかのコードライブラリを通じてこの情報を直接取得できます。

1. php での WebSocket の処理

WebSocket 接続はクライアントによってアクティブに開始されるため、すべてはクライアントから開始する必要があります。最初のステップは、クライアントから送信された Sec-WebSocket-Key 文字列を解析することです。

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

クライアントリクエストの形式については前回の記事でも触れています（上記の通り）まず、phpはソケット接続を確立し、ポート情報を監視します。

1. ソケット接続の確立

ソケットの確立については、大学でコンピュータネットワークを学んだことがある方はご存知かと思いますが、以下は接続確立のプロセスの図です。

写真ここの処理はノードに比べて面倒です。上記のコード行は接続を確立しませんが、ソケットを確立するためにこれらのコードを記述する必要があります。処理プロセスが少し複雑なので、管理や呼び出しを容易にするために、さまざまな処理をクラスに記述しました。

// 建立一个 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);

上記のコードは私がデバッグしたもので、大きな問題はありません。テストしたい場合は、cmd コマンドに php /path/to/demo.php と入力してください。 ; もちろん、上記は単なるクラスです。テストしたい場合は、新しいインスタンスを作成する必要があります。

//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";
                    }
                }
            }
        }
    }
}

クライアントコードはもう少し単純にすることができます:

php /path/to/demo.php;当然，上面只是一个类，如果要测试的话，还得新建一个实例。

$ws = new WS(&#39;localhost&#39;, 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 . &#39;258EAFA5-E914-47DA-95CA-C5AB0DC85B11&#39;, 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;
}

这里千万要注意，每一个请求和相应的格式，最后有一个空行，也就是 rn，开始测试的时候把这东西给弄丢了，纠结了半天。

当客户端成功校检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

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

🎜サーバーコードを実行します。クライアントが接続すると、次のことがわかります: 🎜🎜

🎜🎜上記のコードを通して、通信プロセス全体を明確に見ることができます。 1 つ目は接続を確立することです。ノードのこのステップは net および http モジュールにカプセル化されており、そうでない場合は握手するかどうかを決定します。ここでのハンドシェイクについては、これが実行されたことを示すために単語を直接エコーしました。ハンドシェイクのアルゴリズムについては前述したので、ここに直接書きました。 🎜🎜2. Sec-WebSocket-Key 情報を抽出します🎜🎜🎜🎜

function encry($key1,$key2,$l8b){ //Get the numbers preg_match_all(&#39;/([\d]+)/&#39;, $key1, $key1_num); preg_match_all(&#39;/([\d]+)/&#39;, $key2, $key2_num);    
$key1_num = implode($key1_num[0]);    
$key2_num = implode($key2_num[0]);    
//Count spaces    
preg_match_all(&#39;/([ ]+)/&#39;, $key1, $key1_spc);    
preg_match_all(&#39;/([ ]+)/&#39;, $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);
}

🎜これは比較的単純で、直接的な正規のマッチングです。WebSocket 情報ヘッダーには Sec-WebSocket-Key が含まれている必要があるため、マッチングが高速になります~🎜🎜3. -WebSocket-Key🎜🎜🎜🎜

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

🎜 SHA-1で暗号化された文字列をbase64で再度暗号化します。暗号化アルゴリズムが間違っている場合、クライアントはチェック時にエラーを直接報告します: 🎜🎜

🎜🎜4. Sec-WebSocket-Accept に応答します🎜🎜🎜🎜rrreee🎜各リクエストと対応する形式の最後に空白行 (

rn code) があることに注意してください。 >, テストを始めたときにこれを紛失してしまい、長い間苦労しました。 🎜🎜<img src="https://img.php.cn/upload/article/000/000/194/8b30a39b92f6f7e5467453e27b098604-4.jpg" alt="">🎜🎜クライアントがキーを正常にチェックすると、 onopen 関数がトリガーされます: 🎜🎜<img src="https://img.php.cn/upload/article/000/000/194/8b30a39b92f6f7e5467453e27b098604-5.jpg" alt="">🎜🎜5.フレーム処理 🎜🎜🎜🎜rrreee🎜 ここでのエンコーディングの問題については前の記事で述べたので、ここでは詳しく説明しません。PHP には文字処理に関する関数が多すぎて、よく覚えていません。ここではデコードプログラムの詳細な紹介はありませんが、クライアントから送信されたデータをそのまま返します。これはチャット ルーム モードとみなすことができます。 🎜🎜🎜🎜rrreee🎜クライアントコード: 🎜🎜🎜🎜rrreee🎜接続後にデータを送信すると、サーバーはそのまま戻ります: 🎜🎜<img src="https://img.php.cn/upload/article/000/%20000%20/194/0278944a9d5d3fd076b2a4aff413bdb7-6.jpg" alt="">🎜🎜 2. 注意すべき問題 🎜🎜1. Websocket バージョンの問題 🎜🎜 ハンドシェイク中のクライアントのリクエストには、<code>Sec-WebSocket-Version が含まれています。 13 などのバージョン識別。これはアップグレードされたバージョンであり、現在のすべてのブラウザはこのバージョンを使用します。以前のバージョンでは、データ暗号化の部分でより面倒な作業が行われていました。 🎜 という 2 つのキーが送信されていました。<p class="cnblogs_code"><br></p>
<pre class="brush:php;toolbar:false">GET /chat HTTP/1.1Host: server.example.com
Upgrade: websocket
Connection: Upgrade
Origin: http://example.com
Sec-WebSocket-Protocol: chat, superchatSec-WebSocket-Key1: xxxxSec-WebSocket-Key2: xxxx</pre>
<p>如果是这种版本（比较老，已经没在使用了），需要通过下面的方式获取</p>
<p class="cnblogs_code"><br></p><pre class="brush:php;toolbar:false;">function encry($key1,$key2,$l8b){ //Get the numbers preg_match_all(&amp;#39;/([\d]+)/&amp;#39;, $key1, $key1_num); preg_match_all(&amp;#39;/([\d]+)/&amp;#39;, $key2, $key2_num);    
$key1_num = implode($key1_num[0]);    
$key2_num = implode($key2_num[0]);    
//Count spaces    
preg_match_all(&amp;#39;/([ ]+)/&amp;#39;, $key1, $key1_spc);    
preg_match_all(&amp;#39;/([ ]+)/&amp;#39;, $key2, $key2_spc);    
if($key1_spc==0|$key2_spc==0){ $this-&gt;log(&quot;Invalid key&quot;);
return; }    //Some math    
$key1_sec = pack(&quot;N&quot;,$key1_num / $key1_spc);    
$key2_sec = pack(&quot;N&quot;,$key2_num / $key2_spc);    
return md5($key1_sec.$key2_sec.$l8b,1);
}</pre><p>只能无限吐槽这种验证方式！相比 nodeJs 的 websocket 操作方式：</p>
<p class="cnblogs_code"><br></p><pre class="brush:php;toolbar:false;">//服务器程序var crypto = require(&amp;#39;crypto&amp;#39;);var WS = &amp;#39;258EAFA5-E914-47DA-95CA-C5AB0DC85B11&amp;#39;;
require(&amp;#39;net&amp;#39;).createServer(function(o){    var key;
    o.on(&amp;#39;data&amp;#39;,function(e){        if(!key){            //握手
            key = e.toString().match(/Sec-WebSocket-Key: (.+)/)[1];
            key = crypto.createHash(&amp;#39;sha1&amp;#39;).update(key + WS).digest(&amp;#39;base64&amp;#39;);
            o.write(&amp;#39;HTTP/1.1 101 Switching Protocols\r\n&amp;#39;);
            o.write(&amp;#39;Upgrade: websocket\r\n&amp;#39;);
            o.write(&amp;#39;Connection: Upgrade\r\n&amp;#39;);
            o.write(&amp;#39;Sec-WebSocket-Accept: &amp;#39; + key + &amp;#39;\r\n&amp;#39;);
            o.write(&amp;#39;\r\n&amp;#39;);
        }else{
            console.log(e);
        };
    });
}).listen(8000);</pre><p>多么简洁，多么方便！有谁还愿意使用 php 呢。。。。</p>

以上がPHP での WebSocket の詳細な紹介の詳細内容です。詳細については、PHP 中国語 Web サイトの他の関連記事を参照してください。

声明：

この記事の内容はネチズンが自主的に寄稿したものであり、著作権は原著者に帰属します。このサイトは、それに相当する法的責任を負いません。盗作または侵害の疑いのあるコンテンツを見つけた場合は、admin@php.cn までご連絡ください。

前の記事：PHPで1Gサイズのファイルを読み込む実装方法の紹介次の記事：PHPで1Gサイズのファイルを読み込む実装方法の紹介

続きを見る