跳到主要内容

hybridclr Package手册

com.code-philosophy.hybridclr是一个Unity package，它提供了HybridCLR所需的Editor工作流工具脚本及Runtime脚本。借助 com.code-philosophy.hybridclr提供的工作流工具，打包一个支持HybridCLR热更新功能的App变得非常简单。hybridclr_unity包主要包含以下内容：

  • Editor相关脚本
  • Runtime相关脚本
  • iOSBuild脚本
警告

v3.0.0 之前的包名叫 com.focus-creative-games.hybridclr_unity。

HybridCLR菜单介绍​

以下子菜单均在菜单栏的HybridCLR菜单下，出于简化，我们下面提到子菜单时不再包含HybridCLR。

Installer...​

详细文档见安装HybridCLR。

Installer是一个方便的安装器，帮助正确设置本地il2cpp目录，其中包含替换HybridCLRData/LocalIl2CppData-{platform}/il2cpp/libil2cpp目录为HybridCLR修改版本。

安装界面中 安装状态：已安装|未安装 指示是否完成HybridCLR初始化。点击安装，如成功，则最后会显示安装成功日志，并且安装状态切换为已安装，否则请检查错误日志。

提示

如果已经安装HybridCLR，点击安装按钮会安装最新的HybridCLR版本的libil2cpp。

com.code-philosophy.hybridclr中 Data~/hybridclr_version.json 文件中已经配置了当前package版本对应的兼容 hybridclr及il2cpp_plus的分支或者tag， Installer会安装配置中指定的版本，不再支持自定义待安装的版本。

配置类似如下：

{
    "versions": [
    {
        "unity_version":"2019",
        "hybridclr" : { "branch":"v2.0.1"},
        "il2cpp_plus": { "branch":"v2019-2.0.1"}
    },
    {
        "unity_version":"2020",
        "hybridclr" : { "branch":"v2.0.1"},
        "il2cpp_plus": { "branch":"v2020-2.0.1"}
    },
    {
        "unity_version":"2021",
        "hybridclr" : { "branch":"v2.0.1"},
        "il2cpp_plus": { "branch":"v2021-2.0.1"}
    },
    {
        "unity_version":"2022",
        "hybridclr" : { "branch":"v2.0.1"},
        "il2cpp_plus": { "branch":"v2020-2.0.1"}
    }
    ]
}

如果你一定要安装其他版本的hybridclr或il2cpp_plus，修改该配置文件中的branch为目标分支或者tag。

install_default

从版本2.3.1起新增支持直接从本地自己制作的包含hybridclr的libil2cpp目录复制安装。如果你网络不好，或者没有安装git导致无法从仓库远程下载安装，则可以先将 il2cpp_plus和hybridclr下载到本地后，再根据下面安装原理小节的文档，由这两个仓库合并出含hybridclr的libil2cpp目录，接着在Installer安装界面中启用从本地复制libil2cpp选项，选择你制作的libil2cpp目录，再点击安装执行安装。如下图所示。

install

Compile Dll​

对于每个target，必须使用目标平台编译开关下编译出的热更新dll，否则会出现热更新代码与AOT主包或者热更新资源的代码信息不匹配的情况。

com.code-philosophy.hybridclr的HybridCLR.Editor程序集提供了HybridCLR.Editor.Commands.CompileDllCommand.CompileDll(BuildTarget target)接口， 方便开发者灵活地自行编译热更新dll。编译完成后的热更新dll放到 {project}/HybridCLRData/HotUpdateDlls/{platform} 目录下。

Generate​

Generate下包含打包时需要的生成命令。

Generate/Il2CppDef​

hybridclr代码要兼容多个Unity版本，需要当前Unity版本相关宏定义。Generate/Il2CppDef命令生成了相关版本宏及其他必须的代码，生成的代码类似如下。

// hybridclr/generated/UnityVersion.h

#define HYBRIDCLR_UNITY_VERSION 2020333
#define HYBRIDCLR_UNITY_2020 1
#define HYBRIDCLR_UNITY_2019_OR_NEW 1
#define HYBRIDCLR_UNITY_2020_OR_NEW 1

