Swoole WebSocket 的应用:如何实现单聊和群聊

什么是 WebSocket ?

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

WebSocket 使得客户端和服务器之间的数据交换变得更加简单,允许服务端主动向客户端推送数据。

在 WebSocket API 中,浏览器和服务器只需要完成一次握手,两者之间就直接可以创建持久性的连接,并进行双向数据传输。

我们利用 WebSocket 进行及时通讯,今天实现一个 视频弹幕效果。

实现弹幕其实就和群聊类似,将消息推送给所有的客户端,只不过前端的展示所有不同。

本地版本:

  • 后端 PHP 7.2.6、Swoole 4.3.1。
  • 前端 HTML5 WebSocket、Canvas。

废话不多说,先看效果。

批量版(批量模拟):

手动版(手动发送):

代码

server.php

1.  `<?php`
    
2.    
    
3.  `class  Server`
    
4.  `{`
    
5.  `private $serv;`
    
6.    
    
7.  `public  function __construct()  {`
    
8.  `$this->serv =  new swoole_websocket_server("0.0.0.0",  9501);`
    
9.  `$this->serv->set([`
    
10.  `'worker_num'  =>  2,  //开启2个worker进程`
    
11.  `'max_request'  =>  4,  //每个worker进程 max_request设置为4次`
    
12.  `'task_worker_num'  =>  4,  //开启4个task进程`
    
13.  `'dispatch_mode'  =>  4,  //数据包分发策略 - IP分配`
    
14.  `'daemonize'  =>  false,  //守护进程(true/false)`
    
15.  `]);`
    
16.    
    
17.  `$this->serv->on('Start',  [$this,  'onStart']);`
    
18.  `$this->serv->on('Open',  [$this,  'onOpen']);`
    
19.  `$this->serv->on("Message",  [$this,  'onMessage']);`
    
20.  `$this->serv->on("Close",  [$this,  'onClose']);`
    
21.  `$this->serv->on("Task",  [$this,  'onTask']);`
    
22.  `$this->serv->on("Finish",  [$this,  'onFinish']);`
    
23.    
    
24.  `$this->serv->start();`
    
25.  `}`
    
26.    
    
27.  `public  function onStart($serv)  {`
    
28.  `echo "#### onStart ####".PHP_EOL;`
    
29.  `echo "SWOOLE ".SWOOLE_VERSION .  " 服务已启动".PHP_EOL;`
    
30.  `echo "master_pid: {$serv->master_pid}".PHP_EOL;`
    
31.  `echo "manager_pid: {$serv->manager_pid}".PHP_EOL;`
    
32.  `echo "########".PHP_EOL.PHP_EOL;`
    
33.  `}`
    
34.    
    
35.  `public  function onOpen($serv, $request)  {`
    
36.  `echo "#### onOpen ####".PHP_EOL;`
    
37.  `echo "server: handshake success with fd{$request->fd}".PHP_EOL;`
    
38.  `$serv->task([`
    
39.  `'type'  =>  'login'`
    
40.  `]);`
    
41.  `echo "########".PHP_EOL.PHP_EOL;`
    
42.  `}`
    
43.    
    
44.  `public  function onTask($serv, $task_id, $from_id, $data)  {`
    
45.  `echo "#### onTask ####".PHP_EOL;`
    
46.  `echo "#{$serv->worker_id} onTask: [PID={$serv->worker_pid}]: task_id={$task_id}".PHP_EOL;`
    
47.  `$msg =  '';`
    
48.  `switch  ($data['type'])  {`
    
49.  `case  'login':`
    
50.  `$msg =  '我来了...';`
    
51.  `break;`
    
52.  `case  'speak':`
    
53.  `$msg = $data['msg'];`
    
54.  `break;`
    
55.  `}`
    
56.  `foreach  ($serv->connections as $fd)  {`
    
57.  `$connectionInfo = $serv->connection_info($fd);`
    
58.  `if  ($connectionInfo['websocket_status']  ==  3)  {`
    
59.  `$serv->push($fd, $msg);  //长度最大不得超过2M`
    
60.  `}`
    
