README

这是一个可以快速开发websocket单工通信业务的包，它必须在串行的php程序中工作，不能在协程中工作，它基于https://github.com/buexplain/netsvr 进行工作。

ps：如果你的项目是hyperf框架的，则可以使用这个包：https://github.com/buexplain/netsvr-business-coroutine

名词解释，并不准确，请见谅：

单工通信：服务器主动下发数据给客户端，但是客户端不能主动上传数据给服务端
串行的php程序：顺序执行代码的php程序，比如php-fpm内运行的项目、Laravel Octane类的常驻内存但是只能顺序执行的项目

使用步骤

下载并启动网关服务：https://github.com/buexplain/netsvr/releases ，该服务会启动：websocket服务器、worker服务器
在你的项目里面安装本包以及protobuf包：

composer require buexplain/netsvr-business-serial

composer require google/protobuf
在框架初始化阶段，初始化本包，步骤如下：
- 给容器\NetsvrBusiness\Container::class设置\Psr\Container\ContainerInterface::class接口的实例
- 给Psr\Container\ContainerInterface::class 接口的实例单例方式绑定接口：\NetsvrBusiness\Contract\ServerIdConvertInterface::class、\NetsvrBusiness\Contract\TaskSocketMangerInterface::class 的实例
完成以上步骤后，即可在你的业务代码中使用\NetsvrBusiness\NetBus::class 的静态方法与网关交互，示例：\NetsvrBusiness\NetBus::broadcast("广播给所有的网关的在线用户一条消息");

如何在框架初始化阶段，初始化本包

Laravel框架

只要在你的laravel项目安装下面这个服务提供者即可。其它框架初始化方式大同小异，不再赘述。

<?php
/**
 * Copyright 2023 buexplain@qq.com
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

declare(strict_types=1);

namespace App\Providers;

use Illuminate\Support\Facades\Log;
use Illuminate\Support\ServiceProvider;
use NetsvrBusiness\Container;
use NetsvrBusiness\Contract\ServerIdConvertInterface;
use NetsvrBusiness\Contract\TaskSocketMangerInterface;
use NetsvrBusiness\ServerIdConvert;
use NetsvrBusiness\TaskSocket;
use NetsvrBusiness\TaskSocketManger;

/**
 * composer包 buexplain/netsvr-business-serial 的初始化代码
 */
class NetBusServiceProvider extends ServiceProvider
{
    protected array $netsvrConfig = [];

    public function __construct($app)
    {
        parent::__construct($app);
        //配置信息可以放到config文件夹下，我写这里是方便阅读
        //buexplain/netsvr-business-serial支持网关分布式部署在多台机器上
        $this->netsvrConfig = [
            'netsvr' => [
                //第一个网关机器的信息
                [
                    //网关的唯一id
                    'serverId' => 0,
                    //网关的worker服务器地址
                    'host' => '127.0.0.1',
                    //网关的worker服务器监听的端口
                    'port' => 6061,
                    //最大闲置时间，单位秒，建议比netsvr网关的worker服务器的ReadDeadline配置小3秒
                    'maxIdleTime' => 117,
                ],
                //第二个网关机器信息
                [
                    'serverId' => 1,
                    'host' => '127.0.0.1',
                    'port' => 6071,
                    'maxIdleTime' => 117,
                ],
            ],
            //读写数据超时，单位秒
            'sendReceiveTimeout' => 5,
            //连接到服务端超时，单位秒
            'connectTimeout' => 5,
        ];
    }

    /**
     * Register services.
     */
    public function register(): void
    {
        //替换默认的容器
        Container::setInstance($this->app);
        //这个是将网关下发的客户唯一id转为网关唯一id的类
        //目前有默认实现是ServerIdConvert，具体实现的逻辑可以点击该类，进去看看注释，如果不符合业务需求，则需要自己实现接口ServerIdConvertInterface
        $this->app->singleton(ServerIdConvertInterface::class, function () {
            return new ServerIdConvert();
        });
        //这个是管理与网关的worker服务器连接的socket的类
        $this->app->singleton(TaskSocketMangerInterface::class, function () {
            $taskSocketManger = new TaskSocketManger();
            $logPrefix = sprintf('TaskSocket#%d', getmypid());
            foreach ($this->netsvrConfig['netsvr'] as $config) {
                $taskSocket = new TaskSocket(
                    $logPrefix,
                    Log::getLogger(),
                    $config['host'],
                    $config['port'],
                    $this->netsvrConfig['sendReceiveTimeout'],
                    $this->netsvrConfig['connectTimeout'],
                    $config['maxIdleTime']);
                $taskSocketManger->addSocket($config['serverId'], $taskSocket);
            }
            return $taskSocketManger;
        });
    }

    /**
     * Bootstrap services.
     * @return void
     */
    public function boot(): void
    {
    }
}

如何跑本包的测试用例

下载网关服务的v3.0.0版本及以上的程序包
修改配置文件netsvr.toml
- ConnOpenCustomUniqIdKey改为ConnOpenCustomUniqIdKey = "uniqId"
- ServerId改为ServerId=0
- ConnOpenWorkerId改为ConnOpenWorkerId=0
- ConnCloseWorkerId改为ConnCloseWorkerId=0
执行命令：netsvr-windows-amd64.bin -config configs/netsvr.toml启动网关服务，注意我这个命令是windows系统的，其它系统的，自己替换成对应的网关服务程序包即可
完成以上步骤后，就启动好一个网关服务了，接下来再启动一个网关服务，目的是测试本包在网关服务多机部署下的正确性
复制一份netsvr.toml为netsvr-607.toml，并改动里面的606系列端口的为607系列端口，避免端口冲突；ServerId 项改为ServerId=1，避免网关唯一id冲突
执行命令：netsvr-windows-amd64.bin -config configs/netsvr-607.toml 启动第二个网关服务，注意我这个命令是windows系统的，其它系统的，自己替换成对应的网关服务程序包即可
完成以上步骤后，两个网关服务启动完毕，算是准备好了网关这块的环境
执行本包的测试命令：composer test，等待一段时间，即可看到测试结果

buexplain / netsvr-business-serial

Maintainers

Details