如何在Directory.Build.targets中定义DynamicReference实现引用动态切换？

你可以通过在Directory.Build.targets中定义自定义项类型，并结合MSBuild目标的条件转换逻辑，实现这种二选一的引用方式，避免重复编写带Condition的ItemGroup。

步骤1：在Directory.Build.targets中定义核心逻辑 #

添加以下代码到你的Directory.Build.targets文件：

<!-- 声明自定义DynamicReference项的元数据结构 -->
<ItemGroup>
  <DynamicReference Include="">
    <PackageName></PackageName>
    <PackageVersion></PackageVersion>
    <LocalPath></LocalPath>
    <Prefer>Package</Prefer> <!-- 默认优先级：优先使用包引用 -->
  </DynamicReference>
</ItemGroup>

<!-- 核心转换目标：在引用解析前处理DynamicReference -->
<Target Name="ProcessDynamicReferences" BeforeTargets="ResolveReferences">
  <!-- 仅启用本地引用的场景 -->
  <ItemGroup Condition="$(DynamicReferencesUseLocal) == 'true' and $(DynamicReferencesUsePackages) != 'true'">
    <Reference Include="%(DynamicReference.LocalPath)">
      <HintPath>%(DynamicReference.LocalPath)</HintPath>
    </Reference>
  </ItemGroup>

  <!-- 仅启用包引用的场景 -->
  <ItemGroup Condition="$(DynamicReferencesUsePackages) == 'true' and $(DynamicReferencesUseLocal) != 'true'">
    <PackageReference Include="%(DynamicReference.PackageName)" Version="%(DynamicReference.PackageVersion)" />
  </ItemGroup>

  <!-- 两者都启用时，按Prefer属性选择引用方式 -->
  <ItemGroup Condition="$(DynamicReferencesUseLocal) == 'true' and $(DynamicReferencesUsePackages) == 'true'">
    <PackageReference Include="%(DynamicReference.PackageName)" Version="%(DynamicReference.PackageVersion)" Condition="%(DynamicReference.Prefer) == 'Package'" />
    <Reference Include="%(DynamicReference.LocalPath)" Condition="%(DynamicReference.Prefer) == 'Local'">
      <HintPath>%(DynamicReference.LocalPath)</HintPath>
    </Reference>
  </ItemGroup>
</Target>

步骤2：设置全局/项目级控制开关 #

在Directory.Build.props或单个项目文件中配置控制属性：

<PropertyGroup>
  <!-- 启用本地引用 -->
  <DynamicReferencesUseLocal>false</DynamicReferencesUseLocal>
  <!-- 启用包引用 -->
  <DynamicReferencesUsePackages>true</DynamicReferencesUsePackages>
</PropertyGroup>

步骤3：项目中使用DynamicReference #

按照你预期的方式添加引用即可：

<ItemGroup>
  <DynamicReference Prefer="Package">
    <PackageName>MyFramework.UI</PackageName>
    <PackageVersion>2.0.*</PackageVersion>
    <LocalPath>C:/SomePath/MyFramework.UI.dll</LocalPath>
  </DynamicReference>
</ItemGroup>

关键说明 #

• 目标ProcessDynamicReferences绑定到ResolveReferences之前执行，确保在MSBuild解析引用前完成转换。
• 元数据Prefer仅在DynamicReferencesUseLocal和DynamicReferencesUsePackages同时为true时生效，默认值为Package。
• 可按需扩展元数据，比如给<Reference>添加Private属性，或给<PackageReference>添加IncludeAssets等，只需在转换逻辑中传递对应元数据即可。

内容的提问来源于stack exchange，提问作者Jarryd Le Breton