61.  `}`
    
62.  `$serv->finish($data);`
    
63.  `echo "########".PHP_EOL.PHP_EOL;`
    
64.  `}`
    
65.    
    
66.  `public  function onMessage($serv, $frame)  {`
    
67.  `echo "#### onMessage ####".PHP_EOL;`
    
68.  `echo "receive from fd{$frame->fd}:{$frame->data},opcode:{$frame->opcode},fin:{$frame->finish}".PHP_EOL;`
    
69.  `$serv->task(['type'  =>  'speak',  'msg'  => $frame->data]);`
    
70.  `echo "########".PHP_EOL.PHP_EOL;`
    
71.  `}`
    
72.    
    
73.  `public  function onFinish($serv,$task_id, $data)  {`
    
74.  `echo "#### onFinish ####".PHP_EOL;`
    
75.  `echo "Task {$task_id} 已完成".PHP_EOL;`
    
76.  `echo "########".PHP_EOL.PHP_EOL;`
    
77.  `}`
    
78.    
    
79.  `public  function onClose($serv, $fd)  {`
    
80.  `echo "#### onClose ####".PHP_EOL;`
    
81.  `echo "client {$fd} closed".PHP_EOL;`
    
82.  `echo "########".PHP_EOL.PHP_EOL;`
    
83.  `}`
    
84.  `}`
    
85.    
    
86.  `$server =  new  Server();`

index.php

1.  `<!DOCTYPE html>`
    
2.  `<html  lang="zh-CN">`
    
3.  `<head>`
    
4.  `<meta  charset="utf-8">`
    
5.  `<meta  http-equiv="X-UA-Compatible"  content="IE=edge">`
    
6.  `<meta  name="viewport"  content="width=device-width, initial-scale=1">`
    
7.  `<meta  name="description"  content="">`
    
8.  `<meta  name="keywords"  content="">`
    
9.  `<script  src="js/canvasBarrage.js?v=17"></script>`
    
10.  `<title>视频弹幕Demo</title>`
    
11.  `<style>`
    
12.  `.canvas-barrage {`
    
13.  `position: absolute;`
    
14.  `width:  960px;`
    
15.  `height:  540px;`
    
16.  `pointer-events: none;`
    
17.  `z-index:  1;`
    
18.  `}`
    
19.  `.ui-input {`
    
20.  `height:  20px;`
    
21.  `width:  856px;`
    
22.  `line-height:  20px;`
    
23.  `border:  1px solid #d0d0d5;`
    
24.  `border-radius:  4px;`
    
25.  `padding:  9px  8px;`
    
26.  `}`
    
27.  `.ui-button {`
    
28.  `display:  inline-block;`
    
29.  `background-color:  #2486ff;`
    
30.  `line-height:  28px;`
    
31.  `text-align: center;`
    
32.  `border-radius:  4px;`
    
33.  `color:  #fff;`
    
34.  `font-size:  14px;`
    
35.  `}`
    
36.  `</style>`
    
37.  `</head>`
    
38.  `<body>`
    
39.  `<canvas  id="canvasBarrage"  class="canvas-barrage"></canvas>`
    
40.  `<video  id="videoBarrage"  width="960"  height="540"  src="./video/video.mp4"  controls></video>`
    
41.  `<p>`
    
42.  `<input  class="ui-input"  id="msg"  name="value"  value="发送弹幕"  required>`
    
43.  `<input  class="ui-button"  type="button"  id="sendBtn"  value="发送弹幕">`
    
44.  `</p>`
    
45.  `<script>`
    
46.  `if  ("WebSocket" in window)  {`
    
47.  `// 弹幕数据`
    
48.  `var dataBarrage =  [{`
    
49.  `value:  '',`
    
50.  `time:  0,  // 单位秒`
    
51.  `speed:  0,`
    
52.  `fontSize:  0`
    
53.  `}];`
    
54.    
    
55.  `var itemsColor =  ['#FFA54F','#FF4040','#EE1289',  '#8E8E38',  '#3A5FCD',  '#00EE76',  '#388E8E',  '#76EEC6',  '#87CEFF',  '#7FFFD4'];`
    
