参考链接:
Unity-Managed code stripping
Unity-Managed bytecode stripping with IL2CPP
简而言之,Code Strip就是代码裁剪。开启代码裁剪,能够在build时将项目中没有用到的代码裁减掉,以减少build出的代码量。
如果使用了il2cpp,由于build过程中先生成CIL然后再生成cpp代码。所以开启Managed code stripping之后,能减少CIL的生成,从而加快cpp生成的过程。
Strip的主要作用在于裁剪系统库、Unity引擎代码、插件代码,往往它们包含了大量对工程无用的代码。
开启方法
在Unity编辑器的File->Build Settings->Player Settings可以设置Managed Stripping Level。
(PC平台)有4个选项可供选择:Disable(默认),Low,Medium,High。
(iOS平台)没有Disable选项,默认为Low,但提供了Strip Engine Code的选项。
各个Level对不同代码的裁剪规则不同,具体内容可以看上面第一个链接。
强制保留
因为UnityLinker进行strip的逻辑原因,代码中使用反射调用(没有直接引用)的类和属性等也会被裁剪掉,这样会导致运行时错误。
Unity提供了两种方法来标记需要强制保留的代码:
- 使用[Preserve]标签,可以对Assembly、Type、Field、Properties、Method使用。
- 使用Link.xml文件,在文件中写明需要保留的代码,使用范围同上,还可以标记保留整个Namespace。
对比
这里使用新工程做一个测试,对新工程设置不同的strip level,然后在iOS平台build出xCode工程。对比xCode工程的Classes/Native中代码的数量:
-
low:72.7M(74项)
-
high:54.5M(62项)
strip中遇到的问题及解决方法
类型转换错误
InvalidCastException: Unable to cast object of type 'BehaviourTree' to type 'DialogueTree'.
对于该类型错误,无法有效的确定错误原因(以NodeCanvas为例,对错误的实例进行类型转换的逻辑流程无法准确定位,可能与NodeCanvas对行为树资源反序列化的实现有关),最直接的办法是将整个模块的Namespace包含到link中以避免此类问题。
(同时可以对官方示例进行同等级的strip,尝试更仔细的解决问题,通常官方示例因为体量小,能更快的进行build迭代和测试)。
无法为抽象类创建对象
Exception: Cannot create an instance of an interface or abstract type for NodeCanvas.Framework.ActionTask。
通常原因在于其实现类没有被保留下来。报错定位依然不明确。解决办法同上.
无法解析符号
Type with name 'NodeCanvas.Tasks.Actions.PlayerActions.AnimationAction' could not be resolved.
其中指出的符号,即类型、方法、属性等,因为没有被保留下来,导致进行反射调用时无法确定符号意义导致的问题。解决方法很明确,就是将符号写入link.xml以在strip过程中保留。
找不到Class ID对应的类型
ReportException: UnityLogError Could not produce class with ID 134.
通常是因为Unity引擎的代码被Strip掉了,导致在程序运行时找不到对应的类。对此类问题比较方便的一点在于,错误信息给出了具体的类(https://docs.unity3d.com/Manual/ClassIDReference.html),要解决问题只需要将查表找到的Class加入到link.xml即可。
如果在文档中无法找到对应的class,这里还有另外一种办法,参考Could not produce class with ID 363
找不到构造器
ReflectionException: The reflector requires concrete classes.Type XXX has no constructor. Is it an interface?
这是在使用StrangeIOC框架时遇到的问题。因为框架通过注入->反射来获取具体类型的实例,所以其中的Mediator、Model、Command、Service都没有直接引用(在MVCSContext中会进行绑定,以此为根可以找到所有的MVCS类),在strip时由于没有自定义的构造器,导致错误(原因待查)。解决该问题的方式,就是不通过UnityLinker的逻辑来strip这些类,而是将这些类所在的Namespace加入到link.xml。
找不到set函数
ReportException: UnityLogError System.ArgumentException: Set Method not found for 'xxx'
这也是在使用StrangeIOC框架时遇到的问题。因为我们在Mediator、Service类的开头使用[Inject]标签来获取一个Model,而且在逻辑处理部分只用到了属性的get方法,如果这个Mediator、Service本身没有被完整保留(添加到Link.xml或者使用了[Preserve]标签),这样会导致该条属性的set方法被裁剪掉,初始化这个类时,会因为找不到属性的set方法而报错。
(代码示例:)
[Inject]
public MyModel myModel {get; set;}
此时解决办法之一是将这个Mediator、Service类加入到Link.xml中,在Strip时完整保留这个类。还有另一个小技巧:让Inject继承PreserveAttribute,这样能保证所有使用[Inject]标签的属性都被完整保留下来。
strip之后需要注意的问题
- 务必做全量测试。虽然部分插件对Strip做了处理(例如提供了link.xml),但是依然有许多插件、第三方库没有考虑Strip的问题。所以必须通过全量测试来保证没有过度裁剪。
- 维护好逻辑代码。通常逻辑代码不需要进行裁剪,但是对于某些特殊情况(大量出现一部分代码仅运行在PC平台,另一部分代码需要运行在各个平台)最好是对代码合理分配Namespace,以便于在link.xml中通过Namespace进行裁剪。
问题及参考资料
- 目前没有找到能够查看Strip过程裁剪掉(或保留)内容的方法。
Unity strip engine code 遇到執行不能之問題與解決
il2cpp减代码体积, strip byte code以及strip engine code相关问题