MSBuild 如何编写带条件的属性、集合和任务 Condition?

在项目文件 csproj 中,通过编写带条件的属性(PropertyGroup)、集合(ItemGroup)和任务(Target)可以完成更加复杂的项目文件的功能。

本文介绍如何编写带条件的 MSBuild 项。


Condition

如果要给你的 MSBuild 项附加条件,那么加上 Condition 特性即可。

Condition 可以写在任何地方,例如 PropertyGroupItemGroupTarget 或者内部的一个属性或一个项或者一个任务等。

下面这段代码表示在 Debug 配置下计算一个属性的值,而这个逗比属性 DoubiNames 的属性仅在此属性从未被指定过值的时候赋一个值 吕毅

<Project>
    <PropertyGroup Condition=" '$(Configuration)' == 'Debug' ">
        <DoubiNames Condition=" '$(DoubiNames)' == '' ">吕毅</DoubiNames>
    </PropertyGroup>
</Project>

在单引号的前后,等号这些运算符的前后空格可加可不加,没有影响。

单引号

在上面的例子中,我们给条件中的所有字符串加上了包裹的单引号。

单引号对于简单的字母数字字符串是不必要的,对于布尔值来说也是不必要的。但是,对于空值来说,是必须加上的,即 ''

==!=

== 符号左右两侧的字符串如果相等,则返回 true,否则返回 false

!= 符号左右两侧的字符串如果相等,则返回 false,否则返回 true

Condition=" $(Configuration) == 'Debug' "

<, >, <=, >=

用于比较数值上的大小关系。当然,在项目文件中,用于表示数值的字符串在此操作符下表示的就是数值。

  1. 左右两侧比较的字符串必须是表示数值的字符串,例如 123 或者 0x7b
  2. 只能是十进制或者十六进制字符串,而十六进制字符串必须以 0x 开头;
  3. 由于此比较是写在 XML 文件中的,所以必须转义,即 < 需要写成 &lt;> 需要写成 &gt;

Exists, HasTrailingSlash

Exists 判断文件或者文件夹是否存在。存在则返回 true,否则返回 false

Condition=" Exists('Foo\walterlv.config') "
Condition=" Exists('Foo\WalterlvFolder') "
Condition=" Exists('$(WalterlvFile)') "

HasTrailingSlash 如果字符串的尾部包含 / 或者 \ 字符串,则返回 true,否则返回 false

Condition="!HasTrailingSlash($(OutputPath))"

与或非:And, Or, !

就是计算机中常见的与或非的机制。

<DoubiNames Condition=" '$(DoubiNames)' == '吕毅' Or '$(DoubiNames)' == '林德熙' ">组队逗比</DoubiNames>

组合:()

就是计算机中通常用于修改运算优先级的括号,这可以先计算括号内的布尔结果。

if 条件:$if$

Condition=" $if$ ( %expression% ), $else$, $endif$ "

参考资料

blog bulletin

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

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

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