WebSocket 入坑记

为了在小程序中实现即时消息的提示，决定入坑WebSocket

1. 小程序uni-app
2. 后端Thnikphp

#01. 安装Workerman 和topthink/think-worker

Workerman是一个纯PHP的实现，因此基本上不需要特殊的安装，你只需要通过composer直接安装即可。

ThinkPHP 5.1 Workerman 快速上手指南 · ThinkPHP5.1 Workerman上手指南 · 看云 (kancloud.cn)

// 安装`Workerman`
composer require workerman/workerman

// 安装`think-worker`扩展，如果你还没有安装`Workerman` 的话，安装扩展同时会自动安装
composer require topthink/think-worker
// 安装完成后会在tp 的`config`目录下生成`gateway_worker.php`，`worker.php`，`worker_server.php` 三个配置文件

#02. 启动Workerman 服务

1. Workerman HTTP 服务(略)

php think worker

2. Workerman Server 服务(本文主要使用WebSocket)

关于WebSocket 详细的说明：python - WebSocket 通信过程与实现 - Geek情怀 - SegmentFault 思否

php think worker:server

#03. worker_server.php 配置

worker_server.php 配置说明：Workerman · ThinkPHP6.0完全开发手册 · 看云 (kancloud.cn)

#04. 自定义服务类

自定义服务类必须继承think\worker\Server类，支持workerman所有的回调方法定义（回调方法必须是public类型）。

#04.01 worker_server.php 配置参数

return [
    'worker_class'  =>  'app\http\Worker',
];

#04.02 自定义服务类

<?php
namespace app\http;

use think\facade\Env;
use think\worker\Server;

class Worker extends Server
{
    protected $host = '127.0.0.1';
    protected $port = 2346;
    protected $option = [ 
        'count'     => 4,
        'pidFile'   => Env::get('runtime_path') . 'worker.pid', // 坑#01
        'name'      => 'think'
    ];

    public function onMessage($connection, $data)
    {
        $connection->send('receive success');
    }
}

坑#01 Accessing static property Workerman\Worker::$pidFile as non static

开端：$pidFile，文件指定保存位置
原因：think-worker 扩展中Server 类，关于Workerman\Woker 类的静态属性$pidFile 作为对象属性 来处理

// 部分代码
    public function __construct()
    {
        // 实例化 Websocket 服务
        $this->worker = new Worker($this->socket ?: $this->protocol . '://' . $this->host . ':' . $this->port, $this->context);

        // 设置参数（$opthin 的处理）
        if (!empty($this->option)) {
            foreach ($this->option as $key => $val) {
                $this->worker->$key = $val; // **坑#01**
            }
        }
    }

解决

// 自定义服务类代码
    public function init()
    {
        parent::init();
        \Workerman\Worker::$pidFile = app()->getRuntimePath() . 'workerman.pid'; // `静态属性` 赋值
    }

坑#02 无法通过自定义头信息header 来传递数据，例如：token

坑之说明：前端websocket请求头问题 · Issue #7 · DvcLAB/DvcAI-fe · GitHub

只能通过手动ws.send(token) 来带上token