Skip to content

MonoBehaviour

Jump to bottom
walon edited this page May 9, 2022 · 1 revision

热更新MonoBehaviour的工作流

文档中提及的代码文件在huatuo_trail

通过代码使用

AddComponent<T>()或者AddComponent(Type type)任何时候都是完美支持的。不需要像资源上挂载脚本那样做一些特殊处理。

在资源上挂载MonoBehaviour

如果想在资源上挂载热更新脚本，由于unity资源管理的限制，需要在打包时做少量特殊处理。

原理

Unity资源管理在反序列化资源中的脚本时，要求满足两个条件

  • 脚本所在的dll必须在打包生成的 ScriptingAssemblies.json中存在。这个列表是unity启动时即加载的，不可变数据。
  • 脚本所有的dll已经加载到AppDomain中

如果对打包流程不作任何改变，由于热更新dll肯定不会出现在ScriptingAssemblies.json中，挂载在热更新资源中的热更新脚本肯定是无法被 还原的，因此我们在 HuaTuo_BuildProcessor_XXX脚本中处理了OnPostprocessBuild事件，把热更新dll加入到json文件的dll列表中。具体 操作为把你项目中包含希望挂在资源上的热更新MonoBehaviour的dll加入到 s_monoHotUpdateDllNames中。

由于只需要满足这两个条件即成正确恢复资源上的脚本，热更新脚本可以按照项目需求自由选择热更新方式，可以将dll打包到ab中，或者裸数据 文件，或者加密压缩等等。只要能保证在加载热更新资源前使用Assembly.Load将其加载即可。

另外，为了不让热更新dll在打包时导出，标准做法是需要将热更新dll标记为editor以及至少一个其他平台(如XBox)。不能只有Editor，因为如果某个 assembly def只导出给editor目标，则Unity会认为它是纯editor模块，Unity不允许加载editor模块的MonoBehaviour到GameObject上。但这么做 比较麻烦，因此我们又在 HuaTuo_BuildProcessor_XXX 脚本中处理了 IFilterBuildAssemblies.OnFilterAssemblies 事件，将热更新dll忽略。 这样一样，直接将热更新assembly def像普通的assembly那样，标记为导出给所有平台，也不会在打包时导出了。具体操作为把你的除了s_monoHotUpdateDllNames 以外的热更新dll加入s_allHotUpdateDllNames列表。

示例如下图:

 public class HuaTuo_BuildProcessor_2020_1_OR_NEWER : IPreprocessBuildWithReport, IPostprocessBuildWithReport
#if UNITY_ANDROID
        , IPostGenerateGradleAndroidProject
#endif
        , IProcessSceneWithReport, IFilterBuildAssemblies, IPostBuildPlayerScriptDLLs, IUnityLinkerProcessor
    {
        /// <summary>
        /// 需要在Prefab上挂脚本的热更dll名称列表，不需要挂到Prefab上的脚本可以不放在这里
        /// 
        /// 另外请务必注意！： 需要挂脚本的dll的名字最好别改，因为这个列表无法热更（上线后删除或添加某些非挂脚本dll没问题）
        /// </summary>
        static List<string> s_monoHotUpdateDllNames = new List<string>()
        {
            "HotFix.dll",
        };

        /// <summary>
        /// 所有热更新dll列表
        /// </summary>
        static List<string> s_allHotUpdateDllNames = s_monoHotUpdateDllNames.Concat(new List<string>
        {
            // 这里放除了s_monoHotUpdateDllNames以外的脚本不需要挂到资源上的dll列表
            "HotFix2.dll",
        }).ToList();
    }

准备工作

  • 将huatuo_trial项目中Assets/Editor/Huatuo复制到你项目的某个Editor目录，假设为Assets/Editor/HuaTuo

  • 根据项目Unity版本不同，打开文件 Assets/Editor/HuaTuo/HuaTuo_BuildProcessor_2020_1_OR_NEWER.cs 或 HuaTuo_BuildProcessor_2019.cs，将需要在资源上挂脚本的所在热更dll名称填入 monoDllNames 字段，示例:

        static List<string> monoDllNames = new List<string>() { "HotFix.dll"};

  • 在挂热更脚本的任意一个资源加载之前，加载热更dll，示例代码如下:

        #if !UNITY_EDITOR
        // 只有打包后才需要加载 HotFix.dll
        AssetBundle dllAB = BetterStreamingAssets.LoadAssetBundle("huatuo");
        TextAsset dllBytes = dllAB.LoadAsset<TextAsset>("HotFix.bytes");
        gameAss = System.Reflection.Assembly.Load(dllBytes.bytes);
    #endif

        // 加载热更dll之后再加载挂了热更脚本的资源
        AssetBundle resAB = BetterStreamingAssets.LoadAssetBundle("artRes");
        GameObject go = resAB.LoadAsset<GameObject>("myPrefab");
        Instantiate(go);

打包流程

正常打包即可，但有几个注意事项

  • dll可以自由选择AssetBundle或者StreamingAssets或者其他方式更新。如需要把热更dll打包成ab，可参见示例 Assets/Editor/HuaTuo/HuaTuoEditorHelper.cs

  • 建议打AB时不要禁用TypeTree，否则普通的AB加载方式会失败。（原因是对于禁用TypeTree的脚本，Unity为了防止二进制不匹配导致反序列化MonoBehaviour过程中进程Crash，会对脚本的签名进行校验，签名的内容是脚本FullName及TypeTree数据生成的Hash, 但由于我们的热更脚本信息不存在于打包后的安装包中，因此校验必定会失败）

  • 如果必须要禁用TypeTree，一个变通的方法是禁止脚本的Hash校验, 此种情况下用户必须保证打包时代码与资源版本一致，否则可能会导致Crash，示例代码

        AssetBundleCreateRequest req = AssetBundle.LoadFromFileAsync(path);
    req.SetEnableCompatibilityChecks(false); // 非public，需要通过反射调用

其它

  • 不支持reload dll。想重新加载一个dll只能重启。
  • 需要被挂到资源上的脚本所在dll名称（monoDllNames）请事先预留好，上线后勿修改，因为这个列表是无法热更的
Clone this wiki locally