yii2-websocket | 在 yii2 下运行 WebSocket 服务 [ 技术分享 ]

yii2-websocket 是基于 yii2 实现的 WebSocket 扩展，提供 WebSocket 客户端及 WebSocket 服务端。

底层支持 swoole 及 workerman 驱动。

workerman的 fd 连接号存在问题，目前推荐使用 swoole 驱动。

为什么需要 WebSocket ？

WebSocket 是一种网络通信协议。RFC6455 定义了它的通信标准。

了解计算机网络协议的人，应该都知道：HTTP 协议是一种无状态的、无连接的、单向的应用层协议。它采用了 请求/响应 模型。通信请求只能由客户端发起，服务端对请求做出应答处理。

这种通信模型有一个弊端：HTTP 协议无法实现服务器主动向客户端发起消息。

这种单向请求的特点，注定了如果服务器有连续的状态变化，客户端要获知就非常麻烦。大多数 Web 应用程序将通过频繁的异步JavaScript和XML（AJAX）请求实现长轮询。轮询的效率低，非常浪费资源（因为必须不停连接，或者 HTTP 连接始终打开）。

因此，工程师们一直在思考，有没有更好的方法。WebSocket 就是这样发明的。WebSocket 连接允许客户端和服务器之间进行全双工通信，以便任一方都可以通过建立的连接将数据推送到另一端。WebSocket 只需要建立一次连接，就可以一直保持连接状态。这相比于轮询方式的不停建立连接显然效率要大大提高。

yii2-websocket 扩展通过底层 swoole/workerman 驱动实现 WebSocket 服务，并提供了客户端及服务端。

安装

安装此扩展程序的首选方法是通过 composer.

编辑运行

php composer.phar require --prefer-dist yiiplus/yii2-websocket "^1.0.0"

或添加配置到项目目录下的composer.json文件的 require 部分

"yiiplus/yii2-websocket": "^1.0.0"

基本使用

配置

return [
    'bootstrap' => [
        'websocket',
    ],
    'compoents' => [
        'websocket' => [
            'class' => '\yiiplus\websocket\<dirver>\WebSocket',
            'host' => '127.0.0.1',
            'port' => 9501,
            'channels' => [
                'push-message' => '\xxx\channels\PushMessageChannel', // 配置 channel 对应的执行类
            ],
      ],
    ],
];

定义 channel 执行类

每个 channel 的功能都需要定义一个单独的类，WebSocket Server 会通过客户端传来的 channel 参数解析。

例如，如果你需要为所有客户端推送一条消息，则该类可能如下所示：

namespace xxx\channels;

class PushMessageChannel extends BaseObject implements \yiiplus\websocket\ChannelInterface
{
    public function execute($fd, $data)
    {
        return [
            $fd, // 第一个参数返回客户端ID，多个以数组形式返回
            $data->message // 第二个参数返回需要返回给客户端的消息
        ];
    }

    public function close($fd)
    {
        return;
    }
}

定义好的执行类需要注册到 compoents 配置中的 channels 下。

当客户端断开连接时会触发所有 channels 下的 close 方法，用于清理客户端在服务器上与业务的绑定关系。

客户端发送 channel 消息，触发执行类

Yii::$app->websocket->send(['channel' => 'push-message', 'message' => '用户 xxx 送了一台飞机！']);

控制台执行

执行任务的确切方式取决于使用的驱动程序。 大多数驱动程序可以使用控制台命令运行，组件需要在应用程序中注册。

此命令启动一个守护进程，该守护进程维护一个 WebSocket Server，根据客户端发来的数据，处理相关 channel 的任务：

yii websocket/start

资料

• yii2-websocket 使用文档 (有关驱动程序特定控制台命令及其选项的更多详细信息，请参阅此文档)
• WebSocket 详细教程