文档章节

微信小程序中如何使用WebSocket实现长连接(含完整源码)

JackJiang-
 JackJiang-
发布于 2018/06/25 15:46
字数 2468
阅读 7.8K
收藏 36

码上生花,ECharts 作品展示赛正式启动!>>>

本文由腾讯云技术团队原创,感谢作者的分享。

1、前言

微信小程序提供了一套在微信上运行小程序的解决方案,有比较完整的框架、组件以及 API,在这个平台上面的想象空间很大。腾讯云研究了一番之后,发现微信支持 WebSocket 还是很值得玩味的。这个特性意味着我们可以做一些实时同步或者协作的小程序。

这篇文章分享了一个基于WebSocket长连接的微信小程序——简单的剪刀石头布小游戏的制作过程,希望能对想要在微信小程序中使用 WebSocket 的开发者有所帮助。

学习交流:

- 即时通讯开发交流3群:185926912[推荐]

- 移动端IM开发入门文章:《新手入门一篇就够:从零开发移动端IM

说明:本文完整源码请从此文末附件下载:http://www.52im.net/thread-1703-1-1.html

2、相关文章

新手入门贴:史上最全Web端即时通讯技术原理详解

Web端即时通讯技术盘点:短轮询、Comet、Websocket、SSE

新手快速入门:WebSocket简明教程

WebSocket详解(一):初步认识WebSocket技术

WebSocket详解(二):技术原理、代码演示和应用案例

WebSocket详解(三):深入WebSocket通信协议细节

WebSocket详解(四):刨根问底HTTP与WebSocket的关系(上篇)

WebSocket详解(五):刨根问底HTTP与WebSocket的关系(下篇)

WebSocket详解(六):刨根问底WebSocket与Socket的关系

socket.io实现消息推送的一点实践及思路

Web端即时通讯技术的发展与WebSocket、Socket.io的技术实践

Web端即时通讯安全:跨站点WebSocket劫持漏洞详解(含示例代码)

开源框架Pomelo实践:搭建Web端高性能分布式IM聊天服务器

使用WebSocket和SSE技术实现Web端消息推送

详解Web端通信方式的演进:从Ajax、JSONP 到 SSE、Websocket

MobileIMSDK-Web的网络层框架为何使用的是Socket.io而不是Netty?

理论联系实际:从零理解WebSocket的通信原理、协议格式、安全性

>> 更多同类文章 ……

3、运行效果

整个游戏非常简单,连接到服务器后自动匹配在线玩家(没有则分配一个机器人),然后两人进行剪刀石头布的对抗游戏。当对方进行拳头选择的时候,头像会旋转,这个过程使用 WebSocket 会变得简单快速。

剪刀石头布游戏效果如下图所示:

4、为什么要用 WebSocket

使用传统的 HTTP 轮询或者长连接的方式也可以实现类似服务器推送的效果,但是这类方式都存在资源消耗过大或推送延迟等问题(详见文章《新手入门贴:史上最全Web端即时通讯技术原理详解》)。而 WebSocket 直接使用 TCP 连接保持全双工的传输,可以有效地减少连接的建立,实现真正的服务器通信,对于有低延迟有要求的应用是一个很好的选择。

目前浏览器对 WebSocket 的支持程度已经很好,加上微信小程序的平台支持,这种可以极大提高客户端体验的通信方式将会变得更加主流。

Server 端需要实现 WebSocket 协议,才能支持微信小程序的 WebSocket 请求。鉴于 SocketIO 被广泛使用(详见《Socket.IO介绍:支持WebSocket、用于WEB端的即时通讯的框架》),剪刀石头布的小程序,我们选用了比较著名的SocketIO 作为服务端的实现。

Socket IO 的使用比较简单,仅需几行代码就可启动服务。

export class Server {

    init(path: string) {

        /** Port that server listen on */

        this.port = process.env.PORT;

        /** HTTP Server instance for both express and socket io */

        this.http = http.createServer();

        /** Socket io instance */

        this.io = SocketIO(this.http, { path });

        /** Handle incomming connection */

        this.io.on("connection", socket => {

            // handle connection

        });

    }

    start() {

        this.http.listen(this.port);

        console.log(`---- server started. listen : ${this.port} ----`);

    }

}

const server = newServer();

server.init("/applet/ws/socket.io");

server.start();