Generate/LinkXml​

扫描热更新dll引用的AOT类型，生成link.xml，避免热更新脚本用到的AOT类型或函数被裁剪。输出的文件路径在 HybridCLRSettings.asset中OuputLinkXml字段中指定，默认为LinkGenerator/link.xml。

更具体的裁剪相关介绍请看代码裁剪原理及解决办法。

Generate/AotDlls​

生成裁剪后的AOT dlls。脚本通过在一个临时目录导出工程，实现生成裁剪后的AOT dlls的目标。生成AOT dlls依赖于Generate/LinkXml和Generate/Il2CppDef。 如果你没有用 HybridCLR/Generate/All 这样的一键生成命令，请依次运行以下命令：

  • HybridCLR/Generate/Il2CppDef
  • HybridCLR/Generate/LinkXml
  • HybridCLR/Generate/AotDlls

Generate/MethodBridge​

根据当前的AOT dll集扫描生成桥接函数文件。相关文档请看桥接函数。

生成桥接函数依赖AOT dlls和热更新dlls。如果你没有用 HybridCLR/Generate/All 这样的一键生成命令，请依次运行以下命令：

  • HybridCLR/Generate/Il2CppDef
  • HybridCLR/Generate/LinkXml (隐含调用了 HybridCLR/CompileDll/ActiveBuildTarget)
  • HybridCLR/Generate/AotDlls
  • HybridCLR/Generate/MethodBridge

Generate/AOTGenericReference​

根据当前热更新dll扫描出所有产生的AOT泛型类型及函数的实例化，并生成一个启发的泛型实例化文件AOTGenericReferences.cs。 由于将扫描出的泛型类型及函数转换为对应的代码引用比较麻烦，生成的所有泛型实例化代码都是注释代码。

AOTGenericReferences.cs文件中还包含了应该补充元数据的assembly列表，类似如下，方便开发者不需要运行游戏也能快速知道应该补充哪些元数据。

    // {{ AOT assemblies
    // Main.dll
    // System.Core.dll
    // UnityEngine.CoreModule.dll
    // mscorlib.dll
    // }}

请在其他文件中添加泛型类型及函数的实例化引用，因为这个输出文件每次重新生成后会被覆盖。 这个泛型实例化文档只起到启发作用，告诉你可以aot泛型实例化哪些类和函数。 更具体的AOT泛型相关文档请看AOT泛型介绍。

提示

使用补充元数据机制后，不作任何处理也不影响正常运行。但如果手动对aot泛型实例化，可以提升性能。建议是对于少量性能敏感的类或函数手动泛型实例化即可，如Dictionary<int,int>之类。

由开发者自己酌情转换为正确的实例化引用（这个操作是可选的，可以完全不处理或只处理一部分），即在AOT代码中实例化这注释中的泛型类或泛型函数。方法大致如下：


    // System.Collections.Generics.List`1<System.Object>.ctor
    new List<object>();

    // System.Byte[] Array.Empty`1<System.Byte>()
    Array.Empty<byte>();

Generate/ReversePInvokeWrapper​

为标记了[MonoPInvokeCallback]注解的热更新C#静态函数生成ReversePInvokeWrapper函数。具体的MonoPInvokeCallback介绍请看文档MonoPInvokeCallback支持

Generate/All​

一键执行打包前必须的生成操作。

HybridCLR 配置​

点击菜单 HybridCLR/Settings 打开配置界面。下面是字段详细说明。

enable​

是否开启HybridCLR热更。默认true。如果为false，则打包不再包含HybridCLR功能。

警告

如果禁用HybridCLR，请同时也移除主工程中对HybridCLR.Runtime程序集的引用，否则打包时会出现RuntimeApi::LoadMetadataForAOTAssembly之类符号丢失的错误。

useGlobalIl2cpp​

是否使用全局安装位置，即editor安装位置下的il2cpp目录。默认false。一般只有打包WebGL时才需要useGlobalIl2cpp=true。

