基于Swoole的WebSocket实现聊天室即时通讯功能

前言

前段时间,不是刚搭建好本地开发环境,那怎么也得搞点事情啊,看了下Swoole开发文档,就先试试WebSocket弄一下即时通讯吧,那就安排一下聊天室,开搞……

Swoole是什么

Swoole 是一个 PHP 的 协程 高性能 网络通信引擎,使用 C/C++ 语言编写,提供了多种通信协议的网络服务器和客户端模块。可以方便快速的实现 TCP/UDP服务、高性能Web、WebSocket服务、物联网、实时通讯、游戏、微服务等,使 PHP 不再局限于传统的 Web 领域。

从官方介绍中可以看到,Swoole支持WebSocket服务,我们就利用这个来快速开发一个简易的聊天室。

聊天室效果

首先进入到项目根目录下,执行命令php SwooleChat.php开启WebSocket服务,然后双击chat.html文件在浏览器中打开,就进入了聊天界面了,就可以开始愉快的吹水了……

服务器端(SwooleChat.php)

官方文档-WebSocket 服务器可以看到,PHP服务器端主要有onOpenonMessageonClose,这三个事件的作用如下:

  • onOpen:监听WebSocket连接打开事件
  • onMessage:监听WebSocket消息事件
  • onClose:监听WebSocket连接关闭事件

建立MySQL数据表

这里我们主要新建一个表就行了,这里,我们是新建一个数据库名为chat,然后再新建一个聊天用户表chat_user,建表SQL语句如下

CREATE TABLE `chat_user` (
  `id` int(11) NOT NULL AUTO_INCREMENT COMMENT '主键',
  `fd` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '推送ID',
  `user_name` varchar(50) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL DEFAULT '' COMMENT '用户名',
  `avatar` varchar(100) CHARACTER SET utf8 COLLATE utf8_general_ci NOT NULL DEFAULT '' COMMENT '头像',
  `online_status` tinyint(3) unsigned NOT NULL DEFAULT '1' COMMENT '在线状态:0离线,1在线',
  `add_time` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '注册时间',
  `update_time` int(10) unsigned NOT NULL DEFAULT '0' COMMENT '更新时间',
  PRIMARY KEY (`id`) USING BTREE
) ENGINE=InnoDB DEFAULT CHARSET=utf8 ROW_FORMAT=DYNAMIC;

onOpen监听WebSocket连接打开

新用户开启一个WebSocket连接,都会走onOpen事件,我根据官方的例子简单封装一下,用户创建连接后,用户信息存入MySQL数据库中,并且通知其他在线用户。对了,提醒一下,这里用到了MySQL,如果没有安装的,请先安装相关扩展。

/**
 * 监听WebSocket连接打开
 */
private function open()
{
    $this->ws->on('open', function ($ws, $request) {
        // 用户存入数据库
        $this->initConn();
        $user_name = $request->get['user_name'];
        $fd = $request->fd;
        $sql = "INSERT INTO chat_user (fd, user_name, add_time) VALUES ($fd, '{$user_name}', " . time() . ")";
        $this->conn->query($sql);
        // 推送上线通知
        $this->return['type'] = 'on';
        $this->return['msg'] = '欢迎【' . $user_name . '】进入聊天室';
        // 用户列表
        $sql = "SELECT fd,user_name FROM chat_user WHERE online_status = 1";
        $result = $this->conn->query($sql);
        $user_list = [];
        if (mysqli_num_rows($result) > 0) {
            // 给其他用户推送上线通知
            while ($row = mysqli_fetch_assoc($result)) {
                $user_list[] = ['fd' => $row['fd'], 'name' => $row['user_name']];
                if ($row['fd'] != $fd) {
                    $this->return['data'] = ['fd' => $fd, 'name' => $user_name];
                    $ws->push($row['fd'], json_encode($this->return));
                }
            }
        }
        // 在线用户
        $this->return['type'] = 'open';
        $this->return['data'] = ['user_list' => $user_list];
        $ws->push($fd, json_encode($this->return));
    });
}

