1 項目概述
游戲開發,尤其是微信小游戲開發,是最近幾年比較熱門的話題。
本次「雲開發」公開課,將通過實戰「在線對戰五子棋」,一步步帶領大家,在不借助后端的情況下,利用「小程序 ✖ 雲開發」,獨立完成一款微信小游戲的開發與上線。
2 任務目標
根據項目初始框架,閱讀教程的同時,逐步完成棋盤繪制、音樂播放、玩家對戰、輸贏判定等功能,最終實現一個可以快樂玩耍的在線對戰五子棋。
在這個過程中,會了解到 Serverless 的一些概念,並且實際應用它們,比如:雲數據庫、雲存儲、雲函數、增值能力。除了這些基本功能,還准備了更多的硬核概念與落地實踐,比如:實時數據庫、聚合搜索、權限控制。
完成開發后,上傳並且設置為體驗版,歡迎邀請更多人來體驗。
3 准備工作
從 TencentCloudBase/tcb-game-gomoku 中下載代碼到本地:
git clone https://github.com/TencentCloudBase/tcb-game-gomoku.git
cd tcb-game-gomoku/
切換課程專用的 minigame-study
分支:
git checkout minigame-study
4 實戰任務
4.1 創建雲開發與小游戲環境
1、打開微信 IDE,點擊左側的小游戲,選擇右側的導入項目,導入之前下載的「在線對戰五子棋」的目錄,AppID 修改為你已經注冊好的小游戲 AppID。
2、進入后,點擊上方的雲開發按鈕。如果之前沒有開通過雲開發,需要開通雲開發,新開通的話需要等待 10 ~ 20 分鍾。
3、進入「雲開發/數據庫」,創建新的集合,新集合的名稱是rooms
。
4、進入「雲開發/存儲」,點擊“上傳文件”。上傳的內容是/static/
下的bgm.mp3
和 fall.mp3
。之后的代碼中會通過雲存儲的接口,請求文件的臨時 url,這樣做的目的是減少用戶首次進入游戲加載的靜態資源。
4.2 准備配置文件
創建配置文件:
cp miniprogram/shared/config.example.js miniprogram/shared/config.js
將關鍵字段的信息,換成自己賬號的信息即可:
4.3 創建雲開發接口
打開 miniprogram/shared/cloud.js
,在里面初始化雲開發能力,並且對外暴露雲數據庫以及聚合搜索的 API。
4.4 獲取雲存儲資源的鏈接
為了減少用戶首屏加載的靜態資源,音樂資源並沒有放在miniprogram
目錄下,而是放在了雲存儲中,通過調用雲存儲的 api 接口,來返回靜態資源的臨時鏈接。
在 miniprogram/modules/music.js
中,會調用資源接口,獲取資源鏈接:
getTempFileURL
函數屬於雲開發相關,因此放在了 miniprogram/shared/cloud.js
中。這里只需要臨時鏈接tempFileURL
屬性,其它返回值直接過濾調即可。
為了方便外面調用,promise 內部不再用 reject 拋錯。對於錯誤異常,返回空字符串。這樣,加載失敗的資源不會影響正常資源的加載和 Promise.all 中邏輯進行。
4.5 游戲進入與身份判斷
根據前面的流程圖我們可以看到,游戲玩家的身份是分為 owner 與 player。它們的含義如下:
- owner:玩家進入游戲后,查找是否有空閑房間,如果不存在空閑房間,那么就會主動創建新的空閑房間。那么對於新創建的房間,玩家就是 owner。
- player:玩家進入游戲后,查找是否有空閑房間,如果存在空閑房間,那么就加入空閑房間。那么對於空閑房間,玩家就是 player。
判斷的依據就是 judgeIdentity
方法中,讀取雲數據庫集合中的 rooms 的記錄。如果存在多個空閑房間,需要選取創建時間最近的一個房間。因此,這里需要用到「聚合搜索」的邏輯。
聚合搜索的條件,在這里有 3 個:
- 標記人數的字段,是否為 1
- 創建時間倒敘排序
- 只選擇 1 個
4.6 創建新房間
在上述的身份判斷函數邏輯中,如果聚合搜索查詢的結果為空,說明沒有空閑房間,玩家需要作為 owner 來創建新的房間,等待其它玩家加入。
創建房間的邏輯就是將約定好的字段,放進雲數據庫的記錄中。這些字段有:
- roomid<
String
>: 6 位房間號,唯一 - nextcolor<
"white" | "black"
>: 下一步是白棋/黑棋走 - chessmen<
String
>: 編碼后的棋盤數據 - createTimestamp<
String
>: 記錄創建時間戳,精確到 ms - people<
Number
>: 房間人數
是的,你可能注意到了,這里需要保證 roomid 是不重復的。因此本地生成的隨機 roomid,需要先調用雲數據庫的查詢接口,檢測是否存在。如果存在,那么遞歸調用,重新生成隨機字符串。
4.7 監聽玩家進入
對於 owner 身份來說,除了要創建新房間,還需要在創建后監聽 player 身份的玩家進入游戲。
對於 player 身份的玩家進入游戲后,會更新記錄中的 people 字段(1 => 2)。這時候就需要利用「實時數據庫」的功能,監聽遠程記錄的 people 字段變化。
代碼實現上,調用watch
方法,並且傳遞onChange
函數參數。一旦有任何風吹草動,都可以在onChange
回調函數中獲得。對於傳遞給回調函數的參數,有兩個比較重要:
- docChanges<
Array
>: 數組中的每一項對應每條記錄的變化類型,變化類型有 init、update、delete 等。 - docs<
Array
>: 數組中的每一項對應每條記錄的當前數據。
4.8 越權更新字段
對於 player 身份來說,進入房間后,既不需要「創建新房間」,也不需要「監聽玩家進入」。但需要更新記錄的 people 字段。由於記錄是由 owner 身份的玩家創建的,而雲數據庫只有以下 4 種權限:
- 所有用戶可讀,僅創建者可讀寫
- 僅創建者可讀寫
- 所有用戶可讀
- 所有用戶不可讀寫
以上 4 種權限,並沒有「所有用戶可讀寫」。因此,對於越權讀寫的情況,需要通過調用雲函數來以“管理員”的權限實現。在 cloudfunction
中創建 updateDoc
雲函數,接收前端傳來的 collection、docid、data 字段。對於 data 字段來說,就是數據記錄的最新更新數據。
在小游戲中,通過wx.cloud.callFunction
來調用雲函數。傳入的 data 字段指明被調用的雲函數,傳入的 data 字段可以在雲函數的回調函數的 event 參數中訪問到(如上圖所示)。
4.9 落子更新邏輯
不論對於 player 還是 owner 身份,都需要處理落子的邏輯。落子邏輯中,下面的兩種情況是屬於無效落子:
- 點擊位置已經有棋子
- 對方還未落子,目前依然處於等待情況
對於以上兩種情況,處理的邏輯分別是:
- 棋盤狀態保存在內部類中,調用落子的函數,會返回是否成功的字段標識
- 只有監聽到遠程棋盤更新后,才會打開本地的鎖,允許落子;落子后,會重新上鎖
落子成功后,要在本地判斷是否勝利。如果勝利,需要調用退出的邏輯。但無論是否勝利,都要將本地的最新狀態更新到雲端。
4.10 監聽遠程棋盤更新
不論對於 player 還是 owner 身份的玩家,都需要監聽遠程棋盤的更新邏輯。當遠程棋盤字段更新時,本地根據最新的棋盤狀態,重繪整個棋盤。並且進行輸贏判定,如果可以判定輸贏,則退出游戲;否則,打開本地的鎖,玩家可以落子。
因為不同身份均需要監聽,因此這一塊的監聽邏輯可以復用。不同的是,兩種身份的監聽啟動時間不一樣。owner 身份需要等待 player 身份玩家進入游戲后才開啟棋盤監聽;player 身份是更新了 people 字段后,開啟棋盤監聽。
在監聽邏輯中,需要判斷遠程更新的字段是否是 chessmen,這是通過前面提及的 dataType 來實現的。還徐喲啊判斷記錄中的 nextcolor 字段是否和本地的 color 一樣,來決定是否打開本地的鎖。
如果上述的兩個條件均滿足,則執行更新本地棋盤、判定輸贏、打開本地鎖的邏輯。
4.11 游戲結束與退出
每次需要判定輸贏的地方,如果可以判定輸贏,那么都會走到游戲退出邏輯。退出的邏輯分為 2 個部分,第 1 個是給用戶提示,第 2 個是調用雲函數清空記錄。
第 1 個邏輯中用戶提示,需要判定用戶勝負狀態:
第 2 個邏輯中清除記錄的原因是為了方便調試,對於真正的業務場景,一般不會刪除歷史數據,方便問題定位。同時,這也是一個越權操作,需要調用雲函數來實現。
6. 課程完整源碼
https://github.com/TencentCloudBase/tcb-game-gomoku
7. 聯系我們
雲開發(CloudBase)是一款雲端一體化的產品方案 ,采用 serverless 架構,免環境搭建等運維事務 ,支持一雲多端,助力快速構建小程序、Web應用、移動應用。
技術文檔:https://www.cloudbase.net/
更多雲開發使用技巧及 Serverless 行業動態,掃碼關注我們~