当前位置:Gxlcms > PHP教程 > php中关于websocket的详细介绍

php中关于websocket的详细介绍

时间:2021-07-01 10:21:17 帮助过:33人阅读

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


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

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


  1. GET /chat HTTP/1.1Host: server.example.com
  2. Origin: http://example.com

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

一、php 中处理 websocket

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


  1. GET /chat HTTP/1.1Host: server.example.com
  2. Upgrade: websocket
  3. Connection: UpgradeSec-WebSocket-Key: dGhlIHNhbXBsZSBub25jZQ==Origin: http://example.com
  4. Sec-WebSocket-Protocol: chat, superchat
  5. Sec-WebSocket-Version: 13

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

1. socket 连接的建立

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


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

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

  1. //demo.php
  2. Class WS {
  3. var $master; // 连接 server 的 client
  4. var $sockets = array(); // 不同状态的 socket 管理
  5. var $handshake = false; // 判断是否握手
  6. function __construct($address, $port){
  7. // 建立一个 socket 套接字
  8. $this->master = socket_create(AF_INET, SOCK_STREAM, SOL_TCP)
  9. or die("socket_create() failed");
  10. socket_set_option($this->master, SOL_SOCKET, SO_REUSEADDR, 1)
  11. or die("socket_option() failed");
  12. socket_bind($this->master, $address, $port)
  13. or die("socket_bind() failed");
  14. socket_listen($this->master, 2)
  15. or die("socket_listen() failed");
  16. $this->sockets[] = $this->master;
  17. // debug
  18. echo("Master socket : ".$this->master."\n");
  19. while(true) {
  20. //自动选择来消息的 socket 如果是握手 自动选择主机
  21. $write = NULL;
  22. $except = NULL;
  23. socket_select($this->sockets, $write, $except, NULL);
  24. foreach ($this->sockets as $socket) {
  25. //连接主机的 client
  26. if ($socket == $this->master){
  27. $client = socket_accept($this->master);
  28. if ($client < 0) {
  29. // debug
  30. echo "socket_accept() failed";
  31. continue;
  32. } else {
  33. //connect($client);
  34. array_push($this->sockets, $client);
  35. echo "connect client\n";
  36. }
  37. } else {
  38. $bytes = @socket_recv($socket,$buffer,2048,0);
  39. if($bytes == 0) return;
  40. if (!$this->handshake) {
  41. // 如果没有握手,先握手回应
  42. //doHandShake($socket, $buffer);
  43. echo "shakeHands\n";
  44. } else {
  45. // 如果已经握手,直接接受数据,并处理
  46. $buffer = decode($buffer);
  47. //process($socket, $buffer);
  48. echo "send file\n";
  49. }
  50. }
  51. }
  52. }
  53. }
  54. }

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


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

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


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

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

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

2. 提取 Sec-WebSocket-Key 信息


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

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

3. 加密 Sec-WebSocket-Key


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

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

4. 应答 Sec-WebSocket-Accept


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

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

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

5. 数据帧处理


  1. // 解析数据帧
  2. function decode($buffer) {
  3. $len = $masks = $data = $decoded = null;
  4. $len = ord($buffer[1]) & 127;
  5. if ($len === 126) {
  6. $masks = substr($buffer, 4, 4);
  7. $data = substr($buffer, 8);
  8. } else if ($len === 127) {
  9. $masks = substr($buffer, 10, 4);
  10. $data = substr($buffer, 14);
  11. } else {
  12. $masks = substr($buffer, 2, 4);
  13. $data = substr($buffer, 6);
  14. } for ($index = 0; $index < strlen($data); $index++) {
  15. $decoded .= $data[$index] ^ $masks[$index % 4];
  16. } return $decoded;
  17. }

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


  1. // 返回帧信息处理
  2. function frame($s) {
  3. $a = str_split($s, 125);
  4. if (count($a) == 1) {
  5. return "\x81" . chr(strlen($a[0])) . $a[0];
  6. } $ns = ""; foreach ($a as $o) {
  7. $ns .= "\x81" . chr(strlen($o)) . $o;
  8. } return $ns;
  9. }// 返回数据
  10. function send($client, $msg){
  11. $msg = $this->frame($msg);
  12. socket_write($client, $msg, strlen($msg));
  13. }

客户端代码:


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

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

二、注意问题

1. websocket 版本问题

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


  1. GET /chat HTTP/1.1Host: server.example.com
  2. Upgrade: websocket
  3. Connection: Upgrade
  4. Origin: http://example.com
  5. Sec-WebSocket-Protocol: chat, superchatSec-WebSocket-Key1: xxxxSec-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. $key1_num = implode($key1_num[0]);
  3. $key2_num = implode($key2_num[0]);
  4. //Count spaces
  5. preg_match_all('/([ ]+)/', $key1, $key1_spc);
  6. preg_match_all('/([ ]+)/', $key2, $key2_spc);
  7. if($key1_spc==0|$key2_spc==0){ $this->log("Invalid key");
  8. return; } //Some math
  9. $key1_sec = pack("N",$key1_num / $key1_spc);
  10. $key2_sec = pack("N",$key2_num / $key2_spc);
  11. return md5($key1_sec.$key2_sec.$l8b,1);
  12. }

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


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

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

以上就是php中关于websocket的详细介绍的详细内容,更多请关注Gxl网其它相关文章!

人气教程排行