.NET for Android 中的 MSBuild 引用程序集机制解析
项目地址: https://gitcode.com/gh_mirrors/android6/android 引用程序集的概念与价值
在 .NET for Android 开发中，引用程序集（Reference Assemblies）是一个重要的编译优化机制。简单来说，引用程序集是仅包含类型和成员声明而不包含实现代码的特殊程序集，它们代表了项目的公共 API 表面。
传统编译模式下，当项目A引用项目B时，只要项目B发生任何修改（即使是内部实现细节的改动），项目A都必须重新编译。这种保守策略确保了安全性，但牺牲了编译效率。
启用引用程序集生成
在 .NET for Android 项目中，可以通过在项目文件(.csproj)中添加以下配置来启用引用程序集生成：
<PropertyGroup>
<ProduceReferenceAssembly>True</ProduceReferenceAssembly>
</PropertyGroup>
启用后，构建过程会在输出目录中生成两个版本的程序集：
bin/Debug/MyLibrary.dll- 完整的实现程序集bin/Debug/ref/MyLibrary.dll- 仅包含公共API的引用程序集
工作机制解析
当启用引用程序集功能后，MSBuild 会维护两个重要的项组(ItemGroup)：
@(ReferencePath)- 包含所有引用程序集的路径@(ReferenceCopyLocalPaths)- 包含需要复制到输出目录的程序集
这些项组会包含额外的元数据%(ReferenceAssembly)，指向对应的引用程序集路径。对于不支持引用程序集的第三方库，该元数据会指向原始程序集自身。
实际应用场景
在典型的 Xamarin.Forms 解决方案中，通常包含：
- 共享代码的 .NET Standard 类库项目
- 引用该库的 Android 应用项目
启用引用程序集后，当仅修改类库的以下内容时，Android 项目可以跳过重新编译：
- 私有方法实现
- 内部类型变更
- 代码注释修改
- 不影响公共API的bug修复
当前存在的限制
XAML 变更问题
在早期实现中，XAML 文件的任何修改都会导致引用程序集更新，即使这些修改不影响公共API。这是因为：
- XAML 被作为
EmbeddedResource包含在引用程序集中 - 资源文件的变更被视为公共API变更
这个问题已在较新版本的 Roslyn 编译器中修复。
Xamarin.Forms 模板问题
Xamarin.Forms 默认项目模板生成的代码可能会导致意外的公共API变更：
public partial class MyPage : ContentPage
{
public MyPage() => InitializeComponent();
}
当在XAML中添加命名元素时：
<Label x:Name="MyLabel" Text="Hello"/>
编译器会自动生成对应的公共字段：
public Label MyLabel; // 这会改变公共API
建议解决方案：修改项目模板，使用更严格的访问修饰符：
internal partial class MyPage : ContentPage
{
public MyPage() => InitializeComponent();
}
最佳实践建议
- 对于大型解决方案，特别是包含多个相互引用项目的场景，建议启用引用程序集功能
- 在持续集成环境中，引用程序集可以显著减少构建时间
- 对于Xamarin.Forms项目，考虑自定义项目模板以避免意外的公共API变更
- 确保使用较新版本的MSBuild和编译器以获得最佳兼容性
通过合理利用引用程序集机制，.NET for Android 开发者可以显著提升开发效率，特别是在大型项目和多项目解决方案中。
创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考