但是,SocketIO 和一些其它的服务器端实现,都有其配套的客户端来完成上层协议的编码解码。但是由于微信的限制(不能使用 window 等对象), SocketIO 的客户端代码在微信小程序平台上是无法运行的。

经过对 SocketIO 通信进行抓包以及研究其客户端源码,笔者封装了一个大约 100 行适用于微信小程序平台的 WxSocketIO类,可以帮助开发者快速使用 SocketIO 来进行 WebSocket 通信。

const socket = newWxSocketIO();

socket.on('hi', packet => console.log('server say hi: '+ packet.message));

socket.emit('hello', { from: 'techird'});

如果想要使用微信原生的 API,那么在服务器端也可以直接使用 ws 来实现 W3C 标准的接口。不过 SocketIO 支持多进程的特性,对于后续做横向扩张是很有帮助的。腾讯云在后面也会有计划推出支持大规模业务需求的 WebSocket 连接服务,减小业务的部署成本。

5、通信协议设计

实现一个多客户端交互的服务,是需要把中间涉及到所有的消息类型都设计清楚的,就像是类似剪刀石头布这样一个小程序,都有下面这些消息类型。

具体每个消息的参数可以参考源码里的server/protocol.brief.md

6、服务器逻辑

服务器的逻辑很简单:

收到用户请求加入房间(join),就寻找还没满的房间:

- 找到房间,则加入;

- 没找到房间,创建新房间。

有用户加入的房间检查是否已满,如果已满,则:

- 给房间里每个用户发送开始游戏的信号(start);

- 启动计时器,计时器结束后进行游戏结算。

游戏结算:

- 两两之间 PK,赢方分数加一,输方减一,最终得每个玩家基本得分 x;

- 对于每个玩家,如果分数 x 大于 0,则视为胜利,连胜次数加一,否则连胜次数归零;

- 本局得分为分数 x 乘以连胜次数。

发送本局游戏结果给房间里的每位玩家。

7、微信小程序端的实现

微信小程序直接使用上面的协议,针对不同的场景进行渲染。整体的状态机如下。

状态机整理清楚后,就是根据状态机来控制什么时候发送消息,接到消息后如何处理的问题了。具体实现请参照 app/pages/game/game.js里的源码。

8、部署和运行

拿到了本小程序源码的朋友可以尝试自己运行起来(完整源码请从文末附件下载)。

8.1整体架构

小程序的架构非常简单,这里有两条网络同步,一条是 HTTPS 通路,用于常规请求。对于 WebSocket 请求,会先走 HTTPS 后再切换协议到 WebSocket 的 TCP 连接,从而实现全双工通信。

8.2准备域名和证书

在微信小程序中,所有的网络请求受到严格限制,不满足条件的域名和协议无法请求,具体包括:

只允许和在 MP 中配置好的域名进行通信,如果还没有域名,需要注册一个

网络请求必须走 HTTPS 协议,所以你还需要为你的域名申请一个证书

域名注册好之后,可以登录微信公众平台配置通信域名了。

设置域名和证书如下图所示:

8.3云主机和镜像部署

剪刀石头布的服务器运行代码和配置已经打包成腾讯云 CVM 镜像,大家可以直接使用

腾讯云用户可以免费领取礼包,体验腾讯云小程序解决方案。

▲ 设置镜像

镜像已包含「剪刀石头布」和「小相册」两个小程序的服务器环境与代码,需要体验两个小程序的朋友无需重复部署。

8.4配置 HTTPS

镜像中已经部署了nginx,需要在/etc/nginx/conf.d下修改配置中的域名、证书、私钥。

▲ Nginx 中配置证书

配置完成后,即可启动 nginx。

8.5域名解析

我们还需要添加域名记录解析到我们的云服务器上,这样才可以使用域名进行 HTTPS 服务。

在腾讯云注册的域名,可以直接使用云解析控制台来添加主机记录,直接选择上面购买的 CVM。

▲ 修改 DNS 记录

解析生效后,我们在浏览器使用域名就可以进行 HTTPS 访问。

▲ HTTPS 效果

8.6启动 WebSocket 服务

在镜像的 nginx 配置中(/etc/nginx/conf.d),已经把 /applet/websocket的请求转发到http://127.0.0.1:9595 处理。我们需要把 Node 实现的 WebSocket 服务在这个端口里运行起来。

进入镜像中源码位置:

cd /data/release/qcloud-applet-websocket

