如何在PHP中创建websockets服务器

2022-08-30 05:21:52

我正在寻找一个简单的代码来创建WebSocket服务器。我发现phpwebsockets,但它现在已经过时了,不支持最新的协议。我尝试自己更新它,但它似乎不起作用。

#!/php -q
<?php  /*  >php -q server.php  */

error_reporting(E_ALL);
set_time_limit(0);
ob_implicit_flush();

$master  = WebSocket("localhost",12345);
$sockets = array($master);
$users   = array();
$debug   = false;

while(true){
  $changed = $sockets;
  socket_select($changed,$write=NULL,$except=NULL,NULL);
  foreach($changed as $socket){
    if($socket==$master){
      $client=socket_accept($master);
      if($client<0){ console("socket_accept() failed"); continue; }
      else{ connect($client); }
    }
    else{
      $bytes = @socket_recv($socket,$buffer,2048,0);
      if($bytes==0){ disconnect($socket); }
      else{
        $user = getuserbysocket($socket);
        if(!$user->handshake){ dohandshake($user,$buffer); }
        else{ process($user,$buffer); }
      }
    }
  }
}

//---------------------------------------------------------------
function process($user,$msg){
  $action = unwrap($msg);
  say("< ".$action);
  switch($action){
    case "hello" : send($user->socket,"hello human");                       break;
    case "hi"    : send($user->socket,"zup human");                         break;
    case "name"  : send($user->socket,"my name is Multivac, silly I know"); break;
    case "age"   : send($user->socket,"I am older than time itself");       break;
    case "date"  : send($user->socket,"today is ".date("Y.m.d"));           break;
    case "time"  : send($user->socket,"server time is ".date("H:i:s"));     break;
    case "thanks": send($user->socket,"you're welcome");                    break;
    case "bye"   : send($user->socket,"bye");                               break;
    default      : send($user->socket,$action." not understood");           break;
  }
}

function send($client,$msg){
  say("> ".$msg);
  $msg = wrap($msg);
  socket_write($client,$msg,strlen($msg));
}

function WebSocket($address,$port){
  $master=socket_create(AF_INET, SOCK_STREAM, SOL_TCP)     or die("socket_create() failed");
  socket_set_option($master, SOL_SOCKET, SO_REUSEADDR, 1)  or die("socket_option() failed");
  socket_bind($master, $address, $port)                    or die("socket_bind() failed");
  socket_listen($master,20)                                or die("socket_listen() failed");
  echo "Server Started : ".date('Y-m-d H:i:s')."\n";
  echo "Master socket  : ".$master."\n";
  echo "Listening on   : ".$address." port ".$port."\n\n";
  return $master;
}

function connect($socket){
  global $sockets,$users;
  $user = new User();
  $user->id = uniqid();
  $user->socket = $socket;
  array_push($users,$user);
  array_push($sockets,$socket);
  console($socket." CONNECTED!");
}

function disconnect($socket){
  global $sockets,$users;
  $found=null;
  $n=count($users);
  for($i=0;$i<$n;$i++){
    if($users[$i]->socket==$socket){ $found=$i; break; }
  }
  if(!is_null($found)){ array_splice($users,$found,1); }
  $index = array_search($socket,$sockets);
  socket_close($socket);
  console($socket." DISCONNECTED!");
  if($index>=0){ array_splice($sockets,$index,1); }
}

function dohandshake($user,$buffer){
  console("\nRequesting handshake...");
  console($buffer);
  //list($resource,$host,$origin,$strkey1,$strkey2,$data) 
  list($resource,$host,$u,$c,$key,$protocol,$version,$origin,$data) = getheaders($buffer);
  console("Handshaking...");

    $acceptkey = base64_encode(sha1($key . "258EAFA5-E914-47DA-95CA-C5AB0DC85B11",true));
  $upgrade  = "HTTP/1.1 101 Switching Protocols\r\nUpgrade: websocket\r\nConnection: Upgrade\r\nSec-WebSocket-Accept: $acceptkey\r\n";

  socket_write($user->socket,$upgrade,strlen($upgrade));
  $user->handshake=true;
  console($upgrade);
  console("Done handshaking...");
  return true;
}

function getheaders($req){
    $r=$h=$u=$c=$key=$protocol=$version=$o=$data=null;
    if(preg_match("/GET (.*) HTTP/"   ,$req,$match)){ $r=$match[1]; }
    if(preg_match("/Host: (.*)\r\n/"  ,$req,$match)){ $h=$match[1]; }
    if(preg_match("/Upgrade: (.*)\r\n/",$req,$match)){ $u=$match[1]; }
    if(preg_match("/Connection: (.*)\r\n/",$req,$match)){ $c=$match[1]; }
    if(preg_match("/Sec-WebSocket-Key: (.*)\r\n/",$req,$match)){ $key=$match[1]; }
    if(preg_match("/Sec-WebSocket-Protocol: (.*)\r\n/",$req,$match)){ $protocol=$match[1]; }
    if(preg_match("/Sec-WebSocket-Version: (.*)\r\n/",$req,$match)){ $version=$match[1]; }
    if(preg_match("/Origin: (.*)\r\n/",$req,$match)){ $o=$match[1]; }
    if(preg_match("/\r\n(.*?)\$/",$req,$match)){ $data=$match[1]; }
    return array($r,$h,$u,$c,$key,$protocol,$version,$o,$data);
}

