php使用websocket示例详解_php实例

下面我画了一个图演示 client 和 server 之间建立 websocket 连接时握手部分，这个部分在 node 中可以十分轻松的完成，因为 node 提供的 net 模块已经对 socket 套接字做了封装处理，开发者使用的时候只需要考虑数据的交互而不用处理连接的建立。而 php 没有，从 socket 的连接、建立、绑定、监听等，这些都需要我们自己去操作，所以有必要拿出来再说一说。

① 和 ② 实际上就是一个 HTTP 的请求和响应，只不过我们在处理的过程中我们拿到的是没有经过解析的字符串。如：

GET /chat HTTP/1.1<BR>Host: server.example.com<BR>Origin: http://www.php.com<BR>

我们往常看到的请求是这个样子，当这东西到了服务器端，我们可以通过一些代码库直接拿到这些信息。

一、php 中处理 websocket

WebSocket 连接是由客户端主动发起的，所以一切要从客户端出发。第一步是要解析拿到客户端发过来的 Sec-WebSocket-Key 字符串。

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

client 请求的格式

首先 php 建立一个 socket 连接，监听端口的信息。

1. socket 连接的建立

关于 socket 套接字的建立，相信很多大学修过计算机网络的人都知道了，下面是一张连接建立的过程：

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

相比 node，这个地方的处理实在是太麻烦了，上面几行代码并未建立连接，只不过这些代码是建立一个 socket 套接字必须要写的东西。由于处理过程稍微有复杂，所以我把各种处理写进了一个类中，方便管理和调用。

//demo.php<BR>Class WS {<BR>    var $master;  // 连接 server 的 client<BR>    var $sockets = array(); // 不同状态的 socket 管理<BR>    var $handshake = false; // 判断是否握手</P><P>    function __construct($address, $port){<BR>        // 建立一个 socket 套接字<BR>        $this->master = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)   <BR>            or die("socket_create() failed");<BR>        socket_set_option($this->master, SOL_SOCKET, SO_REUSEADDR, 1)  <BR>            or die("socket_option() failed");<BR>        socket_bind($this->master, $address, $port)                    <BR>            or die("socket_bind() failed");<BR>        socket_listen($this->master, 2)                               <BR>            or die("socket_listen() failed");</P><P>        $this->sockets[] = $this->master;</P><P>        // debug<BR>        echo("Master socket  : ".$this->master."\n");</P><P>        while(true) {<BR>            //自动选择来消息的 socket 如果是握手 自动选择主机<BR>            $write = NULL;<BR>            $except = NULL;<BR>            socket_select($this->sockets, $write, $except, NULL);</P><P>            foreach ($this->sockets as $socket) {<BR>                //连接主机的 client <BR>                if ($socket == $this->master){<BR>                    $client = socket_accept($this->master);<BR>                    if ($client < 0) {<BR>                        // debug<BR>                        echo "socket_accept() failed";<BR>                        continue;<BR>                    } else {<BR>                        //connect($client);<BR>                        array_push($this->sockets, $client);<BR>                        echo "connect client\n";<BR>                    }<BR>                } else {<BR>                    $bytes = @socket_recv($socket,$buffer,2048,0);<BR>                    if($bytes == 0) return;<BR>                    if (!$this->handshake) {<BR>                        // 如果没有握手，先握手回应<BR>                        //doHandShake($socket, $buffer);<BR>                        echo "shakeHands\n";<BR>                    } else {<BR>                        // 如果已经握手，直接接受数据，并处理<BR>                        $buffer = decode($buffer);<BR>                        //process($socket, $buffer); <BR>                        echo "send file\n";<BR>                    }<BR>                }<BR>            }<BR>        }<BR>    }<BR>}<BR>

上面这段代码是经过我调试了的，没太大的问题，如果想测试的话，可以在 cmd 命令行中键入 php /path/to/demo.php;当然，上面只是一个类，如果要测试的话，还得新建一个实例。

$ws = new WS('localhost', 4000);<BR>

