Assembly definitions 的相关实验

概述

大概从 Unity 2017.3 开始，添加了 assembly definition 相关的功能。为了更深入的了解，进行了多次打包和对比。本文主要是对这一过程进行记录。

文档解释

1、编译脚本

Untiy 在默认情况下，根据脚本在项目中的文件夹，会分成四个阶段编译脚本。

当脚本引用在其它阶段 (即位于不同程序集中) 编译的类时，编译顺序非常重要。基本规则是，在当前编译阶段之后的任何编译阶段都不能被引用。在当前阶段或更早阶段编译的任何内容都是完全可用的。

编译的各个阶段如下：

阶段	程序集名	脚本文件
1	Assembly-CSharp-firstpass	Standard Assets, Pro Standard Assets 和 Plugins 文件夹下面的运行时脚本
2	Assembly-CSharp-Editor-firstpass	Standard Assets, Pro Standard Assets 和 Plugins 文件夹下面的 Editor 文件夹下面的 Editor 脚本
3	Assembly-CSharp	其它不在 Editor 文件夹下面的脚本
4	Assembly-CSharp-Editor	所有剩下的脚本（Editor 文件夹下面的脚本）

2、Assembly definitions

程序集是一个 C# 代码库，它包含由脚本定义的已编译类和结构，还定义了对其他程序集的引用。

默认情况下，Unity 将几乎所有的游戏脚本编译到预定义的程序集中（Assembly-CSharp.dll）。

这种安排对于小型项目来说是可以接受的，但是当你向项目中添加更多代码时，会有一些缺点：

每当你改变一个脚本时，Unity 就必须重新编译所有其他脚本，这增加了迭代代码更改的整体编译时间。
任何脚本都可以直接访问任何其他脚本中定义的类型，这使得重构和改进代码变得更加困难。
所有脚本都是为所有平台编译的。

通过定义程序集，你可以组织代码以促进模块化和可重用性。你为项目定义的程序集中的脚本将不再添加到默认程序集中，并且只能访问你指定的其他程序集中的脚本。

上面的图表说明了如何将项目中的代码拆分为多个程序集。因为 Main 引用 Stuff 而不是相反，你知道任何对 Main 中的代码的更改都不会影响 Stuff 中的代码。类似地，因为 Library 不依赖于任何其他程序集，所以可以更容易地在另一个项目中重用 Library 中的代码。

默认情况下，预定义程序集引用所有其他程序集，包括使用 Assembly Definition(1) 创建的程序集和作为 plugin 添加到项目中的预编译程序集 (2)。此外，使用 Assembly Definition 创建的程序集自动引用所有预编译程序集 (3)：

要将项目代码组织成程序集，请为每个所需程序集创建一个文件夹，并将应该属于每个程序集的脚本移动到相关文件夹中。然后创建 Assembly Definition 资产以指定程序集属性。

Unity 在一个包含 Assembly Definition 资产的文件夹中获取所有脚本，并使用该资产定义的名称和其他设置将它们编译为一个程序集。Unity 还将任意子文件夹中的脚本包含到同一程序集中，除非子文件夹有自己的 Assembly Definition 或 Assembly Definition Reference 资产。

要在现有程序集中包含来自非子文件夹的脚本，请在非子文件夹中创建 Assembly Definition Reference 资产，并将其设置为引用定义目标程序集的 Assembly Definition 资产。例如，你可以将项目中所有 Editor 文件夹中的脚本组合到它们自己的程序集中，而不管这些文件夹位于何处。

Assembly Definition Reference 在下面这种情况下可以解决问题：在 Unity 的 Packages 中，有一些访问级别为 internal 的类。如果我们在 Assets 下面创建脚本，是不能访问 Packages 中的 internal 类。有了 Assembly Definition Reference 就可以了。可以在创建的脚本的同级目录中创建一个 Assembly Definition Reference，设置引用包含 internal 类的 Package 即可。

一些实验

Unity 版本：2020.3.13f1

ILSpy 版本：7.1.0.6543

创建一个空的 URP 工程，设置到 Android 平台，Player Setting 中的 Scripting Backend 设置为 “Mono”。默认情况下，项目中包含的脚本如下所示：

每次打完包后，对 apk 进行解压即可。解压后，程序集的位置在 “{解压的文件}\assets\bin\Data\Managed\” 下面：

1、默认打包

我们需要关心的是 “Assembly-CSharp.dll” 程序集。使用 ILSpy 打开 Assembly-CSharp.dll，可以看到：

项目中的两个运行时脚本 Readme 和 SimpleCameraController 都被编译到程序集 Assembly-CSharp.dll 中。

2、使用 Assembly Definition

在 SimpleCameraController 的同级目标创建 Assembly Definition，Assembly Definition 的设置保持默认即可。观察 SimpleCameraController，可以发现 SimpleCameraController 的程序集信息是新创建的 Assembly Definition：

打包，解压，可以看到，刚才新创建的 Assembly Definition 产生的程序集：

使用 ILSpy 分别打开 Assembly-CSharp.dll 和 NewAssembly.dll，结果如下所示：

可以发现，SimpleCameraController 被编译进新的程序集 NewAssembly.dll 中，而原本的程序集 Assembly-CSharp.dll 中没有 SimpleCameraController 了。

3、使用 Assembly Definition Reference

删除上面创建的 Assembly Definition，在 SimpleCameraController 的同级目标创建 Assembly Definition Reference。假设，我们想访问的 Unity 的 Package 是 Unity UI，设置 Assembly Definition Reference 上的 Assembly Definition 为 UnityEngine.UI 即可，如下图所示：

打包，解压，可以看到，上面新创建的程序集 NewAssembly.dll 没了，而使用 ILSpy 打开 Assembly-CSharp.dll，也并没有看到 SimpleCameraController。那么，SimpleCameraController 去哪儿了呢？使用 ILSpy 打开 UnityEngine.UI.dll 程序集：

可以发现，SimpleCameraController 被包含到了 UnityEngine.UI.dll 程序集中，也就是说，SimpleCameraController 可以访问程序集中的 internal 级别的类了。

一些使用场景

对于 Assembly Definition 的用处，网上很多的介绍是可以加快代码编译速度。这个也很容易理解，使用 Assembly Definition 对项目中的脚本进行细分后，每次修改只需要编译脚本所在的程序集，因此减少了编译的时间。
如果想访问 Untiy 的 Package 中的 internal 类的话，由于可以获得 Package 的源码，当然可以直接在 Package 中添加修改。当现在如果不修改 Package 的话，就可以使用 Assembly Definition Reference，将自己的代码包含到 Package 中，这样，就会编译到同一个程序集中，也就可以访问 internal 类了。

参考

[1] Unity 2017.3
[2] Special folders and script compilation order
[3] Assembly definitions
[4] Unity3D 研究院新方法加快代码编译速度（九十六）
[5] 提升 Unity 编辑器中代码的编译速度

原文地址 zhuanlan.zhihu.com