在项目文件 csproj 中或者 MSBuild 的 Target 中使用 % 引用集合中每一项的属性

在编写项目文件或者 MSBuild Target 文件的时候,我们经常会使用 <Foo Include="Identity" /> 来定义集合中的一项。在定义的同时,我们也会额外指定一些属性。

然而这些属性如何拿到并且使用呢?本文将介绍使用方法。


将下面的代码放到你项目文件的末尾,最后一个 </Project> 的前面,可以在编译的时候看到两个新的警告。

<Target Name="Xxx" AfterTargets="AfterBuild">
    <ItemGroup>
        <WalterlvX Include="@(Compile)" />
        <WalterlvY Include="%(Compile.FileName)" />
    </ItemGroup>
    <Warning Text="@(WalterlvX)" />
    <Warning Text="@(WalterlvY)" />
</Target>

新增的警告

在定义 WalterlvX 集合的时候,我们使用了 @(Compile) 来获取所有需要编译的文件。

在定义 WalterlvY 集合的时候,我们使用了 %(Compile.FileName) 来获取编译文件的文件名。

于是,你在警告信息中看到的两个警告信息里面,一个输出了 Compile 集合中每一项的标识符(通常是相对于项目文件的路径),另一个输出了每一个 Compile 项中的 FileName 属性。FileName 属性是 Compile 会被 Microsoft.NET.Sdk 自动填充。

需要注意,如果 % 得到的项中某个属性为空,那么这一项在最终形成的新集合中是不存在的。

所以,如果存在可能不存在的属性,那么建议先进行拼接再统一处理拼接后的值:

<Target Name="Xxx" AfterTargets="AfterBuild">
    <ItemGroup>
        <Walterlv Include="@(Compile)=%(Compile.CopyToOutputDirectory)" />
    </ItemGroup>
    <Warning Text="@(Walterlv)" />
</Target>

这里的 CopyToOutputDirectory 不是一个总是会设置的属性。

blog bulletin

本文会经常更新,请阅读原文: https://blog.walterlv.com/post/msbuild-referencing-metadata.html ,以避免陈旧错误知识的误导,同时有更好的阅读体验。

如果你想持续阅读我的最新博客,请点击 RSS 订阅,或者前往 CSDN 关注我的主页

知识共享许可协议 本作品采用 知识共享署名-非商业性使用-相同方式共享 4.0 国际许可协议 进行许可。欢迎转载、使用、重新发布,但务必保留文章署名 吕毅 (包含链接: https://blog.walterlv.com ),不得用于商业目的,基于本文修改后的作品务必以相同的许可发布。如有任何疑问,请 与我联系 (walter.lv@qq.com)