【轉】: 《江湖X》開發筆談 - 熱更新框架
前言
大家好,我們這期繼續借著我們工作室正在運營的在線遊戲《江湖X》來談一下熱更新機制以及我們的理解和解決方案。這裏先簡單的介紹一下熱更新的概念,熟悉這部分的朋友可以跳過,直接看我們的方案。
熱更新的概念
首先,“熱”是相對於“冷”而言的。所謂熱更新,即不更新遊戲安裝包體的情況下,在遊戲或遊戲啟動界面直接在線更新遊戲包體的機制。
一般的在線遊戲發布後,由於有需要修復BUG、發布更新內容等一系列需要,需要能夠盡快的將更新包發布到安裝本遊戲的用戶。以前單機時代的遊戲,一般是發布一個新的下載客戶端、或者基於當前客戶端的補丁包,玩家需要下載後,手動拖到原安裝文件夾中覆蓋某些核心文件。
手機網遊中熱更新系統的必要性
- 安裝包很費流量,每次更新整個安裝包,會由於流量等各種原因導致用戶流失
- 在線修復BUG,防止BUG事態擴大從而影響運營
- 第一時間在線更新內容,如果更新整個包,則去對接各個渠道都是一個麻煩事
- 很多渠道,尤其是appstore,更新包體需要超長時間的審核過程(近期appstore已加速了,然而還是最快需要約1天時間)
我們是怎麽做的?
1、更新包的版本管理
我們經常會看到一些遊戲,第一次啟動後,提示需要下載更新包。然而點了確定後,才發現是一系列的更新包。(比如當前更新到版本5了,則需要連續下載5個更新包。。。) 這樣的增量更新,我們認為版本管理起來是個麻煩事,從客戶端來說,實現一個增量邏輯,也是一個比較麻煩的事情。
在如今手機流量沒有之前那麽貴的情況下,我們為了簡單處理,我們是這樣定義版本的:
- 遊戲整體包,占三位版本號(如V1.1.12)
- 遊戲更新包,占第四位版本號(如V1.1.12(5))
- 每次更新遊戲整體包,我們都會將歷史上所有的更新包,隨大版本發布(大版本資源文件中包含),所以更新包版本可以清零。
- 遊戲更新包中,根據遊戲的業務邏輯拆分成若幹個文件,每個文件每次都是全量覆蓋
由於我們的更新版本一般不會含有大量的資源,我們可以控制在3MB以內。那麽這樣的好處是可以很方便管理,任何時候只用維護一個當前的整體版本和一個更新包。
2、避開appstore的限制
ios系統要求app內不能更新代碼,所以做遊戲的大家都知道,使用腳本語言來實現遊戲內的邏輯熱更,代價是會有執行的性能損耗。
1、我們使用了unity下最流行的熱更方案ulua,其支持動態綁定+wrap綁定,在性能和使用的自由度上有折中,確實是一個非常棒的方案。(雖然裏頭有許許多多的坑……都是一把辛酸淚趟過來的)
2、我們基於自己的遊戲設定特性,實現了一套比較靈活的狀態機語法、地圖編輯器。可以在不動代碼的情況下,實現各種遊戲核心邏輯。(當然,這也是我們用於拆分程序和策劃工作的核心,參考我之前寫的文章——《江湖X》開發筆談 - 談談配置表的那些事 )
3、熱更包的分發和加載邏輯
註:以下各個路徑,均為unity中術語。
- 隨版本發布的可被更新的數據文件,使用自己的打包方式或者unity的assetbundle打包,放在streamingAssets或Resources下
- 我們將熱更新包部署HTTP服務器上,架上CDN。
- 客戶端啟動後根據描述文件,決定是否要取熱更包,需要的話,去CDN拿更新包
- 下載熱更包後,放到自己的persistDataPath下。
- 啟動遊戲時,比較版本,決定從哪個路徑載入,或者做並集載入(一些增量更新的邏輯,我們的框架支持同時從streamingAsset/Resources/persistDataPath取並集)
4、數據安全
上述第三部的“描述文件”,我們使用的是一個部署在HTTP服務器上的XML文件;下載的assetbundle是unity默認打包文件;下載的自打包文件,是我們自己單獨定義的打包格式(一般是數據加密後protobuf序列化的文件),那麽這裏會有一些安全問題:
1、XML文件可能被篡改(修改本地的host,或者劫持DNS,可以欺詐客戶端,導向黑客自己的HTTP服務器)
2、下載的打包文件由於存儲在persisDataPath中,可能被篡改
我們的解決方式是:
1、客戶端啟動時需要校驗所有熱更新包的md5(StreamingAssets和Resources目錄由unity的機制保證不可修改,所以不需校驗),在連接服務器的時候,需要提交校驗結果,否則不予連接;
2、打包文件中重要數據均加密,客戶端代碼中不留密鑰。由連接的遊戲服務器動態下發。
3、遊戲服務器本身通信協議嚴格加密,每次建立session動態創建用於通信協議的對稱密鑰,每個客戶端每次連接服務器密鑰均不相同。
4、我們後續計劃將HTTP的XML文件改為一臺獨立的目錄服務器,用於實現更加安全的熱更新信息管理。
5、部分實現
最後共享一個我們的熱更新文件檢測同步器相關代碼,使用Init方法啟動檢測同步
/// <summary> /// 熱更新資源同步器 /// /// 用於同步及下載熱更新包 /// 說明:依次對比傳入的更新文件與本地緩存文件的md5 /// ,如果不一致,則下載並覆蓋。 /// /// 本地緩存不會計算文件的md5,只對比其md5索引文件(xxxx.md5) /// </summary> static public class ResourceSyncer { public static readonly string persisteDataPath = Application.persistentDataPath ; public static void Init(GameVersionInfo gv, Action callback){ _version = gv.version; _patches = gv.patches; _callback = callback; //同步臨時緩存目錄 SyncAssetbundles(); } static Action _callback = null; static private Patches _patches = null; static private string _version; static List<Patch> _tobeDownloadFiles = new List<Patch>(); /// <summary> /// 同步此版本下的ASSETBUNDLE熱更新資源 /// </summary> private static void SyncAssetbundles(){ if (_patches == null) { GlobalData.LocalPatchVersion = 0; DoCallback(); return; } _tobeDownloadFiles.Clear(); //統計需要下載的文件 foreach (var patch in _patches.files) { string filePath = Path.Combine(persisteDataPath, patch.name); string md5FilePath = Path.Combine(persisteDataPath, patch.name + ".md5"); //緩存中有文件 if (File.Exists(filePath) && File.Exists(md5FilePath)) { //檢測md5 string md5 = File.ReadAllText(md5FilePath); if (md5 == patch.md5) { Debug.Log(patch.name + " 緩存md5檢測一致,跳過下載"); } else { Debug.Log(patch.name + " 緩存md5不一致,刪除原文件並重新下載"); File.Delete(filePath); File.Delete(md5FilePath); _tobeDownloadFiles.Add(patch); //重新下載 } } else { //緩存中沒有文件,添加到下載列表 _tobeDownloadFiles.Add(patch); } } if (_tobeDownloadFiles.Count > 0) { UITools.ShowConfirmPanel(string.Format("有更新補丁,請下載\n\n{0}({1}) => {0}({2})\n({3})", CommonSettings.GAME_VERSION, GlobalData.LocalPatchVersion, _patches.version, _patches.size), "下載", "稍後", DoStartDownload, () => { Application.Quit(); }); } else { DoCallback(); } } private static void DoStartDownload(){ UITools.globalUI.StartCoroutine(StartDownload(()=>{ UITools.ShowMessageBox("錯誤","下載資源錯誤,請檢查網絡", Color.white, ()=>{ DoStartDownload(); }); })); } private static IEnumerator StartDownload(Action failCallback){ #if UNITY_ANDROID if(string.IsNullOrEmpty(persisteDataPath)) { UITools.ShowMessageBox("存儲路徑讀取失敗,您需要重啟手機,再運行遊戲。"); yield break; } #endif var files = _tobeDownloadFiles; int version = 0; int.TryParse(_version, out version); //依次下載 for(int i=files.Count-1;i>=0;--i) { var patch = files[i]; WWW www = new WWW(patch.getUrl()); currentWWW = www; Message = "正在下載更新包,請稍後.."; Debug.Log("開始下載" + patch.getUrl()); yield return www; if (www.isDone && string.IsNullOrEmpty(www.error)) { Debug.Log(www.url + " 下載完畢"); string filePath = Path.Combine(persisteDataPath, patch.name); string md5FilePath = Path.Combine(persisteDataPath, patch.name + ".md5"); File.WriteAllBytes(filePath, www.bytes); File.WriteAllText(md5FilePath, patch.md5); files.RemoveAt(i); //下載完成的文件,出列 } else { Debug.Log(www.url + " 下載失敗"); failCallback(); yield break; } } GlobalData.LocalPatchVersion = _patches.version; //回調 DoCallback(); } static void DoCallback(){ if (_callback != null) { _callback(); } } public static WWW currentWWW { get; private set;} public static string Message { get; private set;} }
【轉】: 《江湖X》開發筆談 - 熱更新框架