編輯推薦:
本文來自于www.qcloud.co,這篇文章分享一個簡單的剪刀石頭布的小游戲的制作,希望能對想要在小程序中使用 WebSocket 的開發(fā)者有幫助。

沒事打開小程序,和附近的人剪刀石頭布,想來就來,想走就走。誰能成為武林高手?!

微信小程序提供了一套在微信上運行小程序的解決方案,有比較完整的框架、組件以及 API,在這個平臺上面的想象空間很大。

騰訊云拿到了小程序內(nèi)測資格,研究了一番之后,發(fā)現(xiàn)微信支持 WebSocket 還是很值得玩味的。這個特性意味著我們可以做一些實時同步或者協(xié)作的小程序。

整個游戲非常簡單,連接到服務(wù)器后自動匹配在線玩家(沒有則分配一個機(jī)器人),然后兩人進(jìn)行剪刀石頭布的對抗游戲。當(dāng)對方進(jìn)行拳頭選擇的時候,頭像會旋轉(zhuǎn),這個過程使用 WebSocket 會變得簡單快速。

部署和運行

拿到了本小程序源碼的朋友可以嘗試自己運行起來。

整體架構(gòu)

小程序的架構(gòu)非常簡單,這里有兩條網(wǎng)絡(luò)同步,一條是 HTTPS 通路,用于常規(guī)請求。對于 WebSocket 請求,會先走 HTTPS 后再切換協(xié)議到 WebSocket 的 TCP 連接,從而實現(xiàn)全雙工通信。

1. 準(zhǔn)備域名和證書

在微信小程序中,所有的網(wǎng)絡(luò)請求受到嚴(yán)格限制,不滿足條件的域名和協(xié)議無法請求,具體包括:

只允許和在 MP 中配置好的域名進(jìn)行通信,如果還沒有域名,需要注冊一個。

網(wǎng)絡(luò)請求必須走 HTTPS 協(xié)議,所以你還需要為你的域名申請一個證書。

域名注冊好之后,可以登錄微信公眾平臺配置通信域名了。

2. 云主機(jī)和鏡像部署

剪刀石頭布的服務(wù)器運行代碼和配置已經(jīng)打包成騰訊云 CVM 鏡像,大家可以直接使用。

騰訊云用戶可以免費領(lǐng)取禮包,體驗騰訊云小程序解決方案。

鏡像已包含「剪刀石頭布」和「小相冊」兩個小程序的服務(wù)器環(huán)境與代碼,需要體驗兩個小程序的朋友無需重復(fù)部署

3. 配置 HTTPS

鏡像中已經(jīng)部署了nginx,需要在/etc/nginx/conf.d下修改配置中的域名、證書、私鑰。

配置完成后,即可啟動 nginx。

nginx

4. 域名解析

我們還需要添加域名記錄解析到我們的云服務(wù)器上,這樣才可以使用域名進(jìn)行 HTTPS 服務(wù)。

在騰訊云注冊的域名,可以直接使用云解析控制臺來添加主機(jī)記錄,直接選擇上面購買的 CVM。

解析生效后,我們在瀏覽器使用域名就可以進(jìn)行 HTTPS 訪問。

5. 啟動 WebSocket 服務(wù)

在鏡像的 nginx 配置中(/etc/nginx/conf.d),已經(jīng)把 /applet/websocket的請求轉(zhuǎn)發(fā)到http://127.0.0.1:9595 處理。我們需要把 Node 實現(xiàn)的 WebSocket 服務(wù)在這個端口里運行起來。

進(jìn)入鏡像中源碼位置:

cd /data/release/qcloud-applet-websocket

使用pm2 啟動服務(wù):

pm2 start process.json

6. 啟動微信小程序

在微信開發(fā)者工具中修改小程序源碼中的 config.js 配置,把通訊域名修改成上面申請的域名。完成后點擊調(diào)試即可連接到 WebSocket 服務(wù)進(jìn)行游戲。

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

