如何实现MSBuild Target递归打印项目引用依赖图？

核心思路 #

MSBuild没有内置的ListProjectReferences目标，我们可以通过编写自定义MSBuild脚本，实现遍历项目及所有递归依赖项，输出每个项目的直接ProjectReference关联关系。

步骤1：编写自定义MSBuild目标脚本 #

创建一个名为ListReferences.targets的文件，内容如下：

<Project xmlns="http://schemas.microsoft.com/developer/msbuild/2003">
  <Target Name="ListProjectReferences" DependsOnTargets="ResolveProjectReferences">
    <!-- 收集当前项目及所有递归依赖的项目 -->
    <ItemGroup>
      <AllProjects Include="$(MSBuildProjectFullPath)" />
      <AllProjects Include="@(ProjectReference->'%(FullPath)')" />
      <!-- 递归遍历未处理的项目，获取嵌套引用 -->
      <UnvisitedProjects Include="@(AllProjects)" Condition="'%(Visited)' != 'true'" />
      <AllProjects Remove="@(UnvisitedProjects)" />
      <MSBuild Projects="@(UnvisitedProjects)" Targets="_GetNestedReferences">
        <Output TaskParameter="TargetOutputs" ItemName="AllProjects" />
      </MSBuild>
      <!-- 去重避免重复处理同一个项目 -->
      <AllProjects RemoveDuplicates="true" />
      <AllProjects SetMetadata="Visited" Value="true" />
    </ItemGroup>

    <!-- 调用辅助目标，生成每个项目的引用输出行 -->
    <MSBuild Projects="@(AllProjects)" Targets="_ListDirectReferences">
      <Output TaskParameter="TargetOutputs" ItemName="FinalOutputLines" />
    </MSBuild>

    <!-- 打印所有结果 -->
    <Message Text="%(FinalOutputLines.Identity)" Importance="High" />
  </Target>

  <!-- 辅助目标：获取单个项目的直接依赖项目 -->
  <Target Name="_GetNestedReferences">
    <ItemGroup>
      <NestedReferences Include="@(ProjectReference->'%(FullPath)')" />
    </ItemGroup>
    <Output TaskParameter="TargetOutputs" ItemName="NestedReferences" />
  </Target>

  <!-- 辅助目标：格式化单个项目的引用输出文本 -->
  <Target Name="_ListDirectReferences">
    <PropertyGroup>
      <CurrentProjectName>$(MSBuildProjectFileName)</CurrentProjectName>
      <DirectReferences>@(ProjectReference->'%(FileName)%(Extension)', ', ')</DirectReferences>
      <!-- 处理无依赖的情况 -->
      <OutputLine Condition="'$(DirectReferences)' != ''">$(CurrentProjectName) -> $(DirectReferences)</OutputLine>
      <OutputLine Condition="'$(DirectReferences)' == ''">$(CurrentProjectName) -> 无直接依赖</OutputLine>
    </PropertyGroup>
    <Output TaskParameter="TargetOutputs" ItemName="OutputLine" />
  </Target>
</Project>

步骤2：执行命令生成依赖图 #

在命令行中运行以下命令，替换projA.vcxproj为你的目标项目路径：

msbuild projA.vcxproj /t:ListProjectReferences /p:CustomBeforeMicrosoftCommonTargets=ListReferences.targets

关键说明 #

• 递归收集依赖：脚本会自动遍历当前项目的所有层级依赖，确保所有关联项目都被输出。
• 输出格式匹配：每个项目的输出格式严格遵循[项目名] -> [依赖项目1, 依赖项目2]样式，无依赖项目会标注“无直接依赖”。
• VCXProj兼容性：该脚本同时支持C#项目（.csproj）和C++项目（.vcxproj），无需额外修改。
• 路径问题：确保MSBuild能找到所有依赖项目，若依赖项目不在当前目录，需正确设置SolutionDir参数，或在项目文件中配置正确的ProjectReference路径。

内容的提问来源于stack exchange，提问作者Darien Pardinas