当前位置:首页 > PHP教程 > php高级应用 > 列表

php篇之细说websocket

发布:smiling 来源: PHP粉丝网  添加日期:2022-06-30 09:27:22 浏览: 评论:0 

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

  1. +--------+    1.发送Sec-WebSocket-Key        +---------+ 
  2.  
  3. |        | --------------------------------> |        | 
  4.  
  5. |        |    2.加密返回Sec-WebSocket-Accept  |        | 
  6.  
  7. | client | <-------------------------------- | server | 
  8.  
  9. |        |    3.本地校验                      |        | 
  10.  
  11. |        | --------------------------------> |        | 
  12.  
  13. +--------+                                   +--------+ 

看了我写的上一篇文章的同学应该是对上图有了比较全面的理解。① 和 ② 实际上就是一个 HTTP 的请求和响应,只不过我们在处理的过程中我们拿到的是没有经过解析的字符串。如:

GET /chat HTTP/1.1

Host: server.example.com

Origin: http://example.com

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

一、php 中处理 websocket

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

  1. GET /chat HTTP/1.1 
  2.  
  3. Host: server.example.com 
  4.  
  5. Upgrade: websocket 
  6.  
  7. Connection: Upgrade 
  8.  
  9. Sec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ== 
  10.  
  11. Origin: http://example.com 
  12.  
  13. Sec-WebSocket-Protocol: chat, superchat 
  14.  
  15. Sec-WebSocket-Version: 13 

前文中也提到了 client 请求的格式(如上),首先 php 建立一个 socket 连接,监听端口的信息。

1. socket 连接的建立

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

php篇之细说websocket

  1. // 建立一个 socket 套接字 
  2.  
  3. $master = socket_create(AF_INET, SOCK_STREAM, SOL_TCP); 
  4.  
  5. socket_set_option($master, SOL_SOCKET, SO_REUSEADDR, 1); 
  6.  
  7. socket_bind($master$address$port); 
  8.  
  9. socket_listen($master); 

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

  1. //demo.php 
  2.  
  3. Class WS { 
  4.  
  5.     var $master;  // 连接 server 的 client 
  6.  
  7.     var $sockets = array(); // 不同状态的 socket 管理 
  8.  
  9.     var $handshake = false; // 判断是否握手 
  10.  
  11.  
  12.  
  13.     function __construct($address$port){ 
  14.  
  15.         // 建立一个 socket 套接字 
  16.  
  17.         $this->master = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)    
  18.  
  19.             or die("socket_create() failed"); 
  20.  
  21.         socket_set_option($this->master, SOL_SOCKET, SO_REUSEADDR, 1)   
  22.  
  23.             or die("socket_option() failed"); 
  24.  
  25.         socket_bind($this->master, $address$port)                     
  26.  
  27.             or die("socket_bind() failed"); 
  28.  
  29.         socket_listen($this->master, 2)                                
  30.  
  31.             or die("socket_listen() failed"); 
  32.  
  33.  
  34.  
  35.         $this->sockets[] = $this->master; 
  36.  
  37.  
  38.  
  39.         // debug 
  40.  
  41.         echo("Master socket  : ".$this->master."\n"); 
  42.  
  43.  
  44.  
  45.         while(true) { 
  46.  
  47.             //自动选择来消息的 socket 如果是握手 自动选择主机 
  48.  
  49.             $write = NULL; 
  50.  
  51.             $except = NULL; 
  52.  
  53.             socket_select($this->sockets, $write$except, NULL); 
  54.  
  55.  
  56.  
  57.             foreach ($this->sockets as $socket) { 
  58.  
  59.                 //连接主机的 client  
  60.  
  61.                 if ($socket == $this->master){ 
  62.  
  63.                     $client = socket_accept($this->master); 
  64.  
  65.                     if ($client < 0) { 
  66.  
  67.                         // debug 
  68.  
  69.                         echo "socket_accept() failed"
  70.  
  71.                         continue
  72.  
  73.                     } else { 
  74.  
  75.                         //connect($client); 
  76.  
  77.                         array_push($this->sockets, $client); 
  78.  
  79.                         echo "connect client\n"
  80.  
  81.                     } 
  82.  
  83.                 } else { 
  84.  
  85.                     $bytes = @socket_recv($socket,$buffer,2048,0); 
  86.  
  87.                     if($bytes == 0) return
  88.  
  89.                     if (!$this->handshake) { 
  90.  
  91.                         // 如果没有握手,先握手回应 
  92.  
  93.                         //doHandShake($socket, $buffer); 
  94.  
  95.                         echo "shakeHands\n"
  96.  
  97.                     } else { 
  98.  
  99.                         // 如果已经握手,直接接受数据,并处理 
  100.  
  101.                         $buffer = decode($buffer); 
  102.  
  103.                         //process($socket, $buffer);  
  104.  
  105.                         echo "send file\n"
  106.  
  107.                     } 
  108.  
  109.                 } 
  110.  
  111.             } 
  112.  
  113.         } 
  114.  
  115.     } 
  116.  

