使用 Workerman 做一个聊天室

为什么要写这篇文章?

        我学习Workerman 好几次了,每次都失败(没做成想要的功能,原谅我比较笨)。但是这次也花了好几个小时,把之前没做成的功能实现了。其实就是两个简单的功能:一对一发送消息,广播消息(群聊)。这个功能用swoole早都实现了,也是由于之前一直想用 think-worker 的原因,想想还是得自己琢磨才行,人家做好的框架或许是个阉割版。

别问我为什么不用swoole,因为 Workerman 可以在Windows中运行。

(1)首先,得简单说说 thinkphp+workerman 的安装。

安装 thinkphp5.1

composer create-project topthink/think=5.1.x-dev tp5andworkman

安装 think-worker

composer require topthink/think-worker=2.0.*

直接安装 Workerman

composer require workerman/workerman

(2)我们先看 think-worker 的代码

  • config/worker_server.php

  • 先来个服务器广播消息的示例,每10秒钟定时广播一条消息

'onWorkerStart'  => function ($worker) {
    \Workerman\Lib\Timer::add(10, function()use($worker){
        // 遍历当前进程所有的客户端连接,发送自定义消息
        foreach($worker->connections as $connection){
            $send['name'] = '系统信息';
            $send['content'] = '这是一个定时任务信息';
            $send['time'] = time();
            $connection->send(json_encode($send));
        }
    });
}

但是在 onMessage 时,我们获取不到 $worker 对象,所以无法广播消息。

'onMessage'      => function ($connection, $data) {
    $origin = json_decode($data,true);
    $send['name'] = '广播数据';
    $send['content'] = $origin['content'];
    $message = json_encode($send);

    foreach($worker->connections as $connection)
    {
        $connection->send($message);
    }
}

尝试了各种方法,貌似都不行

'onMessage'      => function ($connection, $data)use($worker) {
    // 这样是获取不到 $worker 对象的
    // ...省略代码
}

所以只能抛弃 thinkphp 给我们封装的 think-worker 框架,得自己写,(或者修改框架内部代码)

修改框架内部的代码:/vendor/topthink/think-worker/src/command/Server.php,主要是把 onMessage 方法自己加进去

use() 就是把外部变量传递到函数内部使用,或者使用global $worker

$worker = new Worker($socket, $context);

$worker->onMessage = function ($connection, $data)use($worker) {
    $origin = json_decode($data,true);
    $send['name'] = '广播数据';
    $send['content'] = $origin['content'];
    $send['uid'] = $connection->uid;
    $message = json_encode($send);
    foreach($worker->connections as $connection)
    {
        $connection->send($message);
    }
};

这样,我们就能够获取到 $worker 对象了

$worker->onMessage = function ($connection, $data)use($worker) { ... }

(3)$connection 绑定 uid

其实你早都已经看出,$worker->connections 获取到的是当前所有用户的连接,connections 即为其中一个链接。

记录websocket连接时间:

$worker->onConnect = function ($connection) {
    $connection->login_time = time();
};

获取websocket连接时间:

$worker->onMessage = function ($connection, $data)use($worker) {
    $login_time = $connection->login_time;
};

由此可以看出,我们可以把数据绑定到 $connection 连接的一个属性,例如:

$connection->uid = $uid;

当JavaScript端在连接websocket服务器成功后,即把自己的 uid 立马发送服务端绑定:

$worker->onMessage = function ($connection, $data)use($worker) {
    $origin = json_decode($data,true);
    if(array_key_exists('bind',$origin)){
        $connection->uid = $origin['uid'];
    }
};

(4)单播发送消息,即自定义发送

$worker->onMessage = function ($connection, $data)use($worker) {
    $origin = json_decode($data,true);
    $sendTo = $origin['sendto']; // 需要发送的对方的uid
    $content = $origin['content']; // 需要发送到对方的内容
    foreach($worker->connections as $connection)
    {
        if( $connection->uid == $sendTo){
            $connection->send($content);
        }
    }
};

