资源猫
资源猫

php篇之细说websocket-php教程

资源魔 43 0

上面我画了一个图演示 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

咱们往常看到的申请是这个样子，当这货色到了效劳器端，咱们能够经过一些代码库间接拿到这些信息。

1、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("李靖");

正在连通之后发送数据，效劳器原样前往：

2、留意成绩

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，也能找到很多相干的材料。

3、参考材料

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

保举教程：《php教程》

以上就是php篇之细说websocket的具体内容，更多请存眷资源魔其它相干文章！

标签： php php开发教程 php开发资料 php开发自学 后端 WebSocket Node.js

版权声明：除非特别标注，否则均为本站原创文章，转载时请以链接形式注明文章出处。

上一个详解PHP的反射使用-php教程

下一个PHP实现搜索联想功能（基于字典树算法）-php教程

相关文章

抱歉，评论功能暂时关闭!