swoole项目实战——实现简单聊天室

前言&＃xff1a;了解了概念之后就应该练练手啦&＃xff0c;不然就是语言的巨人&＃xff0c;行动的矮子啦

• 代码仓库

• 实战 swoole【聊天室】

• 在线体验

准备工作

• 需要先看初识 swoole【上】&＃xff0c;了解基本的服务端 WebSocket 使用

• js WebSocket 客户端简单使用

使用

# 命令行1
php src/websocket/run.php
# 命令行2
cd public && php -S localhost:8000
# 客户端&＃xff0c;多开几个查看效果
访问http://localhost:8000/

WebSocket

官方示例

$server &＃61; new swoole_websocket_server("0.0.0.0", 9501);
$server->on(&＃39;open&＃39;, function (swoole_websocket_server $server, $request) {echo "server: handshake success with fd{$request->fd}\n";});
$server->on(&＃39;message&＃39;, function (swoole_websocket_server $server, $frame) {echo "receive from {$frame->fd}:{$frame->data},opcode:{$frame->opcode},fin:{$frame->finish}\n";$server->push($frame->fd, "this is server");});
$server->on(&＃39;close&＃39;, function ($ser, $fd) {echo "client {$fd} closed\n";});
$server->on(&＃39;request&＃39;, function (swoole_http_request $request, swoole_http_response $response) {global $server;//调用外部的server// $server->connections 遍历所有websocket连接用户的fd&＃xff0c;给所有用户推送foreach ($server->connections as $fd) {$server->push($fd, $request->get[&＃39;message&＃39;]);}});
$server->start();

详解&＃xff1a;

• swoole_websocket_server 继承自 swoole_http_server

  • 设置了 onRequest 回调&＃xff0c;websocket 服务器也可以同时作为 http 服务器

  • 未设置 onRequest 回调&＃xff0c;websocket 服务器收到 http 请求后会返回 http 400 错误页面

  • 如果想通过接收 http 触发所有 websocket 的推送&＃xff0c;需要注意作用域的问题&＃xff0c;面向过程请使用 global 对 swoole_websocket_server 进行引用&＃xff0c;面向对象可以把 swoole_websocket_server 设置成一个成员属性

• function onOpen(swoole_websocket_server $svr, swoole_http_request $req);

  • 当 WebSocket 客户端与服务器建立连接并完成握手后会回调此函数。

  • $req 是一个 Http 请求对象&＃xff0c;包含了客户端发来的握手请求信息

  • onOpen 事件函数中可以调用 push 向客户端发送数据或者调用 close 关闭连接

  • onOpen 事件回调是可选的

• function onMessage(swoole_websocket_server $server, swoole_websocket_frame $frame)

  • 当服务器收到来自客户端的数据帧时会回调此函数。

  • $frame 是 swoole_websocket_frame 对象&＃xff0c;包含了客户端发来的数据帧信息

  • onMessage 回调必须被设置&＃xff0c;未设置服务器将无法启动

  • 客户端发送的 ping 帧不会触发 onMessage&＃xff0c;底层会自动回复 pong 包

• swoole_websocket_frame 属性

  • $frame->fd&＃xff0c;客户端的 socket id&＃xff0c;使用 $server->push 推送数据时需要用到

  • $frame->data&＃xff0c;数据内容&＃xff0c;可以是文本内容也可以是二进制数据&＃xff0c;可以通过 opcode 的值来判断

  • $frame->opcode&＃xff0c;WebSocket 的 OpCode 类型&＃xff0c;可以参考 WebSocket 协议标准文档

  • $frame->finish&＃xff0c; 表示数据帧是否完整&＃xff0c;一个 WebSocket 请求可能会分成多个数据帧进行发送&＃xff08;底层已经实现了自动合并数据帧&＃xff0c;现在不用担心接收到的数据帧不完整&＃xff09;

聊天室服务端示例

目录结构&＃xff1a;

• config

  • socket.php

• src

  • websocket

    • Config.php

    • run.php

    • WebSocketServer.php 内存表版本

    • WsRedisServer.php redis 版本

WebSocketServer.php 内存表版本

namespace App\WebSocket;class WebSocketServer
{private $config;private $table;private $server;public function __construct(){// 内存表 实现进程间共享数据&＃xff0c;也可以使用redis替代$this->createTable();// 实例化配置$this->config &＃61; Config::getInstance();}public function run(){$this->server &＃61; new \swoole_websocket_server($this->config[&＃39;socket&＃39;][&＃39;host&＃39;],$this->config[&＃39;socket&＃39;][&＃39;port&＃39;]);$this->server->on(&＃39;open&＃39;, [$this, &＃39;open&＃39;]);$this->server->on(&＃39;message&＃39;, [$this, &＃39;message&＃39;]);$this->server->on(&＃39;close&＃39;, [$this, &＃39;close&＃39;]);$this->server->start();}public function open(\swoole_websocket_server $server, \swoole_http_request $request){$user &＃61; [&＃39;fd&＃39; &＃61;> $request->fd,&＃39;name&＃39; &＃61;> $this->config[&＃39;socket&＃39;][&＃39;name&＃39;][array_rand($this->config[&＃39;socket&＃39;][&＃39;name&＃39;])] . $request->fd,&＃39;avatar&＃39; &＃61;> $this->config[&＃39;socket&＃39;][&＃39;avatar&＃39;][array_rand($this->config[&＃39;socket&＃39;][&＃39;avatar&＃39;])]];// 放入内存表$this->table->set($request->fd, $user);$server->push($request->fd, json_encode(array_merge([&＃39;user&＃39; &＃61;> $user], [&＃39;all&＃39; &＃61;> $this->allUser()], [&＃39;type&＃39; &＃61;> &＃39;openSuccess&＃39;])));}private function allUser(){$users &＃61; [];foreach ($this->table as $row) {$users[] &＃61; $row;}return $users;}public function message(\swoole_websocket_server $server, \swoole_websocket_frame $frame){$this->pushMessage($server, $frame->data, &＃39;message&＃39;, $frame->fd);}/*** 推送消息** &＃64;param \swoole_websocket_server $server* &＃64;param string $message* &＃64;param string $type* &＃64;param int $fd*/private function pushMessage(\swoole_websocket_server $server, string $message, string $type, int $fd){$message &＃61; htmlspecialchars($message);$datetime &＃61; date(&＃39;Y-m-d H:i:s&＃39;, time());$user &＃61; $this->table->get($fd);foreach ($this->table as $item) {// 自己不用发送if ($item[&＃39;fd&＃39;] &＃61;&＃61; $fd) {continue;}$server->push($item[&＃39;fd&＃39;], json_encode([&＃39;type&＃39; &＃61;> $type,&＃39;message&＃39; &＃61;> $message,&＃39;datetime&＃39; &＃61;> $datetime,&＃39;user&＃39; &＃61;> $user]));}}/*** 客户端关闭的时候** &＃64;param \swoole_websocket_server $server* &＃64;param int $fd*/public function close(\swoole_websocket_server $server, int $fd){$user &＃61; $this->table->get($fd);$this->pushMessage($server, "{$user[&＃39;name&＃39;]}离开聊天室", &＃39;close&＃39;, $fd);$this->table->del($fd);}/*** 创建内存表*/private function createTable(){$this->table &＃61; new \swoole_table(1024);$this->table->column(&＃39;fd&＃39;, \swoole_table::TYPE_INT);$this->table->column(&＃39;name&＃39;, \swoole_table::TYPE_STRING, 255);$this->table->column(&＃39;avatar&＃39;, \swoole_table::TYPE_STRING, 255);$this->table->create();}
}

WsRedisServer.php redis 版本

namespace App\WebSocket;use Predis\Client;/*** 使用redis代替table&＃xff0c;并存储历史聊天记录** Class WsRedisServer* &＃64;package App\WebSocket*/
class WsRedisServer
{private $config;private $server;private $client;private $key &＃61; "socket:user";public function __construct(){// 实例化配置$this->config &＃61; Config::getInstance();// redis$this->initRedis();// 初始化&＃xff0c;主要是服务端自己关闭不会清空redisforeach ($this->allUser() as $item) {$this->client->hdel("{$this->key}:{$item[&＃39;fd&＃39;]}", [&＃39;fd&＃39;, &＃39;name&＃39;, &＃39;avatar&＃39;]);}}public function run(){$this->server &＃61; new \swoole_websocket_server($this->config[&＃39;socket&＃39;][&＃39;host&＃39;],$this->config[&＃39;socket&＃39;][&＃39;port&＃39;]);$this->server->on(&＃39;open&＃39;, [$this, &＃39;open&＃39;]);$this->server->on(&＃39;message&＃39;, [$this, &＃39;message&＃39;]);$this->server->on(&＃39;close&＃39;, [$this, &＃39;close&＃39;]);$this->server->start();}public function open(\swoole_websocket_server $server, \swoole_http_request $request){$user &＃61; [&＃39;fd&＃39; &＃61;> $request->fd,&＃39;name&＃39; &＃61;> $this->config[&＃39;socket&＃39;][&＃39;name&＃39;][array_rand($this->config[&＃39;socket&＃39;][&＃39;name&＃39;])] . $request->fd,&＃39;avatar&＃39; &＃61;> $this->config[&＃39;socket&＃39;][&＃39;avatar&＃39;][array_rand($this->config[&＃39;socket&＃39;][&＃39;avatar&＃39;])]];// 放入redis$this->client->hmset("{$this->key}:{$user[&＃39;fd&＃39;]}", $user);// 给每个人推送&＃xff0c;包括自己foreach ($this->allUser() as $item) {$server->push($item[&＃39;fd&＃39;], json_encode([&＃39;user&＃39; &＃61;> $user,&＃39;all&＃39; &＃61;> $this->allUser(),&＃39;type&＃39; &＃61;> &＃39;openSuccess&＃39;]));}}private function allUser(){$users &＃61; [];$keys &＃61; $this->client->keys("{$this->key}:*");// 所有的keyforeach ($keys as $k &＃61;> $item) {$users[$k][&＃39;fd&＃39;] &＃61; $this->client->hget($item, &＃39;fd&＃39;);$users[$k][&＃39;name&＃39;] &＃61; $this->client->hget($item, &＃39;name&＃39;);$users[$k][&＃39;avatar&＃39;] &＃61; $this->client->hget($item, &＃39;avatar&＃39;);}return $users;}public function message(\swoole_websocket_server $server, \swoole_websocket_frame $frame){$this->pushMessage($server, $frame->data, &＃39;message&＃39;, $frame->fd);}/*** 推送消息** &＃64;param \swoole_websocket_server $server* &＃64;param string $message* &＃64;param string $type* &＃64;param int $fd*/private function pushMessage(\swoole_websocket_server $server, string $message, string $type, int $fd){$message &＃61; htmlspecialchars($message);$datetime &＃61; date(&＃39;Y-m-d H:i:s&＃39;, time());$user[&＃39;fd&＃39;] &＃61; $this->client->hget("{$this->key}:{$fd}", &＃39;fd&＃39;);$user[&＃39;name&＃39;] &＃61; $this->client->hget("{$this->key}:{$fd}", &＃39;name&＃39;);$user[&＃39;avatar&＃39;] &＃61; $this->client->hget("{$this->key}:{$fd}", &＃39;avatar&＃39;);foreach ($this->allUser() as $item) {// 自己不用发送if ($item[&＃39;fd&＃39;] &＃61;&＃61; $fd) {continue;}$is_push &＃61; $server->push($item[&＃39;fd&＃39;], json_encode([&＃39;type&＃39; &＃61;> $type,&＃39;message&＃39; &＃61;> $message,&＃39;datetime&＃39; &＃61;> $datetime,&＃39;user&＃39; &＃61;> $user]));// 删除失败的推送if (!$is_push) {$this->client->hdel("{$this->key}:{$item[&＃39;fd&＃39;]}", [&＃39;fd&＃39;, &＃39;name&＃39;, &＃39;avatar&＃39;]);}}}/*** 客户端关闭的时候** &＃64;param \swoole_websocket_server $server* &＃64;param int $fd*/public function close(\swoole_websocket_server $server, int $fd){$user[&＃39;fd&＃39;] &＃61; $this->client->hget("{$this->key}:{$fd}", &＃39;fd&＃39;);$user[&＃39;name&＃39;] &＃61; $this->client->hget("{$this->key}:{$fd}", &＃39;name&＃39;);$user[&＃39;avatar&＃39;] &＃61; $this->client->hget("{$this->key}:{$fd}", &＃39;avatar&＃39;);$this->pushMessage($server, "{$user[&＃39;name&＃39;]}离开聊天室", &＃39;close&＃39;, $fd);$this->client->hdel("{$this->key}:{$fd}", [&＃39;fd&＃39;, &＃39;name&＃39;, &＃39;avatar&＃39;]);}/*** 初始化redis*/private function initRedis(){$this->client &＃61; new Client([&＃39;scheme&＃39; &＃61;> $this->config[&＃39;socket&＃39;][&＃39;redis&＃39;][&＃39;scheme&＃39;],&＃39;host&＃39; &＃61;> $this->config[&＃39;socket&＃39;][&＃39;redis&＃39;][&＃39;host&＃39;],&＃39;port&＃39; &＃61;> $this->config[&＃39;socket&＃39;][&＃39;redis&＃39;][&＃39;port&＃39;],]);}
}

config.php

namespace App\WebSocket;class Config implements \ArrayAccess
{private $path;private $config;private static $instance;public function __construct(){$this->path &＃61; __DIR__ . &＃39;/../../config/&＃39;;}// 单例模式public static function getInstance(){if (!self::$instance) {self::$instance &＃61; new self();}return self::$instance;}public function offsetSet($offset, $value){// 阉割}public function offsetGet($offset){if (empty($this->config)) {$this->config[$offset] &＃61; require $this->path . $offset . ".php";}return $this->config[$offset];}public function offsetExists($offset){return isset($this->config[$offset]);}public function offsetUnset($offset){// 阉割}// 禁止克隆final private function __clone(){}
}

config/socket.php

return [&＃39;host&＃39; &＃61;> &＃39;0.0.0.0&＃39;,&＃39;port&＃39; &＃61;> 9501,&＃39;redis&＃39; &＃61;> [&＃39;scheme&＃39; &＃61;> &＃39;tcp&＃39;,&＃39;host&＃39; &＃61;> &＃39;0.0.0.0&＃39;,&＃39;port&＃39; &＃61;> 6380],&＃39;avatar&＃39; &＃61;> [&＃39;./images/avatar/1.jpg&＃39;,&＃39;./images/avatar/2.jpg&＃39;,&＃39;./images/avatar/3.jpg&＃39;,&＃39;./images/avatar/4.jpg&＃39;,&＃39;./images/avatar/5.jpg&＃39;,&＃39;./images/avatar/6.jpg&＃39;],&＃39;name&＃39; &＃61;> [&＃39;科比&＃39;,&＃39;库里&＃39;,&＃39;KD&＃39;,&＃39;KG&＃39;,&＃39;乔丹&＃39;,&＃39;邓肯&＃39;,&＃39;格林&＃39;,&＃39;汤普森&＃39;,&＃39;伊戈达拉&＃39;,&＃39;麦迪&＃39;,&＃39;艾弗森&＃39;,&＃39;卡哇伊&＃39;,&＃39;保罗&＃39;]
];

run.php

require __DIR__ . &＃39;/../bootstrap.php&＃39;;$server &＃61; new App\WebSocket\WebSocketServer();$server->run();

总结

完整示例&＃xff1a;聊天室

学完后发现生活中所谓的聊天室其实也不过如此&＃xff0c;当然这只是简单的 demo&＃xff0c;很多功能都没有实现&＃xff0c;想进一步学习的话可以去 github 上找完整的项目进行深入学习

参考

• swoole
• PHP &＃43; Swoole 实现的简单聊天室

更多学习内容可以访问【对标大厂】精品PHP架构师教程目录大全&＃xff0c;只要你能看完保证薪资上升一个台阶&＃xff08;持续更新&＃xff09;

以上内容希望帮助到大家&＃xff0c;很多PHPer在进阶的时候总会遇到一些问题和瓶颈&＃xff0c;业务代码写多了没有方向感&＃xff0c;不知道该从那里入手去提升&＃xff0c;对此我整理了一些资料&＃xff0c;包括但不限于&＃xff1a;分布式架构、高可扩展、高性能、高并发、服务器性能调优、TP6&＃xff0c;laravel&＃xff0c;YII2&＃xff0c;Redis&＃xff0c;Swoole、Swoft、Kafka、Mysql优化、shell脚本、Docker、微服务、Nginx等多个知识点高级进阶干货需要的可以免费分享给大家&＃xff0c;需要的可以加入我的PHP技术交流群953224940

进阶PHP月薪30k>>>架构师成长路线【视频、面试文档免费获取】