Unity:程序集定义Assembly Definition File功能详解
Assembly Definition File
Unity2017.3发布的一大新功能是:程序集定义文件(Assembly Definition File),下面文中我们就简称ADF。
得益于此功能,开发者可以在一个文件夹中自定义程序集。定义明晰的依赖关系,可以确保脚本更改后,只会重新生成必需的程序集,减少编译时间。
项目越大脚本越多,编译时间必然会越长。在进行项目迭代时,这很容易制约效率,因此设置好程序集定义文件可以提高工作效率,减少脚本编译的时间。
如上图,如果你仅更改了Main.dll中的脚本,其它程序集都不需要重新编译。由于Main.dll包含的脚本更少,因此它的编译速度比Assembly-CSharp.dll更快。 同样,Stuff.dll的更改仅会导致Main.dll和Stuff.dll重新编译。
创建方法
ADF是资源文件,可以通过Assets > Create > Assembly Definition菜单创建。该文件的扩展名是.asmdef。
注意:ADF所在的文件夹名称,以及ADF的文件名,跟程序集的名称没有关系。程序集的名称只跟ADF文件中的Name属性有关。创建时对ADF命名的话,属性中的Name也会相应修改。
实战环节
下面我们使用一个实际案例看看这个功能如何使用。
例如在2017.3之前的版本中的的脚本目录结构是这样的。
在2017.3之前的版本中,这些脚本最后会全部被编译到一个Assembly-CSharp.dll中。
再来看下如果我们创建了程序集定义文件(Assembly Definition File)后会怎样!
创建ADF文件
我们按照目录结构分别创建一个ADF,并且在Scripts文件夹下创建一个Main的ADF。
我们随便打开一个脚本,可以看到VS将这几个分别识别为了几个C#工程:
刚刚创建的ADF还差一些没有设置,就是依赖关系,比如Network要依赖SDK中的内容,如果不设置,就会像下图一样报错。
同时VS中也会报错:
下面我们来修复这个问题,选中Network ADF文件,然后在References中添加SDK的引用,别忘了点击下面的Apply。
现在不报错了,再打开VS,也不报错了,可以看到Network这个C#工程中加了一条SDK的引用。
常见问题
多层级的ADF
- 如果一个文件夹及子文件夹中,有多个ADF,每个脚本被添加到离这个脚本最短路径的ADF中去。
比如上面实战环节的Utils中并没有创建ADF,那么ADF就会被添加到父目录的Main中。
- 如果你搞不清楚一个脚本究竟被包含在了哪个ADF中,只需要选中这个脚本,在Inspector面板中就会清楚的看到。
- 如果我在一个已经打成ADF的脚本中调用另一个程序集中的单例类,那么就必须为该ADF添加对单例类所在程序集的引用。
最佳实践
- 强烈建议你对项目中的所有脚本使用ADF,或完全不使用。否则,没有使用ADF的脚本会在每次ADF重新编译时也被重新编译。这会减少你在项目中ADF所带来的好处。
- 还有就是一定要对目录结构好好进行划分。
- 若你的Unity项目分为美术工程和客户端工程,一定要有一致的ADF文件。
比如笔者的客户端工程删除了Spine插件的ADF文件,但是美术工程依旧保留了Spine插件的ADF文件。结果导出的Spine物体的预制件,在打包后出现Spine相关的脚本无法识别的报错(二者程序集不一,自然无法识别,这点很容易理解)。 - 令人疑惑的是在Editor模式下却没有任何问题~