為什么要用 WebSocket

使用傳統(tǒng)的 HTTP 輪詢或者長連接的方式也可以實現(xiàn)類似服務(wù)器推送的效果,但是這類方式都存在資源消耗過大或推送延遲等問題。而 WebSocket 直接使用 TCP 連接保持全雙工的傳輸,可以有效地減少連接的建立,實現(xiàn)真正的服務(wù)器通信,對于有低延遲有要求的應(yīng)用是一個很好的選擇。

目前瀏覽器對 WebSocket 的支持程度已經(jīng)很好,加上微信小程序的平臺支持,這種可以極大提高客戶端體驗的通信方式將會變得更加主流。

Server 端需要實現(xiàn) WebSocket 協(xié)議,才能支持微信小程序的 WebSocket 請求。鑒于 SocketIO 被廣泛使用,剪刀石頭布的小程序,我們選用了比較品牌的 SocketIO 作為服務(wù)端的實現(xiàn)。

Socket IO 的使用比較簡單,僅需幾行代碼就可啟動服務(wù)。

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 = new Server();

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

server.start();

但是,SocketIO 和一些其它的服務(wù)器端實現(xiàn),都有其配套的客戶端來完成上層協(xié)議的編碼解碼。但是由于微信的限制(不能使用 window 等對象), SocketIO 的客戶端代碼在微信小程序平臺上是無法運行的。

經(jīng)過對 SocketIO 通信進(jìn)行抓包以及研究其客戶端源碼,筆者封裝了一個大約 100 行適用于微信小程序平臺的 WxSocketIO類,可以幫助開發(fā)者快速使用 SocketIO 來進(jìn)行 WebSocket 通信。

const socket = new WxSocketIO();

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

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

如果想要使用微信原生的 API,那么在服務(wù)器端也可以直接使用 ws 來實現(xiàn) W3C 標(biāo)準(zhǔn)的接口。不過 SocketIO 支持多進(jìn)程的特性,對于后續(xù)做橫向擴(kuò)張是很有幫助的。騰訊云在后面也會有計劃推出支持大規(guī)模業(yè)務(wù)需求的 WebSocket 連接服務(wù),減小業(yè)務(wù)的部署成本。

通信協(xié)議設(shè)計

實現(xiàn)一個多客戶端交互的服務(wù),是需要把中間涉及到所有的消息類型都設(shè)計清楚的,就像是類似剪刀石頭布這樣一個小程序,都有下面這些消息類型。

具體每個消息的參數(shù)可以參考源碼里的server/protocol.brief.md

服務(wù)器邏輯

服務(wù)器的邏輯很簡單:

收到用戶請求加入房間(join),就尋找還沒滿的房間

找到房間,則加入

沒找到房間,創(chuàng)建新房間

有用戶加入的房間檢查是否已滿,如果已滿,則:

給房間里每個用戶發(fā)送開始游戲的信號(start)

啟動計時器,計時器結(jié)束后進(jìn)行游戲結(jié)算

游戲結(jié)算

兩兩之間 PK,贏方分?jǐn)?shù)加一,輸方減一,最終得每個玩家基本得分 x

對于每個玩家,如果分?jǐn)?shù) x 大于 0,則視為勝利,連勝次數(shù)加一,否則連勝次數(shù)歸零

本局得分為分?jǐn)?shù) x 乘以連勝次數(shù)

發(fā)送本局游戲結(jié)果給房間里的每位玩家

微信端實現(xiàn)

微信小程序直接使用上面的協(xié)議,針對不同的場景進(jìn)行渲染。整體的狀態(tài)機(jī)如下。

狀態(tài)機(jī)整理清楚后,就是根據(jù)狀態(tài)機(jī)來控制什么時候發(fā)送消息,接到消息后如何處理的問題了。具體實現(xiàn)請參照 app/pages/game/game.js里的源碼。