【轉】: 《江湖X》開發筆談 - 熱更新框架

前言

你們好，咱們這期繼續借着咱們工做室正在運營的在線遊戲《江湖X》來談一下熱更新機制以及咱們的理解和解決方案。這裏先簡單的介紹一下熱更新的概念，熟悉這部分的朋友能夠跳過，直接看咱們的方案。

熱更新的概念

首先，「熱」是相對於「冷」而言的。所謂熱更新，即不更新遊戲安裝包體的狀況下，在遊戲或遊戲啓動界面直接在線更新遊戲包體的機制。

通常的在線遊戲發佈後，因爲有須要修復BUG、發佈更新內容等一系列須要，須要可以儘快的將更新包發佈到安裝本遊戲的用戶。之前單機時代的遊戲，通常是發佈一個新的下載客戶端、或者基於當前客戶端的補丁包，玩家須要下載後，手動拖到原安裝文件夾中覆蓋某些核心文件。

手機網遊中熱更新系統的必要性

• 安裝包很費流量，每次更新整個安裝包，會因爲流量等各類緣由致使用戶流失
• 在線修復BUG，防止BUG事態擴大從而影響運營
• 第一時間在線更新內容，若是更新整個包，則去對接各個渠道都是一個麻煩事
• 不少渠道，尤爲是appstore，更新包體須要超長時間的審覈過程（近期appstore已加速了，然而仍是最快須要約1天時間）

咱們是怎麼作的？

一、更新包的版本管理

咱們常常會看到一些遊戲，第一次啓動後，提示須要下載更新包。然而點了肯定後，才發現是一系列的更新包。（好比當前更新到版本5了，則須要連續下載5個更新包。。。） 這樣的增量更新，咱們認爲版本管理起來是個麻煩事，從客戶端來講，實現一個增量邏輯，也是一個比較麻煩的事情。

在現在手機流量沒有以前那麼貴的狀況下，咱們爲了簡單處理，咱們是這樣定義版本的：

• 遊戲總體包，佔三位版本號（如V1.1.12）
• 遊戲更新包，佔第四位版本號（如V1.1.12(5)）
• 每次更新遊戲總體包，咱們都會將歷史上全部的更新包，隨大版本發佈（大版本資源文件中包含），因此更新包版本能夠清零。
• 遊戲更新包中，根據遊戲的業務邏輯拆分紅若干個文件，每一個文件每次都是全量覆蓋

因爲咱們的更新版本通常不會含有大量的資源，咱們能夠控制在3MB之內。那麼這樣的好處是能夠很方便管理，任什麼時候候只用維護一個當前的總體版本和一個更新包。

二、避開appstore的限制

ios系統要求app內不能更新代碼，因此作遊戲的你們都知道，使用腳本語言來實現遊戲內的邏輯熱更，代價是會有執行的性能損耗。

一、咱們使用了unity下最流行的熱更方案ulua，其支持動態綁定+wrap綁定，在性能和使用的自由度上有折中，確實是一個很是棒的方案。（雖然裏頭有許許多多的坑……都是一把辛酸淚趟過來的）

二、咱們基於本身的遊戲設定特性，實現了一套比較靈活的狀態機語法、地圖編輯器。能夠在不動代碼的狀況下，實現各類遊戲核心邏輯。（固然，這也是咱們用於拆分程序和策劃工做的核心，參考我以前寫的文章——《江湖X》開發筆談 - 談談配置表的那些事 ）

三、熱更包的分發和加載邏輯

注：如下各個路徑，均爲unity中術語。

• 隨版本發佈的可被更新的數據文件，使用本身的打包方式或者unity的assetbundle打包，放在streamingAssets或Resources下
• 咱們將熱更新包部署HTTP服務器上，架上CDN。
• 客戶端啓動後根據描述文件，決定是否要取熱更包，須要的話，去CDN拿更新包
• 下載熱更包後，放到本身的persistDataPath下。
• 啓動遊戲時，比較版本，決定從哪一個路徑載入，或者作並集載入（一些增量更新的邏輯，咱們的框架支持同時從streamingAsset/Resources/persistDataPath取並集）

四、數據安全

上述第三部的「描述文件」，咱們使用的是一個部署在HTTP服務器上的XML文件；下載的assetbundle是unity默認打包文件；下載的自打包文件，是咱們本身單獨定義的打包格式（通常是數據加密後protobuf序列化的文件），那麼這裏會有一些安全問題：

一、XML文件可能被篡改（修改本地的host，或者劫持DNS，能夠欺詐客戶端，導向黑客本身的HTTP服務器）
二、下載的打包文件因爲存儲在persisDataPath中，可能被篡改

咱們的解決方式是：

一、客戶端啓動時須要校驗全部熱更新包的md5（StreamingAssets和Resources目錄由unity的機制保證不可修改，因此不需校驗），在鏈接服務器的時候，須要提交校驗結果，不然不予鏈接；
二、打包文件中重要數據均加密，客戶端代碼中不留密鑰。由鏈接的遊戲服務器動態下發。
三、遊戲服務器自己通訊協議嚴格加密，每次創建session動態建立用於通訊協議的對稱密鑰，每一個客戶端每次鏈接服務器密鑰均不相同。
四、咱們後續計劃將HTTP的XML文件改成一臺獨立的目錄服務器，用於實現更加安全的熱更新信息管理。

五、部分實現

最後共享一個咱們的熱更新文件檢測同步器相關代碼，使用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;}
    }