Unity构建详解（11）——代码剥离

【前言】

我们知道代码在程序启动时全量加载到内存中的，一个库内的全部代码有些是不需要使用的，遵循减少内存的一个目标：内存中仅存在需要的数据，如果可以将这些不需要的代码去除，就可以减少内存，这就是代码剥离。

对于大型的项目而言，代码剥离可以减少几十M的常驻内存。

在Unity中，被剥离的是托管代码，并不是全部代码。使用 IL2CPP 编译时，托管代码剥离还可以减少构建时间，因为需要转换为 C++ 并进行编译的代码减少。托管代码剥离将从托管程序集中删除代码，托管程序集如下：

• 游戏逻辑的C# 脚本构建的程序集
• 插件中的程序集
• NET 框架中的程序集，例如 mscorlib.dll 和 System.dll
• Unity引擎程序集，包括构成 Unity 引擎的托管程序集，如 UnityEngine.Core.dll。

注意，程序集是C#中的概念。

【启动代码剥离】

使用项目的 Player Settings 中的 Managed Stripping Level 选项来控制 Unity 删除未使用代码的激进程度，有五个选项

• Disabled：Unity不做任何的代码裁剪。这个配置只在我们使用Mono的时候可以选择，并且是默认配置。当选择 IL2CPP 脚本后端时，由于其对构建时间的影响，Disabled 选项不可用。托管代码越多意味着 IL2CPP 要生成的 C++ 代码越多，也意味着需要编译的 C++ 代码越多。
• Minimal：Unity只会检测UnityEngine和.NET的代码。并不会移除任何用户代码。这个配置最不可能会导致意料之外的运行时表现，此配置多用于可用性优先级高于包体积的产品中。此配置是IL2CPP的默认配置
• Low：Unity搜索部分用户程序集以及所有的UnityEngine和.NET代码。此设置应用一组规则，删除一些未使用的代码，但最大限度地减少出现意外后果的可能性，例如使用反射的运行时代码的行为变化。
• Medium：Unity 部分地搜索所有程序集以查找无法访问的代码。此设置应用一组规则，该规则去除更多类型的代码模式，以减少生成大小
• High：Unity对所有的程序集进行最广泛的检测，Unity 优先考虑缩小代码的大小，而不是代码的稳定性，并且尽可能多地删除代码

找到所有没有使用的托管代码是一件困难的事情，如果误删了代码，很可能导致运行时报错甚至崩溃。不同选项实际是在缩小代码大小和代码稳定性之间的权衡。

【保留和删除特定代码】

通常来说，如果程序不能自动解决某一问题，那么会留出接口和配置项供人为指导。Unity提供了根注释（Root Annotations）的方式来控制代码剥离时保留或删除特定代码。根注释强制Unity Linker把代码元素当作根元素，有两种方式进行根注释：

• Preserve 特性 : 直接在源代码中标记要保留的元素
• link.xml 文件：在文件中声明如何保留程序集中的元素

为什么是这两种方式，UnityLinker.exe是个可执行程序，程序提供配置功能，一般来说要有个配置文件，配置文件中的数据以什么样的形式来组织，一般来说不会闲着没事蛋疼或者炫技自己搞一个新的格式，都用已有的格式，这就是XML格式。

至于特性，这是因为UnityLinker会根据传入的dll路径，去加载dll分析，恰好可以利用C#特性来标记。

【使用Preserve特性标记】

该特性可以用于：

• 程序集Assembly：将保留程序集中的所有类，在程序集中的任意命名空间前声明即可。
• 类型Type：将保留该类及其默认构造器
• 方法Method：将保留该方法及方法涉及的所有类
• 属性Property：将保留该属性及属性涉及的所有类，对应的getter 方法以及 setter 方法
• 字段Field：将保留该字段及其涉及的类
• 事件Event：将保留事件及其涉及的所有类、对应的add 方法以及 remove 方法、
• 委托Delegate：将保留委托类型及其涉及的所有类

【使用XML文件标记】

示例如下：