使用pm2 启动服务:

pm2 start process.json

8.7启动微信小程序

在微信开发者工具中修改小程序源码中的 config.js 配置,把通讯域名修改成上面申请的域名。完成后点击调试即可连接到 WebSocket 服务进行游戏。

配置完成后,运行小程序就可以看到成功搭建的提示!

▲ 成功效果

9、附件下载(完整源码)

请从此文的附件处下载:http://www.52im.net/thread-1703-1-1.html

© 著作权归作者所有

JackJiang-

JackJiang-

粉丝 223
博文 88
码字总数 409018
作品 2
苏州
其他
私信 提问
加载中
此博客有 4 条评论,请先登录后再查看。
微信小程序 WebSocket 使用非 443 端口连接

前言 微信小程序支持使用 WebSocket 连接到服务器,准确地说是带 SSL 的 WebSocket,而微信小程序中不允许使用带端口的 wss 连接,只能使用 443 端口。想使用其他端口就需要在服务器做一层代...

osc_u6io2wi5
2018/08/19
2
0
微信小程序最新开发案例集合,包含地图小程序、阅读小程序等

分享一些微信小程序最新开发案例集合,包含地图小程序、文章阅读小程序以及纯工具类小程序等 微信小程序开发案例,财务函数,房贷、五险一金计算合集 微信小程序地图导航浏览demo源码下载,适...

osc_lsc01x8k
2018/04/27
6
0
使用RT-Thread 系统实现DIY数字仪表(六)——开发微信小程序

目录: 1.使用RT-Thread 系统实现DIY数字仪表(一)——STM32CUBMX5.6移植touchGFX4.13 2.使用RT-Thread 系统实现DIY数字仪表(二)——把TouchGFX移植到RTThread系统 3.使用RT-Thread 系统实...

Aladdin Wang
04/22
0
0
八问WebSocket协议:为你快速解答WebSocket热门疑问

一、引言 WebSocket是一种比较新的协议,它是伴随着html5规范而生的,虽然还比较年轻,但大多主流浏览器都已经支持。它使用方面、应用广泛,已经渗透到前后端开发的各种场景中。 对http一问一...

首席大胸器
2019/04/25
263
0
微信小程序WebSocket开发

微信小程序WebSocket开发 让我们来实现一个简单的微信小程序WebSocket。WebSocket是一种没有被规范化的网络协议,不过网络上又有文章说是2011年被国际化。不过不管怎么样它摆脱了Http的无状态...

王And木
2018/05/31
0
0

没有更多内容

加载失败,请刷新页面

加载更多

通过 highcharts插件显示柱状图

(1) 引用的js文件。可以去https://jshare.com.cn/demos/hhhhDf 下载 <script src="highchart/highcharts.js"></script> <script src="highchart/exporting.js"></script> (2) html 代码。 <d......

osc_fge5j3lp
6分钟前
3
0
浅谈QUIC协议原理与性能分析及部署方案

之前写过《http1.0 与 http1.1的区别》 与 《再谈HTTP2性能提升之背后原理—HTTP2历史解剖》,QUIC协议,现在nginx官方也即将支持。所以还是得跟上时代脚步。 QUIC简史 QUIC(Quick UDP Inter...

zhoulujun
6分钟前
7
0
从原型到原型链,修炼JavaScript内功这篇文章真的不能错过!

从原型到原型链 本文主要从构造函数 -> 原型(隐式原型+显示原型)-> 原型链的顺序,渐进式讲解,希望对你有所做帮助,共勉~ 系列文章: this指向详解:思维脑图与代码的结合,让你一篇搞懂...

osc_he4uu5y4
7分钟前
3
0
前端30K面试准备,最完整面试真题分享!

送福利啦! 历经两个月发展,本人终于回归前端岗位!裸辞的艰辛已然消逝 在这里特地讲我自己这两个月整理的相关面试题分享给大家,免费获取哦~ 内容: 基础题(293题) 进阶题(30题) 高级题...

osc_y2q7mau8
9分钟前
5
0
vue学习笔记之:ElementUI Select选择器的应用

使用ElementUI 的el-select制作的省市区级联选择 template模板部分:模板中使用了三个下拉菜单,第一个选择省,第二个和第三个分别是市和区,默认第二个和第三个下拉菜单不可用,当第一个选择...

JohnConnor
9分钟前
9
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部