客户端代码可以稍微简单点：

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

运行服务器代码，当客户端连接的时候，我们可以看到：

2. 提取 Sec-WebSocket-Key 信息

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

这里比较简单，直接正则匹配，websocket 信息头一定包含 Sec-WebSocket-Key，所以我们匹配起来也比较快捷~

3. 加密 Sec-WebSocket-Key

function encry($req){<BR>    $key = $this->getKey($req);<BR>    $mask = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11";</P><P>    return base64_encode(sha1($key . '258EAFA5-E914-47DA-95CA-C5AB0DC85B11', true));<BR>}<BR>

将 SHA-1 加密后的字符串再进行一次 base64 加密。如果加密算法错误，客户端在进行校检的时候会直接报错：

4. 应答 Sec-WebSocket-Accept

function dohandshake($socket, $req){<BR>    // 获取加密key<BR>    $acceptKey = $this->encry($req);<BR>    $upgrade = "HTTP/1.1 101 Switching Protocols\r\n" .<BR>               "Upgrade: websocket\r\n" .<BR>               "Connection: Upgrade\r\n" .<BR>               "Sec-WebSocket-Accept: " . $acceptKey . "\r\n" .<BR>               "\r\n";</P><P>    // 写入socket<BR>    socket_write(socket,$upgrade.chr(0), strlen($upgrade.chr(0)));<BR>    // 标记握手已经成功，下次接受数据采用数据帧格式<BR>    $this->handshake = true;<BR>}<BR>

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

当客户端成功校检key后，会触发 onopen 函数：

5. 数据帧处理

// 解析数据帧<BR>function decode($buffer)  {<BR>    $len = $masks = $data = $decoded = null;<BR>    $len = ord($buffer[1]) & 127;</P><P>    if ($len === 126)  {<BR>        $masks = substr($buffer, 4, 4);<BR>        $data = substr($buffer, 8);<BR>    } else if ($len === 127)  {<BR>        $masks = substr($buffer, 10, 4);<BR>        $data = substr($buffer, 14);<BR>    } else  {<BR>        $masks = substr($buffer, 2, 4);<BR>        $data = substr($buffer, 6);<BR>    }<BR>    for ($index = 0; $index < strlen($data); $index++) {<BR>        $decoded .= $data[$index] ^ $masks[$index % 4];<BR>    }<BR>    return $decoded;<BR>}<BR>

这里涉及的编码问题在前文中已经提到过了，这里就不赘述，php 对字符处理的函数太多了，也记得不是特别清楚，这里就没有详细的介绍解码程序，直接把客户端发送的数据原样返回，可以算是一个聊天室的模式吧。

// 返回帧信息处理<BR>function frame($s) {<BR>    $a = str_split($s, 125);<BR>    if (count($a) == 1) {<BR>        return "\x81" . chr(strlen($a[0])) . $a[0];<BR>    }<BR>    $ns = "";<BR>    foreach ($a as $o) {<BR>        $ns .= "\x81" . chr(strlen($o)) . $o;<BR>    }<BR>    return $ns;<BR>}</P><P>// 返回数据<BR>function send($client, $msg){<BR>    $msg = $this->frame($msg);<BR>    socket_write($client, $msg, strlen($msg));<BR>}<BR>

客户端代码：

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

在连通之后发送数据，服务器原样返回：

二、注意问题

1. websocket 版本问题

客户端在握手时的请求中有Sec-WebSocket-Version: 13，这样的版本标识，这个是一个升级版本，现在的浏览器都是使用的这个版本。而以前的版￥本文来%源[email protected]搞@^&代*@码)网5搞gaodaima代码本在数据加密的部分更加麻烦，它会发送两个key：

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

如果是这种版本（比较老，已经没在使用了），需要通过下面的方式获取

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

只能无限吐槽这种验证方式！相比 nodeJs 的 websocket 操作方式：

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

2. 数据帧解析代码

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

喜欢 (0)赏

[搞代码]

分享 (0)