function getuserbysocket($socket){
  global $users;
  $found=null;
  foreach($users as $user){
    if($user->socket==$socket){ $found=$user; break; }
  }
  return $found;
}

function     say($msg=""){ echo $msg."\n"; }
function    wrap($msg=""){ return chr(0).$msg.chr(255); }
function  unwrap($msg=""){ return substr($msg,1,strlen($msg)-2); }
function console($msg=""){ global $debug; if($debug){ echo $msg."\n"; } }

class User{
  var $id;
  var $socket;
  var $handshake;
}

?>

和客户端:

var connection = new WebSocket('ws://localhost:12345');
connection.onopen = function () {
  connection.send('Ping'); // Send the message 'Ping' to the server
};

// Log errors
connection.onerror = function (error) {
  console.log('WebSocket Error ' + error);
};

// Log messages from the server
connection.onmessage = function (e) {
  console.log('Server: ' + e.data);
};

如果我的代码中有任何错误,你能帮我修复它吗?火狐中的控制台 说:

Firefox 无法在 ws://localhost:12345/ 建立与服务器的连接。


答案 1

我最近和你在同一条船上,以下是我所做的:

  1. 我使用phpwebsockets代码作为如何构建服务器端代码的参考。(您似乎已经在这样做,正如您所指出的,由于各种原因,代码实际上不起作用。

  2. 我使用 PHP.net 来阅读有关phpwebsockets代码中使用的每个套接字函数的详细信息。通过这样做,我终于能够理解整个系统在概念上是如何工作的。这是一个相当大的障碍。

  3. 我读了实际的WebSocket草稿。我不得不把这个东西读了好几遍,才终于开始沉浸其中。在整个过程中,您可能必须一次又一次地返回本文档,因为它是一个具有有关WebSocket API的正确,最新信息的权威资源。

  4. 我根据#3中草案中的说明编写了正确的握手程序。这还不错。

  5. 握手后,我不断收到一堆从客户端发送到服务器的乱码文本,直到我意识到数据被编码并且必须被揭开,我才弄清楚为什么。以下链接在这里帮助了我很多:(原始链接断开存档副本

    请注意,此链接中提供的代码存在许多问题,如果不进行进一步修改,将无法正常工作。

  6. 然后,我遇到了以下SO线程,它清楚地解释了如何正确编码和解码来回发送的消息:如何在服务器端发送和接收WebSocket消息?

    这个链接真的很有帮助。我建议在查看WebSocket草案时咨询它。这将有助于从草案所说的内容中更有意义。

  7. 在这一点上,我几乎完成了,但是我使用WebSocket制作的WebRTC应用程序遇到了一些问题,所以我最终在SO上提出了自己的问题,我最终解决了这个问题:WebRTC候选人信息末尾的数据是什么?

  8. 在这一点上,我几乎让一切都在工作。我只需要添加一些额外的逻辑来处理连接的关闭,我就完成了。

这个过程总共花了我大约两周的时间。好消息是,我现在非常了解WebSocket,并且能够从头开始制作自己的客户端和服务器脚本,这些脚本效果很好。希望所有这些信息的高潮将为您提供足够的指导和信息来编写您自己的WebSocket PHP脚本。

祝你好运!


编辑:这个编辑比我最初的答案晚了几年,虽然我仍然有一个有效的解决方案,但它还没有真正准备好分享。幸运的是,GitHub上的其他人有几乎与我的代码相同的代码(但更干净),所以我建议使用以下代码来使用PHP WebSocket解决方案:
https://github.com/ghedipunk/PHP-Websockets/blob/master/websockets.php


编辑#2:虽然我仍然喜欢使用PHP来处理许多与服务器端相关的事情,但我不得不承认,我最近真的对Node.js热身,主要原因是因为它从头开始设计得比PHP(或任何其他服务器端语言)更好地处理WebSocket。因此,我最近发现,在服务器上设置Apache / PHP和Node.js并使用Node.js来运行WebSocket服务器并使用Apache / PHP来运行其他所有内容要容易得多。如果您位于共享托管环境中,无法安装/使用WebSocket的Node.js,则可以使用像Heroku这样的免费服务来设置Node.js WebSocket服务器,并从您的服务器向它发出跨域请求。只要确保这样做是为了设置WebSocket服务器,以便能够处理跨域请求。


答案 2

据我所知,Ratchet是目前最好的PHP WebSocket解决方案。由于它是开源的,你可以看到作者如何使用PHP构建这个WebSocket解决方案。