当前位置：首页 > news >正文

Unity 代码裁剪（Strip Engine Code）

news 文章来源：https://blog.csdn.net/weixin_45136016/article/details/142645717 2024/12/26 8:45:09

文章目录

0.IL2CPP 打包运行闪退问题
1.什么是代码裁剪
2.为什么要使用代码裁剪
3.代码裁剪设置与级别
4.强制保留代码
- 4.1 使用[Preserve]标签
- 4.2 使用Link.xml文件
5.Strip中遇到的问题及解决方法
6.注意事项

0.IL2CPP 打包运行闪退问题

Google Play要求从2019年8月1日起apk必须支持64位CPU, 否则就下架或不让上. 使apk支持ARM64就需要把Scripting Backend由Mono切换为IL2CPP
在这里插入图片描述
那么问题来了, 通过IL2CPP打出的包往往不能正常运行(闪退,报错).

其原因就是, BuildSetting里默认勾选了代码裁剪, 取消勾选打出的apk就能正常运行,但是包体也会变大

1.什么是代码裁剪

官方文档
简而言之：开启代码裁剪，能够在build时将项目中没有用到的代码裁减掉，以减少build出的代码量。
Strip的主要作用在于裁剪系统库、Unity引擎代码、插件代码，往往它们包含了大量对工程无用的代码。
勾选代码裁剪,构建时Unity代码裁剪工具会分析项目中的程序集,查找和删除未使用的代码. 裁剪掉没有使用到的代码.比如,一款2D游戏只用到了Sprite, 2D物理组件, 就可以把没有用到的3D物理代码部分裁剪掉. 使用裁剪功能可以显著减小包体大小, 也是目前Unity游戏包体优化的一个重要环节.

2.为什么要使用代码裁剪

显著减小包体大小：开启代码裁剪，在build时将项目中没有用到的代码裁减掉，以减少build出的代码量
加快cpp生成的过程：如果使用了il2cpp，由于build过程中先生成CIL然后再生成cpp代码。所以开启代码裁减之后，能减少CIL的生成，从而加快cpp生成的过程。

3.代码裁剪设置与级别

File->Build Settings->Player Settings->Optimization->Managed Stripping Level

属性	功能
Disabled	Unity 不会删除任何代码。此设置仅可见，并且是使用 Mono 脚本后端时的默认设置。
Minimal	Unity 仅在 UnityEngine 和 .NET 类库中搜索未使用的代码。Unity 不会删除任何用户编写的代码。此设置最不可能导致任何意外的运行时行为。此设置对于可用性比构建大小更重要的项目很有用。如果您使用 IL2CPP 脚本后端，这是默认设置。
Low	Unity 会搜索部分用户编写的程序集以及所有 UnityEngine 和 .NET 类库以查找未使用的代码。此设置会应用一组规则，删除部分未使用的代码，但会将出现意外后果的可能性降至最低，例如使用反射的运行时代码的行为发生变化。
Medium	Unity 会部分搜索所有程序集以查找无法访问的代码。此设置应用一组规则，可删除更多类型的代码模式以减小构建大小。虽然 Unity 不会删除所有可能无法访问的代码，但此设置确实会增加不良或意外行为更改的风险。
High	Unity 会对所有程序集进行广泛搜索，以查找无法访问的代码。在此设置下，Unity 优先考虑减小尺寸而不是代码稳定性，并删除尽可能多的代码。此搜索可能比较低的剥离级别花费更长的时间。仅对紧凑构建大小极其重要的项目使用此设置。彻底测试您的应用程序并谨慎使用[Preserve]属性和 link.xml 文件，以确保 Unity 链接器不会剥离重要代码。

Tips: 等级越高裁剪掉的代码越多, 包体也就越小, 但是对应的风险也就更大:

4.强制保留代码

4.1 使用[Preserve]标签

可以对Assembly、Type、Field、Properties、Method使用。

4.2 使用Link.xml文件

在项目的Assets目录下创建个link.xml
保留整个程序集dll：

<?xml version="1.0" encoding="UTF-8"?>
<linker><assembly fullname="DOTween" preserve="all" />              <!-- 保留 DOTween --><assembly fullname="Newtonsoft.Json" preserve="all" />      <!-- 保留 Newtonsoft.Json --><assembly fullname="Assembly-CSharp" preserve="all" />      <!-- 保留我们写的项目代码 -->
</linker>

保留某个程序集里的某个类:

<assembly fullname="UnityEngine"><type fullname="UnityEngine.SpriteRenderer" preserve="all"/><type fullname="UnityEngine.Rigidbody2D" preserve="all"/>
</assembly>

5.Strip中遇到的问题及解决方法

1. 类型转换错误

InvalidCastException: Unable to cast object of type ‘BehaviourTree’ to type ‘DialogueTree’.

对于该类型错误，无法有效的确定错误原因（以NodeCanvas为例，对错误的实例进行类型转换的逻辑流程无法准确定位，可能与NodeCanvas对行为树资源反序列化的实现有关），最直接的办法是将整个模块的Namespace包含到link中以避免此类问题。
（同时可以对官方示例进行同等级的strip，尝试更仔细的解决问题，通常官方示例因为体量小，能更快的进行build迭代和测试）。

2. 无法为抽象类创建对象

Exception: Cannot create an instance of an interface or abstract type for NodeCanvas.Framework.ActionTask。

通常原因在于其实现类没有被保留下来。报错定位依然不明确。解决办法同上。

3. 无法解析符号

Type with name ‘NodeCanvas.Tasks.Actions.PlayerActions.AnimationAction’ could not be resolved.

其中指出的符号，即类型、方法、属性等，因为没有被保留下来，导致进行反射调用时无法确定符号意义导致的问题。解决方法很明确，就是将符号写入link.xml以在strip过程中保留。

**4. 找不到Class ID对应的类型

ReportException: UnityLogError Could not produce class with ID 134.

通常是因为Unity引擎的代码被Strip掉了，导致在程序运行时找不到对应的类。对此类问题比较方便的一点在于，错误信息给出了具体的类（https://docs.unity3d.com/Manual/ClassIDReference.html），要解决问题只需要将查表找到的Class加入到link.xml即可。

6.注意事项

link.xml配置是根据程序集而不是根据名字空间，例如UnityEngine.Animator，在VisualStudio中跳转到Animator类会发现，它是属于UnityEngine.AnimationModule程序集，而不是UnityEngine程序集。如果配置到错误的程序集自然就不能正确保留该类防止被裁剪。
如保留Animator类，如下方式是无效的：

<assembly fullname="UnityEngine" preserve="all"/>

正确方式应该是：

<assembly fullname="UnityEngine.AnimationModule" preserve="all"/>

Unity项目Build后会在项目Library的子目录，如Library\Bee\artifacts\Android\ManagedStripped下生成项目依赖（没用上的会被裁剪）的全部程序集(不同版本Unity或不同平台生成程序集位置不同)，这样就可以确定需要保留哪些程序集。

il2cpp代码裁剪(Strip Engine Code)配置工具：https://blog.csdn.net/final5788/article/details/126451377