到此,已经完成基于 Workerman 的自定义对象发送消息。

由于该php文件存放于composer中,只需要把该文件复制出来,放到application/command,修改命名空间,即可保存到自己的项目中

(5)对比swoole

1、Workerman可以在windows系统中运行,swoole则不能。

2、Workerman:$worker->connections获取所有连接,$connection->id获取自己的连接id;swoole:$server->connections获取所有连接,$connection->fd获取自己的连接id。

3、Workerman启动时执行 onWorkerStart 方法,可以把定时器写入到里面;swoole 使用 WorkerStart 启动定时器。

仅仅于聊天室或者定时器而言,Workerman 还是比较方便的。

(6)项目扩展

  • 对该系统新增禁言功能;
  • 添加用户头像显示;
  • 增加图片发送和显示;
  • 表情显示;

最终实现效果如下:

本作品采用《CC 协议》,转载必须注明作者和本文链接
讨论数量: 11
lmaster

性能追求swoole,如无workman很棒哦

4年前 评论
Summer

有专门的 tp 社区,移过来了哈

4年前 评论
linzening (楼主) 4年前
VeryCool

Workerman 在windows下是阉割版!

4年前 评论
linzening (楼主) 4年前
游离不2

@lmaster swoole 没有很好的集成方案,workerman 有一个gateway-worker

4年前 评论
lmaster

@游离不2 朋友,我是就性能而谈,主要是对博主的第五点而言的。

swoole 与 workerman 是两种截然不同的事务

  • swoole:是面向生产环境的 PHP 异步网络通信引擎(php 扩展)
  • workerman:是开源高性能异步PHP socket即时通讯框架(官网介绍)

Swoole 官网介绍

Swoole 内置了 Http/WebSocket 服务器端/客户端、Http2.0 服务器端。

GatewayWorker 官方手册(看云上的)

可以说GatewayWorker是基于Workerman实现的一个更完善的专门用于实现TCP长连接的项目框架。

WebSocket 百度百科

WebSocket是一种在单个TCP连接上进行全双工通信的协议

我个人对二者的看法

Workerman

Workerman 官网介绍说的很是清楚即时通讯框架,GatewayWorker 更是 Workerman 在TCP 方向上的实现。

GatewayWorker 主要是一个 TCP 的即时通讯框架(目的通讯),有很多聊天系统的实现(官方也有 demo)

Swoole

Swoole 可以广泛应用于互联网、移动通信、企业软件、云计算、网络游戏、物联网(IOT)、车联网、智能家居等领域(不仅仅是通讯)。人们对 Swoole 的好评在与性能的提升(显著提升),一般是用在 php+Swoole 和 nodejs 这种比较。

当然 Swoole 有对 WebSocket 进行封装,你可以自己实现一个聊天系统(网上有很多个人实现,官方的仅仅是个例子)

结语

workerman 在聊天系统上有很多非常好的实现;追求性能时,不妨用 Swoole。

4年前 评论
游离不2

@lmaster swoole 性能再牛,单机还是有瓶颈。我是在吐槽swoole啦,既然性能都可做到这么牛逼了,为啥不在架构层更上一层楼呢。

4年前 评论
lmaster

@游离不2 无法和你交流,和你谈论一个事,你确引到另一个上。

你无非想说,你是对的。

不在回复

4年前 评论
taozywu

@lmaster @游离不2
其实这两个框架都有他们自己的优点,咱们就不要带着有色眼镜来评论。无外呼你熟悉哪个就用哪个而已,真正用到生产环境的时候,再牛逼的框架跑在单机也是干不过low的框架跑在集群上。 当然这个比喻不是很恰当哈。

4年前 评论
游离不2

@lmaster 没人要跟你争对错,各抒己见,畅所欲言,你崇拜你的单机性能,我更看好支持集群的架构,我只是觉得swoole如果在集群这块能支持,岂不是更完美?

一个人啊,要是心胸狭隘,看谁都有“有刁民想害朕”的感觉。

4年前 评论

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!