php使用websocket示例详解

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

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

复制代码 代码如下:

get /chat http/1.1

host: rver.example.com

origin: http://www.jb51.com

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

一、php 中处理 websocket

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

复制代码 代码如下:

get /chat http/1.1

host: rver.example.com

upgrade: websocket

connection: upgrade

c-websocket-key: dghlihnhbxbszsbub25jzq==

origin: http://www.jb51.com

c-websocket-protocol: chat, superchat

c-websoc冰心散文集ket-version: 13

client 请求的格式

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

1. socket 连接的建立

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

复制代码p2pover 代码如下:

// 建立一个 socket 套接字

$master = socket_create(af_inet, sock_stream, sol_tcp);

socket_t_option($master, sol_socket, so_reuaddr, 1);

socket_bind($master, $address, $port);

socket_listen($master);

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

复制代码 代码如下:

//demo.php

class ws {

var $master; // 连接 rver 的 client

var $sockets = array(); // 不同状态的 socket 管理

var $handshake = fal; // 判断是否握手

function __construct($address, $port){
// 建立一个 socket 套接字
$this->master = socket_create(af_inet, sock_stream, sol_tcp)
or die(“socket_create() failed”);
socket_t_option($this->master, sol_socket, so_reuaddr, 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 如果是握手 自动选择主机
$wri三八妇女节的佳句te = null;
$except = null;
socket_lect($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;
} el {
//connect($client);
array_push($this->sockets, $client);
echo “connect client\n”;
}
} el {
$bytes = @socket_recv($socket,$buffer,2048,0);
if($bytes == 0) return;
if (!$this->handshake) {
// 如果没有握手，先握手回应
//dohandshake($socket, $buffer);
echo “shakehands\n”;
} el {
// 如果已经握手，直接接受数据，并处理
$buffer = decode($buffer);
//process($socket, $buffer);
echo “nd file\n”;
}
}
}
}
}
}

上面这段代码是经过我调试了的，没太大的问题，如果想测试的话，可以在 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”);

};

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

2. 提取 c-websocket-key 信息

复制代码 代码如下:

function getkey($req) {

$key = null;

if (preg_match(“/c-websocket-key: (.*)\r\n/”, $req, $match)) {

$key = $match[1];

}

return $key;

}

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

3. 加密 c-websocket-key

复制代码 代码如下:

function encry($req){

$key = $this->getkey($req);

$mask = “258eafa5-e914-47da-95ca-c5ab0dc85b11”;

return ba64_encode(sha1($key . ‘258eafa5-e914-47da-95ca-c5ab0dc85b11’, true));
}

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

4. 应答 c-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” .

“c-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);
} el if ($len === 127) {
$masks = substr($buffer, 10, 4);
$data = substr($buffer, 14);
} el {
$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 nd($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.nd(“李靖”);

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

二、注意问题

1. websocket 版本问题

客户端在握手时的请求中有c-websocket-version: 13，这样的版本标识，这个是一个升级版本，现在的浏览器都是长安乱经典语录使用的这个版本。而以前的版本在数据加密的部分更加麻烦，它会发送两个key：

复制代码 代码如下:

get /chat http/1.1

host: rver.example.com

upgrade: websocket

connection: upgrade

origin: //www.jb51.net

c-websocket-protocol: chat, superchat

c-websocket-key1: xxxx

c-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_c = pack(“n”,$key1_num / $key1_spc);
$key2_c = pack(“n”,$key2_num / $key2_spc);

return md5($key1_c.$key2_c.$l8b,1);
}

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

复制代码 代码如下:

//服务器程序

var crypto = require(‘crypto’);

var ws = ‘258eafa5-e914-47da-95ca-c5ab0dc85b11’;

require(‘net’).createrver(function(o){

var key;

o.on(‘data’,function(e){

if(!key){

//握手

key = e.tostring().match(/c-websocket-key: (.+)/)[1];

key = crypto.createhash(‘sha1’).update(key + ws).digest(‘ba64’);

o.write(‘http/1.1 101 switching protocols\r\n’);

o.write(‘upgrade: websocket\r\n’);

o.write(‘connection: upgrade\r\n’);

o.write(‘c-websocket-accept: ‘ + key + ‘\r\n’);

o.write(‘\r\n’);

}el{

console.log(e);

};

});

}).listen(8000);

2. 数据帧解析代码

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