56.    
    
57.  `var eleCanvas = document.getElementById('canvasBarrage');`
    
58.  `var eleVideo = document.getElementById('videoBarrage');`
    
59.    
    
60.  `var barrage =  new  CanvasBarrage(eleCanvas, eleVideo,  {`
    
61.  `data: dataBarrage`
    
62.  `});`
    
63.    
    
64.  `var wsServer =  'ws://10.211.55.3:9501';`
    
65.  `var ws =  new  WebSocket(wsServer);`
    
66.    
    
67.  `ws.onopen =  function  (evt)  {`
    
68.  `if  (ws.readyState ==  1)  {`
    
69.  `console.log('WebSocket 连接成功...');`
    
70.  `}  else  {`
    
71.  `console.log('WebSocket 连接失败...');`
    
72.  `}`
    
73.  `};`
    
74.    
    
75.  `ws.onmessage =  function  (evt)  {`
    
76.    
    
77.  `barrage.add({`
    
78.  `value: evt.data,`
    
79.  `time: eleVideo.currentTime,`
    
80.  `speed:  5,`
    
81.  `color: itemsColor[Math.floor(Math.random()*itemsColor.length)]`
    
82.  `// 其它如 fontSize, opacity等可选`
    
83.  `});`
    
84.  `console.log('Retrieved data from server: '  + evt.data);`
    
85.  `};`
    
86.    
    
87.  `ws.onerror =  function  (evt)  {`
    
88.  `alert('WebSocket 发生错误');`
    
89.  `console.log(evt);`
    
90.  `};`
    
91.    
    
92.  `ws.onclose =  function()  {`
    
93.  `alert('WebSocket 连接关闭');`
    
94.  `console.log('WebSocket 连接关闭...');`
    
95.  `};`
    
96.    
    
97.  `var msg;`
    
98.  `var sendBtn = document.getElementById('sendBtn');`
    
99.  `sendBtn.onclick =  function(){`
    
100.  `if  (ws.readyState ==  1)  {`
    
101.  `msg = document.getElementById('msg').value;`
    
102.  `ws.send(msg);`
    
103.  `}  else  {`
    
104.  `alert('WebSocket 连接失败');`
    
105.  `}`
    
106.  `};`
    
107.  `}  else  {`
    
108.  `alert("您的浏览器不支持 WebSocket!");`
    
109.  `}`
    
110.  `</script>`
    
111.  `</body>`
    
112.  `</html>`

小结

一、单聊提供了方法,群聊提供方法了吗?

官方没有提供群聊的方法,使用循环实现的。

单聊:

$serv\->push($fd, $msg);

群聊:

1.  `foreach  ($serv->connections as $fd)  {`
    
2.  `$serv->push($fd, $msg);`
    
3.  `}`

二、发送消息为什么要放到 Task 中,封装一个普通方法不行吗?

不能封装成一个普通的方法,要放在 Task 中使用多进程执行。

如果想了解 Swoole Task 的知识,请看:第二篇:Swoole Task 的应用。

三、如何模拟批量弹幕效果?

可以使用 swoole_timer_tick ,比如:

1.  `swoole_timer_tick(50,  function  ()  use($serv){`
    
2.  `$serv->task([`
    
3.  `'type'  =>  'login'`
    
4.  `]);`
    
5.  `});`

六、看了这篇文章,单聊和群聊都会了,能实现一个在线IM吗?

不能。

真正使用的在线IM系统,需求落地时比我们想象到要复杂的多,自己深入研究没问题,想开发一套生产环境用的IM系统,需要慎重,特别是后端用PHP。

如果急需在线IM系统,可以使用市面上专业的IM系统。

七、弹幕有什么应用场景?

比如,办年会或活动开场时大家可以利用弹幕活跃气氛,使用微信扫码登录后进行发送实时弹幕,还可以应用到直播,只要觉得合理都可以使用。

八、Swoole WebSocket 入门还可以实现什么案例?

可以实现聊天室功能、直播功能、扫码登录功能等。

评论

暂无评论