本文同步自我的博客园:http://hustskyking.cnblogs.com
下面我画了一个图演示 client 和 server 之间竖立 websocket 衔接时握手部份,这个部份在 node 中能够非常轻松的完成,因为 node 供应的 net 模块已对 socket 套接字做了封装处置惩罚,开发者运用的时刻只须要斟酌数据的交互而不必处置惩罚衔接的竖立。而 php 没有,从 socket 的衔接、竖立、绑定、监听等,这些都须要我们本身去操纵,所以有必要拿出来再说一说。
+--------+ ① 发送Sec-WebSocket-Key +--------+
| | --------------------------------> | |
| | ② 加密返回Sec-WebSocket-Accept | |
| client | <-------------------------------- | server |
| | ③ 当地校验 | |
| | --------------------------------> | |
+--------+ +--------+
看了我写的上一篇文章的同砚应该是对上图有了比较周全的明白。① 和 ② 实际上就是一个 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";
}
}
}
}
}
}
上面这段代码是经由我调试了的,没太大的题目,假如想测试的话,能够在 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. 相干开源库参考
http://socketo.me Ratchet 为 php 封装的一个 WebSockets 库。
Google 上搜刮 php+websoket+class,也能找到不少相干的材料。
三、参考材料
- http://www.php.net/manual/zh/ref.sockets.php php manual
- http://www.rfc-editor.org/rfc/rfc6455.txt RFC6455 WebSocket