<linker>
  <!--
  Preserve types and members in an assembly
  -->
  <assembly fullname="Assembly1">
    <!--Preserve an entire type-->
    <type fullname="Assembly1.A" preserve="all"/>

    <!--No "preserve" attribute and no members specified 
        means preserve all members-->
    <type fullname="Assembly1.B"/>

    <!--Preserve all fields on a type-->
    <type fullname="Assembly1.C" preserve="fields"/>

    <!--Preserve all fields on a type-->
    <type fullname="Assembly1.D" preserve="methods"/>

    <!--Preserve the type only-->
    <type fullname="Assembly1.E" preserve="nothing"/>

    <!--Preserving only specific members of a type-->
    <type fullname="Assembly1.F">
        
      <!--
      Fields
      -->
      <field signature="System.Int32 field1" />

      <!--Preserve a field by name rather than signature-->
      <field name="field2" />
      
      <!--
      Methods
      -->
      <method signature="System.Void Method1()" />

      <!--Preserve a method with parameters-->
      <method signature="System.Void Method2(System.Int32,System.String)" />

      <!--Preserve a method by name rather than signature-->
      <method name="Method3" />

      <!--
      Properties
      -->

      <!--Preserve a property, it's backing field (if present), 
          getter, and setter methods-->
      <property signature="System.Int32 Property1" />

      <property signature="System.Int32 Property2" accessors="all" />

      <!--Preserve a property, it's backing field (if present), and getter method-->
      <property signature="System.Int32 Property3" accessors="get" />

      <!--Preserve a property, it's backing field (if present), and setter method-->
      <property signature="System.Int32 Property4" accessors="set" />

      <!--Preserve a property by name rather than signature-->
      <property name="Property5" />

      <!--
      Events
      -->

      <!--Preserve an event, it's backing field (if present), 
          add, and remove methods-->
      <event signature="System.EventHandler Event1" />

      <!--Preserve an event by name rather than signature-->
      <event name="Event2" />

    </type>

    <!--Examples with generics-->
    <type fullname="Assembly1.G`1">

      <!--Preserve a field with generics in the signature-->
      <field signature="System.Collections.Generic.List`1&lt;System.Int32&gt; field1" />

      <field signature="System.Collections.Generic.List`1&lt;T&gt; field2" />

      <!--Preserve a method with generics in the signature-->
      <method signature="System.Void Method1(System.Collections.Generic.List`1&lt;System.Int32&gt;)" />

      <!--Preserve an event with generics in the signature-->
      <event signature="System.EventHandler`1&lt;System.EventArgs&gt; Event1" />

    </type>

    <!--Preserve a nested type-->
    <type fullname="Assembly1.H/Nested" preserve="all"/>

    <!--Preserve all fields of a type if the type is used.  If the type is not 
        used it will be removed-->
    <type fullname="Assembly1.I" preserve="fields" required="0"/>

    <!--Preserve all methods of a type if the type is used.  
        If the type is not used it will be removed-->
    <type fullname="Assembly1.J" preserve="methods" required="0"/>

    <!--Preserve all types in a namespace-->
    <type fullname="Assembly1.SomeNamespace*" />

    <!--Preserve all types with a common prefix in their name-->
    <type fullname="Prefix*" />

  </assembly>
  
  <!--Preserve an entire assembly-->
  <assembly fullname="Assembly2" preserve="all"/>

  <!--No "preserve" attribute and no types specified means preserve all-->
  <assembly fullname="Assembly3"/>

  <!--Fully qualified assembly name-->
  <assembly fullname="Assembly4, Version=0.0.0.0, Culture=neutral, PublicKeyToken=null">
    <type fullname="Assembly4.Foo" preserve="all"/>
  </assembly>

  <!--Force an assembly to be processed for roots but don’t explicitly preserve 
      anything in particular.  Useful when the assembly is not referenced.-->
  <assembly fullname="Assembly5" preserve="nothing"/>

</linker>

这些不用我们手动修改XML文件，可以在代码中修改，一般类是默认保留所有，即preserve="all"。在Addressable中提供了LinkXmlGenerator类来修改XML文件，其基本将涉及到游戏资源的相关逻辑需要的类型囊括进去了。随后继承IUnityLinkerProcessor，返回生成的link.xml文件路径给UnityLinker.exe，可以返回多个link.xml，其内部会合并处理的。

【UnityLinker工作原理】

C#代码经过编译后生成的程序集中的代码是中间语言代码，C# IL Linker可以对所有程序集进行静态分析，找出所有未被使用的程序集、类型、方法、属性、字段等，并删除他们以减少应用程序的大小。

UnityLinker基于IL Linker做了自定义处理，由于是自己做的，也会加上引擎代码的剥离，但这部分不公开。

Unity编辑器会创建一个程序集列表，其中包含 Unity 项目中的任何场景中使用的类型，并将此列表传递给 Unity 链接器。UnityLinker会分析所有的程序集，找到所有根元素，基于IL的分析，可以找到所有被根元素使用的类型、方法、属性等，并标记。没有被标记的将会从程序集中删除。

【参考】

托管代码剥离 - Unity 手册

关于优化的二三事：用Unity 2020 LTS更好地管理代码剥离 | Unity Blog