onMessage监听WebSocket消息

客户端发送的消息,需要推送给聊天室内的其他人,并且告知其他用户,这条信息是谁什么时间发送的。

/**
 * 监听WebSocket消息
 */
private function message()
{
    $this->ws->on('message', function ($ws, $frame) {
        $this->initConn();
        // 聊天消息
        $fd = $frame->fd;
        $message = $frame->data;
        $this->return['type'] = 'chat';
        $this->return['msg'] = $message;
        // 用户名称
        $sql = "SELECT user_name FROM chat_user WHERE fd = {$fd} LIMIT 1";
        $res = $this->conn->query($sql);
        $user = $res->fetch_assoc();
        $user_name = $user['user_name'];
        // 用户列表
        $sql = "SELECT fd,user_name FROM chat_user WHERE online_status = 1 ORDER BY id desc";
        $result = $this->conn->query($sql);
        if (mysqli_num_rows($result) > 0) {
            // 推送发送的消息
            while ($row = mysqli_fetch_assoc($result)) {
                $this->return['data'] = ['user_name' => $user_name, 'from' => $fd, 'to' => $row['fd'], 'time' => date('Y-m-d H:i:s')];
                $ws->push($row['fd'], json_encode($this->return));
            }
        }
    });
}

onClose监听WebSocket连接关闭

当客户端连接关闭的时候,需要处理用户状态为离线,并且告知其他在线用户,该用户已下线离开聊天室。

/**
 * 监听WebSocket连接关闭
 */
private function close()
{
    $this->ws->on('close', function ($ws, $fd) {
        $this->initConn();
        // 用户下线
        $sql = "UPDATE chat_user SET online_status = 0 WHERE fd = $fd";
        $this->conn->query($sql);
        // 用户名称
        $sql = "SELECT user_name FROM chat_user WHERE fd = {$fd} LIMIT 1";
        $res = $this->conn->query($sql);
        $user = $res->fetch_assoc();
        $user_name = $user['user_name'];
        // 用户列表
        $sql = "SELECT fd,user_name FROM chat_user WHERE online_status = 1 ORDER BY id desc";
        $result = $this->conn->query($sql);
        if (mysqli_num_rows($result) > 0) {
            // 给其他用户推送下线通知
            while ($row = mysqli_fetch_assoc($result)) {
                if ($row['fd'] != $fd) {
                    $this->return['type'] = 'off';
                    $this->return['msg'] = '【' . $user_name . '】离开聊天室';
                    $this->return['data'] = ['fd' => $fd];
                    $ws->push($row['fd'], json_encode($this->return));
                }
            }
        }
    });
}

客户端(chat.html)

HTML界面

界面,为了简单快速,我用了Bootstrap,可以快速写简单的一个聊天室页面


    
    聊天室
    
    


在线用户

FD编号 用户名

JS交互

同样的,我们从实例中也看到,客户端的主要事件和服务器端是一样的,也就是,客户端建立ws连接后,需要处理来自于服务器端推送的各种事件对应的消息,主要处理上下线消息通知以及普通聊天消息等;为了省事,这里用户名我直接随机获取了,千万别说我懒哈。

完整源码

为了方便,我肯定会把完整源码分享出来的,虽然上面说了一堆核心的代码,但是并凑起来运行还是挺费劲的,作为一个有良心的搬砖工人,我肯定会给大家那种只要环境没问题,就可以直接运行跑起来嗨的代码的,你可能要说了:BB is easy, Show me the code.,好吧,我已经把源码上传到GitHub交友网站了,大家可以去上面查看即可。

总结

这只是一个简单的聊天室,仅供学习参考和交流使用,如有任何问题或者不明白的,多可以留言与我沟通,共同学习和进步,谢谢。

你可能感兴趣的:(php,swoole,websocket,聊天室,即时通讯)