基于特定条件引入PackageReference的MSBuild替代方案咨询

需求回顾 #

• 核心逻辑：如果当前构建配置不在BuildConfigurations元数据指定的列表中，就把目标项目以NuGet包形式引用；符合配置则用本地ProjectReference
• 示例场景：MaterialBalance和Pricing项目需在特定配置下以包拉取

原实现的问题 #

之前用SetPackageReferences Target动态添加PackageReference，构建和包还原都正常，但Visual Studio的依赖树识别不了这些动态添加的引用——因为VS项目系统是在MSBuild求值阶段（不是Target执行阶段）解析依赖的，动态Target里的操作VS看不到。

可行替代方案 #

用MSBuild的求值阶段语法（比如Choose/When/Otherwise或者预计算属性）来实现条件切换，这样VS能正确识别依赖：

方案1：按配置写条件分支 #

直接针对目标配置做分支判断，明确指定哪些配置用项目引用，哪些用包：

<Choose>
  <!-- 当前配置不在指定列表时，添加包引用 -->
  <When Condition="!$(Configuration.Contains('Debug')) and !$(Configuration.Contains('Release')) and !$(Configuration.Contains('Prod')) and !$(Configuration.Contains('MaterialBalance'))">
    <ItemGroup>
      <PackageReference Include="ProjectName.MaterialBalance" Version="$(AllVersions)" />
    </ItemGroup>
  </When>
  <Otherwise>
    <!-- 符合配置时添加本地项目引用 -->
    <ItemGroup>
      <ProjectReference Include="..\ProjectName.MaterialBalance\ProjectName.MaterialBalance.csproj" />
    </ItemGroup>
  </Otherwise>
</Choose>

<Choose>
  <When Condition="!$(Configuration.Contains('Debug')) and !$(Configuration.Contains('Release')) and !$(Configuration.Contains('Prod')) and !$(Configuration.Contains('Pricing'))">
    <ItemGroup>
      <PackageReference Include="ProjectName.Pricing" Version="$(AllVersions)" />
    </ItemGroup>
  </When>
  <Otherwise>
    <ItemGroup>
      <ProjectReference Include="..\ProjectName.Pricing\ProjectName.Pricing.csproj" />
    </ItemGroup>
  </Otherwise>
</Choose>

方案2：复用自定义项元数据（更灵活） #

如果需要复用CustomProjectReference的元数据，先提前计算配置匹配结果，再用条件添加引用：

<!-- 先定义自定义项 -->
<ItemGroup>
  <CustomProjectReference Include="..\ProjectName.MaterialBalance\ProjectName.MaterialBalance.csproj" 
                          PackageName="ProjectName.MaterialBalance" 
                          PackageVersion="$(AllVersions)" 
                          BuildConfigurations="Debug,Release,Prod,MaterialBalance"/>
  <CustomProjectReference Include="..\ProjectName.Pricing\ProjectName.Pricing.csproj" 
                          PackageName="ProjectName.Pricing" 
                          PackageVersion="$(AllVersions)" 
                          BuildConfigurations="Debug,Release,Prod,Pricing"/>
</ItemGroup>

<!-- 提前计算每个引用的配置匹配结果（求值阶段执行） -->
<PropertyGroup>
  <_MaterialBalanceConfigMatch>$([System.String]::new('%(CustomProjectReference.BuildConfigurations)').Contains('$(Configuration)'))</_MaterialBalanceConfigMatch>
  <_PricingConfigMatch>$([System.String]::new('%(CustomProjectReference.BuildConfigurations)').Contains('$(Configuration)'))</_PricingConfigMatch>
</PropertyGroup>

<!-- 基于预计算结果添加引用 -->
<ItemGroup>
  <!-- MaterialBalance的条件引用 -->
  <ProjectReference Include="..\ProjectName.MaterialBalance\ProjectName.MaterialBalance.csproj" 
                    Condition="$(_MaterialBalanceConfigMatch)" />
  <PackageReference Include="ProjectName.MaterialBalance" 
                    Version="$(AllVersions)" 
                    Condition="!$(_MaterialBalanceConfigMatch)" />

  <!-- Pricing的条件引用 -->
  <ProjectReference Include="..\ProjectName.Pricing\ProjectName.Pricing.csproj" 
                    Condition="$(_PricingConfigMatch)" />
  <PackageReference Include="ProjectName.Pricing" 
                    Version="$(AllVersions)" 
                    Condition="!$(_PricingConfigMatch)" />
</ItemGroup>

方案说明 #

• 两种方案都是在MSBuild求值阶段处理逻辑，Visual Studio能正确解析依赖，依赖树可以正常显示
• 方案2更适合维护大量引用的场景，只需修改CustomProjectReference的元数据就能更新规则

内容的提问来源于stack exchange，提问作者Emre Kabaoglu