插件窝 干货文章 在ThinkPHP6中使用WebSocket

在ThinkPHP6中使用WebSocket

websocket 我们 connection 使用 207    来源:    2024-10-24

随着移动互联网技术的迅猛发展,用户对即时通讯和实时交互的需求逐渐增强。而 websocket 协议作为 web 实时通信的一个重要协议,其具有全双工通信、实时推送、低延迟等特点,已经成为实时交互场景下的首选协议。因此,在 web 开发中,我们需要掌握如何使用 websocket 实现实时通信。

在 PHP 中,我们可以使用 Swoole 扩展来实现 WebSocket 功能。然而,在 Swoole 部署和设置方面需要花费比较多的时间精力,对于一些对 Swoole 不熟悉的开发者来说,学习成本也比较高。

而今天,我们要介绍的是如何在 ThinkPHP6 中使用 WebSocket。

1. 安装扩展

在使用 ThinkPHP6 中的 WebSocket 之前,我们需要安装 topthink/thinker 扩展。

composer require topthink/thinker:dev-master

topthink/thinker 是一个命令行工具,用于在 ThinkPHP6 中运行 PHP 代码和管理异步任务。

立即学习“PHP免费学习笔记(深入)”;

2. 配置 WebSocket

我们需要在项目的配置文件 config/socket.php 中配置 WebSocket。

<?php
return [
    // WebSocket服务器地址,使用内网穿透时填写内网地址
    'server' => '127.0.0.1:9501',

    // WebSocket的应用类,需要实现     hinkworkerServer 接口
    'worker_class' => 'appcontrollerWebSocket',
];

我们需要指定 server 的地址以及实现 Server 接口的类 worker_class,在这里我们将实现 WebSocket 功能的控制器类命名为 WebSocket,放在 appcontroller 目录下。

3. 实现 WebSocket

我们在 appcontroller 目录下创建一个名为 WebSocket 的控制器,在控制器中实现 Server 接口。

<?php
namespace appcontroller;

use thinkworkerServer;

class WebSocket implements Server
{
    protected $socket = 'websocket://127.0.0.1:9501';

    public function onMessage($connection, $data)
    {
        foreach ($this->worker->connections as $conn) {
            $conn->send('user ' . $connection->id . ' said: ' . $data);
        }
    }

    public function onConnect($connection)
    {
        echo "new connection from ip " . $connection->getRemoteIp() . "
";
    }

    public function onClose($connection)
    {
        echo "connection closed: " . $connection->id . "
";
    }

    public function onWorkerStart($worker)
    {
        // 初始化
    }
}

在 WebSocket 控制器类中,我们需要实现 onMessage、onConnect、onClose 和 onWorkerStart 四个方法。

  • onMessage: 当客户端发送数据时,会触发 onMessage 方法,参数 $connection 表示客户端的连接对象,$data 表示客户端发送的数据。
  • onConnect: 在客户端连接的时候会触发 onConnect 方法,参数 $connection 表示客户端的连接对象。
  • onClose: 在客户端断开连接的时候会触发 onClose 方法,参数 $connection 表示客户端的连接对象。
  • onWorkerStart: 在工作进程启动的时候会触发 onWorkerStart 方法,参数 $worker 表示当前工作进程的对象。

4. 运行 WebSocket

配置好 WebSocket 之后,我们可以使用 think 命令来启动 WebSocket。

php think worker:start

上述命令会启动一个 WebSocket 服务,并在控制台输出运行日志。

5. 测试 WebSocket

WebSocket 实现之后,我们可以使用 WebSocket 的客户端进行测试。我们可以使用 Chrome 浏览器并安装 Simple WebSocket Client 插件来进行测试。在插件中输入 WebSocket 服务器的地址,点击连接,即可开始使用 WebSocket 通信。

在 Simple WebSocket Client 中,我们可以输入字符,并点击发送,就可以在后台控制台看到输出的日志,表示 WebSocket 通信已经可以正常工作。

总结

在本文中,我们介绍了如何在 ThinkPHP6 中使用 WebSocket。WebSocket 协议是实时通信的首选协议,其使用场景非常广泛。在实际开发中,我们可以根据需求,使用 WebSocket 轻松地实现实时通信功能,提升用户体验。