Swoole WebSocket 的应用
概述
这是关于 swoole 学习的第三篇文章:swoole websocket 的应用。
什么是 websocket ?
websocket 是一种在单个tcp连接上进行全双工通信的协议。
websocket 使得客户端和服务器之间的数据交换变得更加简单,允许服务端主动向客户端推送数据。
在 websocket api 中,浏览器和服务器只需要完成一次握手,两者之间就直接可以创建持久性的连接,并进行双向数据传输。
我们利用 websocket 进行及时通讯,今天实现一个 视频弹幕效果。
实现弹幕其实就和群聊类似,将消息推送给所有的客户端,只不过前端的展示所有不同。
本地版本:
- 后端 php 7.2.6、swoole 4.3.1。
- 前端 html5 websocket、canvas。
废话不多说,先看效果。
批量版:
手动版:
代码
server.php
<?php class server { private $serv; public function __construct() { $this->serv = new swoole_websocket_server("0.0.0.0", 9501); $this->serv->set([ 'worker_num' => 2, //开启2个worker进程 'max_request' => 4, //每个worker进程 max_request设置为4次 'task_worker_num' => 4, //开启4个task进程 'dispatch_mode' => 4, //数据包分发策略 - ip分配 'daemonize' => false, //守护进程(true/false) ]); $this->serv->on('start', [$this, 'onstart']); $this->serv->on('open', [$this, 'onopen']); $this->serv->on("message", [$this, 'onmessage']); $this->serv->on("close", [$this, 'onclose']); $this->serv->on("task", [$this, 'ontask']); $this->serv->on("finish", [$this, 'onfinish']); $this->serv->start(); } public function onstart($serv) { echo "#### onstart ####".php_eol; echo "swoole ".swoole_version . " 服务已启动".php_eol; echo "master_pid: {$serv->master_pid}".php_eol; echo "manager_pid: {$serv->manager_pid}".php_eol; echo "########".php_eol.php_eol; } public function onopen($serv, $request) { echo "#### onopen ####".php_eol; echo "server: handshake success with fd{$request->fd}".php_eol; $serv->task([ 'type' => 'login' ]); echo "########".php_eol.php_eol; } public function ontask($serv, $task_id, $from_id, $data) { echo "#### ontask ####".php_eol; echo "#{$serv->worker_id} ontask: [pid={$serv->worker_pid}]: task_id={$task_id}".php_eol; $msg = ''; switch ($data['type']) { case 'login': $msg = '我来了...'; break; case 'speak': $msg = $data['msg']; break; } foreach ($serv->connections as $fd) { $connectioninfo = $serv->connection_info($fd); if ($connectioninfo['websocket_status'] == 3) { $serv->push($fd, $msg); //长度最大不得超过2m } } $serv->finish($data); echo "########".php_eol.php_eol; } public function onmessage($serv, $frame) { echo "#### onmessage ####".php_eol; echo "receive from fd{$frame->fd}:{$frame->data},opcode:{$frame->opcode},fin:{$frame->finish}".php_eol; $serv->task(['type' => 'speak', 'msg' => $frame->data]); echo "########".php_eol.php_eol; } public function onfinish($serv,$task_id, $data) { echo "#### onfinish ####".php_eol; echo "task {$task_id} 已完成".php_eol; echo "########".php_eol.php_eol; } public function onclose($serv, $fd) { echo "#### onclose ####".php_eol; echo "client {$fd} closed".php_eol; echo "########".php_eol.php_eol; } } $server = new server();
index.php
<!doctype html> <html lang="zh-cn"> <head> <meta charset="utf-8"> <meta http-equiv="x-ua-compatible" content="ie=edge"> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta name="description" content=""> <meta name="keywords" content=""> <script src="js/canvasbarrage.js?v=17"></script> <title>视频弹幕demo</title> <style> .canvas-barrage { position: absolute; width: 960px; height: 540px; pointer-events: none; z-index: 1; } .ui-input { height: 20px; width: 856px; line-height: 20px; border: 1px solid #d0d0d5; border-radius: 4px; padding: 9px 8px; } .ui-button { display: inline-block; background-color: #2486ff; line-height: 28px; text-align: center; border-radius: 4px; color: #fff; font-size: 14px; } </style> </head> <body> <canvas id="canvasbarrage" class="canvas-barrage"></canvas> <video id="videobarrage" width="960" height="540" src="./video/video.mp4" controls></video> <p> <input class="ui-input" id="msg" name="value" value="发送弹幕" required> <input class="ui-button" type="button" id="sendbtn" value="发送弹幕"> </p> <script> if ("websocket" in window) { // 弹幕数据 var databarrage = [{ value: '', time: 0, // 单位秒 speed: 0, fontsize: 0 }]; var itemscolor = ['#ffa54f','#ff4040','#ee1289', '#8e8e38', '#3a5fcd', '#00ee76', '#388e8e', '#76eec6', '#87ceff', '#7fffd4']; var elecanvas = document.getelementbyid('canvasbarrage'); var elevideo = document.getelementbyid('videobarrage'); var barrage = new canvasbarrage(elecanvas, elevideo, { data: databarrage }); var wsserver = 'ws://10.211.55.3:9501'; var ws = new websocket(wsserver); ws.onopen = function (evt) { if (ws.readystate == 1) { console.log('websocket 连接成功...'); } else { console.log('websocket 连接失败...'); } }; ws.onmessage = function (evt) { barrage.add({ value: evt.data, time: elevideo.currenttime, speed: 5, color: itemscolor[math.floor(math.random()*itemscolor.length)] // 其它如 fontsize, opacity等可选 }); console.log('retrieved data from server: ' + evt.data); }; ws.onerror = function (evt) { alert('websocket 发生错误'); console.log(evt); }; ws.onclose = function() { alert('websocket 连接关闭'); console.log('websocket 连接关闭...'); }; var msg; var sendbtn = document.getelementbyid('sendbtn'); sendbtn.onclick = function(){ if (ws.readystate == 1) { msg = document.getelementbyid('msg').value; ws.send(msg); } else { alert('websocket 连接失败'); } }; } else { alert("您的浏览器不支持 websocket!"); } </script> </body> </html>
小结
一、单聊提供了方法,群聊提供方法了吗?
官方没有提供群聊的方法,使用循环实现的。
单聊:
$serv->push($fd, $msg);
群聊:
foreach ($serv->connections as $fd) { $serv->push($fd, $msg); }
二、发送消息为什么要放到task中,封装一个普通方法不行吗?
不能封装成一个普通的方法,要放在task中使用多进程执行。
如果想了解 swoole task 的知识,请看: 第二篇:swoole timer 的应用。
三、如何模拟批量弹幕效果?
可以使用 swoole_timer_tick ,比如:
swoole_timer_tick(50, function () use($serv){ $serv->task([ 'type' => 'login' ]); });
四、前端使用的哪个弹幕插件?还有没有其他的?
canvasbarrage.js:
有其他的,比如:
- jquery.barrager.js
- jquery.danmu.js
- danmuer.js
根据自己喜欢风格,进行尝试吧。
五、demo 中视频全屏后,还显示弹幕吗?
不显示。
当点击如上图中的 “全屏” 时,弹幕就不显示了,因为这时全屏的视频已经脱离了html文档,具体能否实现大家可以研究研究(记得考虑 pc、android、ios 等兼容性)。
也可以用“伪全屏”进行实现,自定义一个全屏按钮,点击时让当前页面全屏,同时让视频尺寸变大。
六、看了这篇文章,单聊和群聊都会了,能实现一个在线im吗?
不能。
真正使用的在线im系统,需求落地时比我们想象到要复杂的多,自己深入研究没问题,想开发一套生产环境用的im系统,需要慎重,特别是后端用php。
如果急需在线im系统,可以使用市面上专业的im系统。
七、弹幕有什么应用场景?
比如,办年会或活动开场时大家可以利用弹幕活跃气氛,使用微信扫码登录后进行发送实时弹幕,还可以应用到直播,只要觉得合理都可以使用。
八、swoole websocket 入门还可以实现什么案例?
可以实现聊天室功能、直播功能、扫码登录功能等。
温馨提示
本 demo 仅仅是简单的实现,如需应用到真实场景中还要多做优化。
需要demo源码的,关注公众号,回复“swoole 弹幕”即可。
本文欢迎转发,转发请注明作者和出处,谢谢!