注意，就算 useGlobalIl2Cpp=true，安装时仍然会复制il2cpp到HybridCLRData目录。在复制前需要先运行HybridCLR/Generate/Il2CppDef生成版本宏， 再手动将 {project}/HybridCLRData/LocalIl2CppData-{platform}/il2cpp/libil2cpp目录替换 editor安装目录下的对应目录。 另外每次运行HybridCLR/Generate/*执行生成操作，输出目录仍然是本地目录，需要自己手动复制替换全局安装位置的libil2cpp目录。

hybridclrRepoURL​

hybridclr仓库的地址，默认值为 https://gitee.com/focus-creative-games/hybridclr。Installer安装时从此地址clone hybridclr仓库代码。

il2cppPlusRepoURL​

il2cpp_plus 仓库的地址，默认值为 https://gitee.com/focus-creative-games/il2cpp_plus。Installer安装时从此地址clone il2cpp_plus仓库代码。

hotUpdateAssemblyDefinitions​

以assembly definition(asmdef) 形式定义的热更新模块列表，它与下面的hotUpdateAssemblies是等效的，只不过编辑器下拖入asmdef模块比较方便，也不容易失误写错名称。

警告

hotUpdateAssemblyDefinitions和hotUpdateAssemblies合并后构成最终的热更新dll列表。同一个assembly不要在两个列表中同时出现，会报错！

hotUpdateAssemblies​

有一些assembly以dll形式存在，例如你在外部工程中创建的热更新dll，又如你直接使用Assembly-CSharp作为你的热更新dll。由于没有对应的asmdef文件，只能以dll名称形式手动配置。 填写assembly名称时不要包含'.dll'后缀，像Main、Assembly-CSharp这样即可。asmdef形式的assembly，你也可以选择不加到hotUpdateAssemblyDefinitions， 而是加到hotUpdateAssemblies。不过这样不如直接拖入列表方便，你自己酌情选择。

hotUpdateAssemblyDefinitions和hotUpdateAssemblies合并后构成最终的热更新dll列表。同一个assembly不要在两个列表中同时出现，会报错！

preserveHotUpdateAssemblies​

预留的热更新dll名字列表。有时候想在将来新增一些热更新dll，并且期望这些新的热更新dll的脚本能够挂载到资源上，如果直接将热更新dll名加到 hotUpdateAssemblies则会报assembly不存在的错误。 preserveHotUpdateAssemblies字段用来满足这种需求。打包时不检查这些dll的有效性，并且会将它们添加到scriptingassemblies.json之类的assembly列表文件中。 填写assembly名称时不要包含.dll后缀，像Assembly-CSharp这样即可。

hotUpdateDllCompileOutputRootDir​

编译后的热更新dll的输出根目录。最终输出目录在该目录的平台子目录下，即 ${hotUpdateDllCompileOutputRootDir}/{platform}。

externalHotUpdateAssemblyDirs​

自定义外部热更新dll的搜索路径。有一些框架或项目的热更新项目放到Unity外部，编译出的dll也在外部。这个参数提供了一个热更新dll 的搜索路径，这样不需要每次将外部dll复制到工程里或者复制到 hotUpdateAssemblies 目录了。

  • 按搜索路径的顺序搜索，排在越前的优先级越高。
  • 搜索路径必须是相对位置，相对于项目根目录（即Assets的上级目录）。即填mydir，搜索{proj}/mydir。
  • 每个路径dir，会先尝试搜索{dir}/{platform}，再尝试搜索{dir}。这样做为了兼顾平台特殊性及通用性。

下面展示一个使用示例。你有一个外部dll，它的位置为 {proj}/MyDir1/MyDir2/Foo.dll，则你应该：

  • 在 hotUpdateAssemblies 添加 Foo
  • 在 externalHotUpdateAssemblyDirs 里添加目录 MyDir1/Mydir2

strippedAOTDllOutputRootDir​

裁剪后的AOT dll的暂存目录。最终目录在该目录的平台子目录下，即 ${strippedAOTDllOutputRootDir}/{platform}。

patchAOTAssemblies​

补充元数据AOT dll列表。package本身没有用到这个配置项。它提供了一个配置AOT dll列表的地方，方便开发者在自己的打包流程中使用，这样就不用开发者单独再定义一个补充元数据AOT dll配置脚本了。 填写assembly名称时不要包含'.dll'后缀，像Main、Assembly-CSharp这样即可。

outputLinkFile​

运行菜单HybridCLR/Generate/LinkXml命令时，输出的link.xml文件路径。

警告

千万不要指向 Assets/link.xml，那个link.xml一般用来手动预留AOT类型，而这个自动输出的link.xml每次都会覆盖。

outputAOTGenericReferenceFile​

运行菜单HybridCLR/Generate/AOTGenericReference时输出的AOT泛型实例化集合文件的路径。

maxGenericReferenceIteration​

运行菜单HybridCLR/Generate/AOTGenericReference时，生成工具递归分析AOT泛型实例化的迭代次数。

因为泛型函数中可能会间接使用了新的泛型类和泛型函数，因此需要多轮迭代才能分析出所有的泛型实例化，maxGenericReferenceIteration参数用于控制迭代次数。这个参数一般10以内就够了，你通过观察日志 能看到几轮迭代后计算终止，如果迭代终止时还有大量泛型未计算迭代，可以适当增加这个值。

为什么不反复迭代直至计算出所有泛型实例化呢？因为有可能出现永远无法计算完的情况。如下代码，AOT.Show() 由于递归泛型实例化，永远也无法计算完。


    struct AOT<A>
    {

        public void Show()
        {
            var a = new AOT<AOT<A>>();
            a.Show();
        }
    }

maxMethodBridgeGenericIteration​

运行菜单HybridCLR/Generate/MethodBridge时，生成工具递归分析AOT泛型实例化的迭代次数。含义与maxGenericReferenceIteration相似。

Build Pipeline相关脚本​

主要包含以下功能：

  • 检查和修复设置
  • 打包时自动排除热更新assembly
  • 打包时将热更新dll名添加到assembly列表
  • 备份裁剪后的AOT dll

检查和修复设置​

属于打包工作流的一部分，相关代码在 Editor/BuildProcessors/CheckSettings.cs中。包含以下操作：

  • 根据是否开启HybridCLR，设置或者清除UNITY_IL2CPP_PATH环境变量。脚本中修改的UNITY_IL2CPP_PATH环境变量是本进程的环境变量，不用担心干扰了其他项目。
  • 如果低于（不含）v4.0.0版本，会检查并自动关闭增量式GC(Use Incremental GC) 选项
  • Scripting Backend 切换为 il2cpp, WebGL平台不用设置此选项。自v2.4.0起，会自动设置此选项，可以不用手动执行此操作。
  • Api Compatability Level 切换为 .NetFramework 4(Unity 2019、2020) 或 .Net Framework（Unity 2021+）
  • 如果HybridCLRSettings里未设置任何热更新assembly，提示错误。

打包时自动排除热更新assembly​

属于打包工作流的一部分，相关代码在 Editor/BuildProcessors/FilterHotFixAssemblies.cs中。

很显然，热更新assembly不应该被il2cpp处理并且编译到最终的包体里。我们处理了IFilterBuildAssemblies回调， 将热更新dll从build assemblies列表移除。脚本中会额外检查是否写错assembly名字，以及是否失误配置了重复的assembly。

打包时将热更新dll名添加到assembly列表​

属于打包工作流的一部分，相关代码在 Editor/BuildProcessors/PatchScriptingAssemblyList.cs中。

工具在打包时，会自动将热更新assembly的dll名加入assembly列表配置文件。热更新MonoBehaviour脚本所在的assembly的dll名必须添加到assembly列表配置文件， Unity的资源管理系统才能正确识别和还原热更新脚本。更详细的原理介绍请看 使用热更新MonoBehaviour 。

备份裁剪后的AOT dll​

属于打包工作流的一部分，相关代码在 Editor/BuildProcessors/CopyStrippedAOTAssemblies.cs中。

当补充元数据模式为HomologousImageMode::Consistent时，需要使用打包时生成的裁剪后的AOT dll。因此会自动将打包过程中生成的裁剪后的AOT dll 复制到 {project}/HybridCLRData/AssembliesPostIl2CppStrip/{platform}目录，方便将来处理。当数据模式为HomologousImageMode::SuperSet时， 可以直接使用原始的aot dll。这个优点是工作流上便利一些，不用每次打包后更新aot dll，缺点是多占了内存，同时大幅增加了裁剪dll的大小，请使用者自己权衡使用原始还是裁剪后的aot dll。

iOSBuild脚本​

package中 Editor/Data~/iOSBuild 包含了编译iOS版本libil2cpp.a所需的脚本。在运行HybridCLR/Installer...菜单命令成功初始化HybridCLR后，会自动复制到{project}/HybridCLRData/iOSBuild目录。 后续操作必须在{project}/HybridCLRData/iOSBuild目录进行。编译libil2cpp.a的具体操作请看文档 iOS平台打包。

Runtime相关脚本​

包含运行时用到的类。

LoadImageErrorCode​

加载热更新dll的错误码。

元数据模式 HomologousImageMode​

提示

推荐新手使用Super模式。在需要节约内存的场合，可以改用Consistent模式。

目前支持两种元数据模式。

HomologousImageMode::Consistent 模式​

即补充的dll与打包时裁剪后的dll精确一致。因此必须使用build过程中生成的裁剪后的dll，则不能直接复制原始dll。我们在HybridCLR.BuildProcessors.CopyStrippedAOTAssemblies里添加了处理代码，在打包时自动将这些裁剪后的dll复制到 {project}/HybridCLRData/AssembliesPostIl2CppStrip/{target} 目录。

HomologousImageMode::SuperSet 模式​

Consistent要求与裁剪后的dll精确一致，而generate/all中生成的裁剪aot dll与实际打包时生成的经常有微小差别，导致加载错误。SuperSet模式相比Consistent模式，对dll的一致性要求更低，只要补充元数据需要的类型和函数存在即可。

由于SuperSet模式使用放松的一致性，导致计算匹配更加复杂，需要维护更多相关元数据，占用更多内存。

RuntimeApi​

底层的操作HybridCLR的工具类。比较常用的有:

  • LoadImageErrorCode LoadMetadataForAOTAssembly(byte[] dllBytes, HomologousImageMode mode) 用于加载补充元数据assembly。

ReversePInvokeWrapperGenerationAttribute​

如果项目中用于xlua之类的脚本语言，对于要注册到lua中的C#函数，都需要添加[MonoPInvokeCallback]注解。这样可以为这些C#函数返回一个对应的c++ 函数指针，用于注册到脚本语言里。HybridCLR支持将热更新C#代码注册到lua中，但必须提前生成与[MonoPInvokeCallback]对应的C++桩函数，才可能为每个C#函数返回一个相应的C++函数指针。 脚本提供了自动生成桩函数的功能。详细请见 MonoPInvokeCallback支持 及 HybridCLR+lua/js/python 文档

每个带 [MonoPInvokeCallback] 特性的函数都需要一个唯一对应的wrapper函数。这些wrapper函数必须是打包时预先生成，不可变化。 因此如果后续热更新新增了 带 [MonoPInvokeCallback] 特性的函数，则会发生wrapper函数不足的情况。ReversePInvokeWrapperGenerationAttribute 用于为当前添加了 [MonoPInvokeCallback] 特性的函数预留指定数量的wrapper函数。在如下示例中，为LuaFunction签名的函数预留了10个wrapper函数。

    delegate int LuaFunction(IntPtr luaState);

    public class MonoPInvokeWrapperPreserves
    {
        [ReversePInvokeWrapperGeneration(10)]
        [MonoPInvokeCallback(typeof(LuaFunction))]
        public static int LuaCallback(IntPtr luaState)
        {
            return 0;
        }

        [MonoPInvokeCallback(typeof(Func<int, int, int>))]
        public static int Sum(int a, int b)
        {
            return a + b;
        }

        [MonoPInvokeCallback(typeof(Func<int, int, int>))]
        public static int Sum2(int a, int b)
        {
            return a + b;
        }

        [MonoPInvokeCallback(typeof(Func<int>))]
        public static int Sum3()
        {
            return 0;
        }
    }