: 《江湖X》开发笔谈 - 热更新框架

Posted 2020-10-16 colourstar

前言

大家好，我们这期继续借着我们工作室正在运营的在线游戏《江湖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;}
    }