demo.php 握手连接测试代码

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

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

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

  1. var ws = new WebSocket("ws://localhost:4000"); 
  2.  
  3. ws.onopen = function(){ 
  4.  
  5.     console.log("握手成功"); 
  6.  
  7. }; 
  8.  
  9. ws.onerror = function(){ 
  10.  
  11.     console.log("error"); 
  12.  
  13. }; 

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

php篇之细说websocket

通过上面的代码可以清晰的看到整个交流的过程。首先是建立连接,node 中这一步已经封装到了 net 和 http 模块,然后判断是否握手,如果没有的话,就 shakeHands。这里的握手我直接就 echo 了一个单词,表示进行了这个东西,前文我们提到过握手算法,这里就直接写了。

2. 提取 Sec-WebSocket-Key 信息

  1. function getKey($req) { 
  2.  
  3.     $key = null; 
  4.  
  5.     if (preg_match("/Sec-WebSocket-Key: (.*)\r\n/"$req$match)) {  
  6.  
  7.         $key = $match[1];  
  8.  
  9.     } 
  10.  
  11.     return $key
  12.  

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

3. 加密 Sec-WebSocket-Key

  1. function encry($req){ 
  2.  
  3.     $key = $this->getKey($req); 
  4.  
  5.     $mask = "258EAFA5-E914-47DA-95CA-C5AB0DC85B11"
  6.  
  7.  
  8.  
  9.     return base64_encode(sha1($key . '258EAFA5-E914-47DA-95CA-C5AB0DC85B11', true)); 
  10.  

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

php篇之细说websocket

4. 应答 Sec-WebSocket-Accept

  1. function dohandshake($socket$req){ 
  2.  
  3.     // 获取加密key 
  4.  
  5.     $acceptKey = $this->encry($req); 
  6.  
  7.     $upgrade = "HTTP/1.1 101 Switching Protocols\r\n" . 
  8.  
  9.                "Upgrade: websocket\r\n" . 
  10.  
  11.                "Connection: Upgrade\r\n" . 
  12.  
  13.                "Sec-WebSocket-Accept: " . $acceptKey . "\r\n" . 
  14.  
  15.                "\r\n"
  16.  
  17.  
  18.  
  19.     // 写入socket 
  20.  
  21.     socket_write(socket,$upgrade.chr(0), strlen($upgrade.chr(0))); 
  22.  
  23.     // 标记握手已经成功,下次接受数据采用数据帧格式 
  24.  
  25.     $this->handshake = true; 
  26.  

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

php篇之细说websocket

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

php篇之细说websocket

5. 数据帧处理

  1. // 解析数据帧 
  2.  
  3. function decode($buffer)  { 
  4.  
  5.     $len = $masks = $data = $decoded = null; 
  6.  
  7.     $len = ord($buffer[1]) & 127; 
  8.  
  9.  
  10.  
  11.     if ($len === 126)  { 
  12.  
  13.         $masks = substr($buffer, 4, 4); 
  14.  
  15.         $data = substr($buffer, 8); 
  16.  
  17.     } else if ($len === 127)  { 
  18.  
  19.         $masks = substr($buffer, 10, 4); 
  20.  
  21.         $data = substr($buffer, 14); 
  22.  
  23.     } else  { 
  24.  
  25.         $masks = substr($buffer, 2, 4); 
  26.  
  27.         $data = substr($buffer, 6); 
  28.  
  29.     } 
  30.  
  31.     for ($index = 0; $index < strlen($data); $index++) { 
  32.  
  33.         $decoded .= $data[$index] ^ $masks[$index % 4]; 
  34.  
  35.     } 
  36.  
  37.     return $decoded
  38.  

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

  1. // 返回帧信息处理 
  2.  
  3. function frame($s) { 
  4.  
  5.     $a = str_split($s, 125); 
  6.  
  7.     if (count($a) == 1) { 
  8.  
  9.         return "\x81" . chr(strlen($a[0])) . $a[0]; 
  10.  
  11.     } 
  12.  
  13.     $ns = ""
  14.  
  15.     foreach ($a as $o) { 
  16.  
  17.         $ns .= "\x81" . chr(strlen($o)) . $o
  18.  
  19.     } 
  20.  
  21.     return $ns
  22.  
  23.  
  24.  
  25.  
  26. // 返回数据 
  27.  
  28. function send($client$msg){ 
  29.  
  30.     $msg = $this->frame($msg); 
  31.  
  32.     socket_write($client$msgstrlen($msg)); 
  33.  

客户端代码:

  1. var ws = new WebSocket("ws://localhost:4000"); 
  2.  
  3. ws.onopen = function(){ 
  4.  
  5.     console.log("握手成功"); 
  6.  
  7. }; 
  8.  
  9. ws.onmessage = function(e){ 
  10.  
  11.     console.log("message:" + e.data); 
  12.  
  13. }; 
  14.  
  15. ws.onerror = function(){ 
  16.  
  17.     console.log("error"); 
  18.  
  19. }; 
  20.  
  21. ws.send("李靖"); 

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

php篇之细说websocket

二、注意问题

1. websocket 版本问题

客户端在握手时的请求中有Sec-WebSocket-Version: 13,这样的版本标识,这个是一个升级版本,现在的浏览器都是使用的这个版本。而以前的版本在数据加密的部分更加麻烦,它会发送两个key:

  1. GET /chat HTTP/1.1 
  2.  
  3. Host: server.example.com 
  4.  
  5. Upgrade: websocket 
  6.  
  7. Connection: Upgrade 
  8.  
  9. Origin: http://example.com 
  10.  
  11. Sec-WebSocket-Protocol: chat, superchat 
  12.  
  13. Sec-WebSocket-Key1: xxxx 
  14.  
  15. Sec-WebSocket-Key2: xxxx 

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

  1. function encry($key1,$key2,$l8b){ //Get the numbers preg_match_all('/([\d]+)/', $key1, $key1_num); preg_match_all('/([\d]+)/', $key2, $key2_num); 
  2.  
  3.  
  4.  
  5.     $key1_num = implode($key1_num[0]); 
  6.  
  7.     $key2_num = implode($key2_num[0]); 
  8.  
  9.     //Count spaces 
  10.  
  11.     preg_match_all('/([ ]+)/'$key1$key1_spc); 
  12.  
  13.     preg_match_all('/([ ]+)/'$key2$key2_spc); 
  14.  
  15.  
  16.  
  17.     if($key1_spc==0|$key2_spc==0){ $this->log("Invalid key");return; } 
  18.  
  19.     //Some math 
  20.  
  21.     $key1_sec = pack("N",$key1_num / $key1_spc); 
  22.  
  23.     $key2_sec = pack("N",$key2_num / $key2_spc); 
  24.  
  25.  
  26.  
  27.     return md5($key1_sec.$key2_sec.$l8b,1); 
  28.  

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

  1. //服务器程序 
  2.  
  3. var crypto = require('crypto'); 
  4.  
  5. var WS = '258EAFA5-E914-47DA-95CA-C5AB0DC85B11'
  6.  
  7. require('net').createServer(function(o){ 
  8.  
  9.     var key; 
  10.  
  11.     o.on('data',function(e){ 
  12.  
  13.         if(!key){ 
  14.  
  15.             //握手 
  16.  
  17.             key = e.toString().match(/Sec-WebSocket-Key: (.+)/)[1]; 
  18.  
  19.             key = crypto.createHash('sha1').update(key + WS).digest('base64'); 
  20.  
  21.             o.write('HTTP/1.1 101 Switching Protocols\r\n'); 
  22.  
  23.             o.write('Upgrade: websocket\r\n'); 
  24.  
  25.             o.write('Connection: Upgrade\r\n'); 
  26.  
  27.             o.write('Sec-WebSocket-Accept: ' + key + '\r\n'); 
  28.  
  29.             o.write('\r\n'); 
  30.  
  31.         }else
  32.  
  33.             console.log(e); 
  34.  
  35.         }; 
  36.  
  37.     }); 
  38.  
  39. }).listen(8000); 

多么简洁,多么方便!有谁还愿意使用 php 呢。。。。

2. 数据帧解析代码

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

3. 代码下载

对这部分感兴趣的同学,可以再去深究。提供了参考代码下载。

4. 相关开源库参考

socketo.me Ratchet 为 php 封装的一个 WebSockets 库。 ]

Google 上搜索 php+websoket+class,也能找到不少相关的资料。

三、参考资料

www.php.net/manual/zh/r… php manual

www.rfc-editor.org/rfc/rfc6455… [RFC6455] WebSocket

Tags: websocket

分享到: