diff --git a/docs/basic/impactonappsize.md b/docs/basic/impactonappsize.md new file mode 100644 index 000000000..e81e21f97 --- /dev/null +++ b/docs/basic/impactonappsize.md @@ -0,0 +1,75 @@ +# 对App包体影响 + +接入hybridclr后，会轻微地增加包体，主要由以下几部分构成： + +1. hybridclr除了MethodBridge.cpp以外的主体代码 +2. 桥接函数文件MethodBridge.cpp代码 +3. il2cpp将HybridCLR.Runtime.dll代码翻译后的cpp代码 + +其中第1部分代码不到3万行，第3部分代码不到2000行，它们对最终包体的影响很小，而MethodBridge.cpp是根据AOT程序集计算生成的，一般来说，如果AOT程序集代码越多，MethodBridge.cpp +文件大小会越大。一般来说，根据项目AOT模块的复杂度，MethodBridge.cpp文件大小在2M-40M之间。 + +我们构建了测试项目测试hybridclr对包体的实际影响。 + +## 测试 + +我们在Unity 2021版本测试了构建的Android Armv8平台apk的大小。 + +测试工程的AOT部分完整包含了以下框架和库： + +- mscorlib、System、System.Core +- UnityEngine.dll、UnityEngine.CoreModule.dll、UnityEngine.UI.dll、UnityEngine.PhysicsModule.dll +- [GameFramework框架](https://github.com/EllanJiang/GameFramework) +- HybridCLR.Runtime.dll +- [Luban](https://github.com/focus-creative-games/luban) +- [UniTask](https://github.com/Cysharp/UniTask) +- [YooAsset](https://github.com/tuyoogame/YooAsset) + +我们统计了构建完apk后AOT模块dll的总大小：共12.0M。 + +测试工程的热更新部分代码以下部分构成： + +- 单元测试工程代码 +- Luban生成的配置代码 + +编译后的HotUpdate.dll为1216k。为了公平起见，接入HybridCLR的项目会将热更新dll压缩后放入StreamingAssets承包携带。 + +我们对比了以下6种情况的包体： + +- NotHybridCLR-NotHotUpdateCode 未接入HybridCLR、未包含HotUpdate代码（即未将HotUpdate包含到AOT中） +- HybridCLR-NotHotUpdateCode-NotMethodBridge 接入HybridCLR、不包含HotUpdate代码，桥接函数文件为空 +- HybridCLR-NotHotUpdateCode-MethodBridge 接入HybridCLR、不包含HotUpdate代码，正常生成桥接函数文件 +- NotHybridCLR-HotUpdateCode 未接入HybridCLR、包含HotUpdate代码（即将HotUpdate包含到AOT中） +- NotHybridCLR-HOtUpdateCode-NotMethodBridge 接入HybridCLR、包含HotUpdate代码（将HotUpdate.dll压缩后放到StreamingAssets承包携带），桥接函数文件为空 +- NotHybridCLR-HotUpdateCode-MethodBridge 接入HybridCLR、包含HotUpdate代码，正常生成桥接函数文件 + +测试数据如下： + +|构建方式|Apk大小（K）|global-metadata.dat（未压缩）|global-metadata.dat（压缩）|libil2cpp.so（未压缩）|libil2cpp.so（压缩）|HotUpdate.dll大小（未压缩）（K）|MethodBridge.cpp大小（K）| +|-|-|-|-|-|-|-|-|-| +|NotHybridCLR-NotHotUpdateCode|30066|10087740|2980934|73383680|18954786|0|0| +|HybridCLR-NotHotUpdateCode-NotMethodBridge|30262|10075360|2904652|74026488|19158769|0|0| +|HybridCLR-NotHotUpdateCode-MethodBridge|30900|10075360|2904652|78450168|19905020|0|15082| +|NotHybridCLR-HotUpdateCode|31718|10893056|3103289|79670208|20387018|1206|0| +|NotHybridCLR-HotUpdateCode-NotMethodBridge|30531|10081232|29006522|74158928|19177165|1206|0| +|NotHybridCLR-HotUpdateCode-MethodBridge|31259|10081232|29006522|78492496|19920506|1206|14861| + +> `未压缩` 指在apk内该文件的原始大小，`压缩` 指在apk内该文件压缩后的大小 + +热更新代码HotUpdate.dll原始大小的1216k，压缩后为200k。 + +根据以上测试项目，我们大约可以得出以下结论： + +- HybridCLR不含MethodBridge.cpp的主体部分最终增加了196k包体 +- 桥接函数文件增加了大约 `{MethodBridge.cpp大小} * 0.049` 包体大小 +- 每新增大小为S的游戏代码，对于没接入HybridCLR的App，增加了`S * 1.37`包体大小 +- 每增加大小为S的游戏代码，对于接入HybridCLR的App，增加了`S * 0.2`包体大小 + +## 总结 + +接入HybridCLR增加了`196k + {桥接函数文件大小}*0.049` 大小的包体，但将游戏代码从AOT中移到热更新后能减少`{热更新dll大小}*1.17`倍包体。 + +这意味着，如果一个项目热更新代码超过800K-1500K，接入HybridCLR后最终包体会比未接入HybridCLR小。最终减少的包体可以简略地使用 `热更新dll大小*1.05`近似计算。 + +对于社区版、专业版、热重载版本以上结论均适用，对于旗舰版本，由于DHE程序集也被编译到AOT中，所以旗舰版本会导致包体整体增加，相比于未接入增加了2-5M包体。 + diff --git a/i18n/en/docusaurus-plugin-content-docs/current/basic/impactonappsize.md b/i18n/en/docusaurus-plugin-content-docs/current/basic/impactonappsize.md new file mode 100644 index 000000000..a0f1aea99 --- /dev/null +++ b/i18n/en/docusaurus-plugin-content-docs/current/basic/impactonappsize.md @@ -0,0 +1,73 @@ +# Impact On the App Size + +After integrating HybridCLR, there is a slight increase in package size, mainly due to the following components: + +1. The core code of HybridCLR, excluding MethodBridge.cpp. +2. The bridge function file MethodBridge.cpp. +3. The cpp code generated by il2cpp from the HybridCLR.Runtime.dll code. + +Among these, the code in part 1 is less than 30,000 lines, and the code in part 3 is less than 2,000 lines, which have minimal impact on the final package size. The size of MethodBridge.cpp is calculated based on the AOT assemblies. Generally, the larger the AOT assemblies, the larger the MethodBridge.cpp file. Typically, depending on the complexity of the project’s AOT modules, the size of MethodBridge.cpp ranges from 2MB to 40MB. + +We conducted a test project to measure the actual impact of HybridCLR on package size. + +## Testing + +We tested the package size of an Android Armv8 platform APK built with Unity 2021. + +The AOT portion of the test project fully includes the following frameworks and libraries: + +- mscorlib, System, System.Core +- UnityEngine.dll, UnityEngine.CoreModule.dll, UnityEngine.UI.dll, UnityEngine.PhysicsModule.dll +- [GameFramework Framework](https://github.com/EllanJiang/GameFramework) +- HybridCLR.Runtime.dll +- [Luban](https://github.com/focus-creative-games/luban) +- [UniTask](https://github.com/Cysharp/UniTask) +- [YooAsset](https://github.com/tuyoogame/YooAsset) + +We calculated the total size of the AOT module DLLs in the built APK: 12.0MB. + +The hot-update portion of the test project includes the following: + +- Unit test project code. +- Configuration code generated by Luban. + +The compiled HotUpdate.dll is 1216KB. To ensure fairness, the hot-update DLLs in projects integrated with HybridCLR are compressed and included in the StreamingAssets package. + +We compared the package size across the following six scenarios: + +- NotHybridCLR-NotHotUpdateCode: Without HybridCLR integration and without including HotUpdate code (HotUpdate is not part of AOT). +- HybridCLR-NotHotUpdateCode-NotMethodBridge: Integrated with HybridCLR, without HotUpdate code, and with an empty bridge function file. +- HybridCLR-NotHotUpdateCode-MethodBridge: Integrated with HybridCLR, without HotUpdate code, and with a normal bridge function file. +- NotHybridCLR-HotUpdateCode: Without HybridCLR integration and with HotUpdate code included (HotUpdate is part of AOT). +- NotHybridCLR-HotUpdateCode-NotMethodBridge: Integrated with HybridCLR, with HotUpdate code included (compressed HotUpdate.dll in the StreamingAssets package), and with an empty bridge function file. +- NotHybridCLR-HotUpdateCode-MethodBridge: Integrated with HybridCLR, with HotUpdate code included, and with a normal bridge function file. + +The test data is as follows: + +| Build Type | APK Size (KB) | global-metadata.dat (Uncompressed) | global-metadata.dat (Compressed) | libil2cpp.so (Uncompressed) | libil2cpp.so (Compressed) | HotUpdate.dll Size (Uncompressed, KB) | MethodBridge.cpp Size (KB) | +|-------------------------------------------|---------------|------------------------------------|-----------------------------------|-----------------------------|---------------------------|---------------------------------------|----------------------------| +| NotHybridCLR-NotHotUpdateCode | 30066 | 10087740 | 2980934 | 73383680 | 18954786 | 0 | 0 | +| HybridCLR-NotHotUpdateCode-NotMethodBridge| 30262 | 10075360 | 2904652 | 74026488 | 19158769 | 0 | 0 | +| HybridCLR-NotHotUpdateCode-MethodBridge | 30900 | 10075360 | 2904652 | 78450168 | 19905020 | 0 | 15082 | +| NotHybridCLR-HotUpdateCode | 31718 | 10893056 | 3103289 | 79670208 | 20387018 | 1206 | 0 | +| NotHybridCLR-HotUpdateCode-NotMethodBridge| 30531 | 10081232 | 29006522 | 74158928 | 19177165 | 1206 | 0 | +| NotHybridCLR-HotUpdateCode-MethodBridge | 31259 | 10081232 | 29006522 | 78492496 | 19920506 | 1206 | 14861 | + +> `Uncompressed` indicates the original size of the file within the APK, and `Compressed` indicates the compressed size within the APK. + +The original size of the hot-update code HotUpdate.dll is 1216KB, which is compressed to 200KB. + +Based on the above test project, we can draw the following conclusions: + +- The core part of HybridCLR, excluding MethodBridge.cpp, increases the package size by 196KB. +- The bridge function file increases the package size by approximately `{MethodBridge.cpp Size} * 0.049`. +- For every additional size `S` of game code, an app without HybridCLR integration increases in size by `S * 1.37`. +- For every additional size `S` of game code, an app with HybridCLR integration increases in size by `S * 0.2`. + +## Summary + +Integrating HybridCLR increases the package size by `196KB + {MethodBridge.cpp Size} * 0.049`. However, moving game code from AOT to hot updates can reduce the package size by `{HotUpdate.dll Size} * 1.17`. + +This means that if the hot-update code in a project exceeds 800KB-1500KB, integrating HybridCLR results in a smaller final package size than without it. The total package size reduction can be approximately calculated as `HotUpdate.dll Size * 1.05`. + +The above conclusions apply to the Community, Professional, and Hot Reload versions. For the Flagship version, since DHE assemblies are also compiled into AOT, the Flagship version increases the overall package size by 2-5MB compared to not integrating HybridCLR. diff --git a/sidebars.js b/sidebars.js index cb0e36595..064c08833 100644 --- a/sidebars.js +++ b/sidebars.js @@ -62,6 +62,7 @@ const sidebars = { 'basic/dots', 'basic/memory', 'basic/performance', + 'basic/impactonappsize', 'basic/notsupportedfeatures', 'basic/com.code-philosophy.hybridclr', 'basic/bestpractice',