JsonPeek 1.2.0

使用 JSONPath 从 JSON 读取值。

用法

  <JsonPeek ContentPath="[JSON_FILE]" Query="[JSONPath]">
    <Output TaskParameter="Result" PropertyName="Value" />
  </JsonPeek>
  <JsonPeek Content="[JSON]" Query="[JSONPath]">
    <Output TaskParameter="Result" ItemName="Values" />
  </JsonPeek>

参数

您可以通过 ContentPath 提供JSON文件的路径，或者直接提供 Content 中的 JSON 内容。查询是一个 JSONPath 表达式，经过评估并通过 Result 任务参数返回。您可以将其结果分配给属性（即单个值）或项目名称（即多个结果）。

将结果值分配给项目时，JSON 对象属性将自动作为项目元数据处理。例如，考虑到以下 JSON

{
    "http": {
        "host": "localhost",
        "port": 80,
        "ssl": true
    }
}

您可以这样读取整个 http 值，并将其作为项目，每个属性作为元数据值。

<JsonPeek ContentPath="host.json" Query="$.http">
    <Output TaskParameter="Result" ItemName="Http" />
</JsonPeek>

Http 项目将具有以下值（如果它在 MSBuild 中声明）

<ItemGroup>
    <Http Include="[item raw json]">
        <host>localhost</host>
        <port>80</port>
        <ssl>true</ssl>
    </Http>
</ItemGroup>

以下元数据值可以按以下方式读取为 MSBuild 属性，例如

<PropertyGroup>
    <Host>@(Http -> '%(host)')</Host>
    <Port>@(Http -> '%(port)')</Port>
    <Ssl>@(Http -> '%(ssl)')</Ssl>
</PropertyGroup>

除了明确选择的对象属性外，整个节点都可通过特殊的 _（单个下划线）元数据项作为原始 JSON 提供。

如果匹配的值是空的，则不会返回任何项（因为不能使用空的身份标识构造项）或属性值。这使得区分成功匹配的空值和根本没有匹配项变得困难。对于这些情况，可以指定一个Empty值来代替空的（但成功匹配的）匹配结果，从而区分这两种场景

<JsonPeek Content="$(Json)" Empty="$empty" Query="$(Query)">
  <Output TaskParameter="Result" PropertyName="Value" />
</JsonPeek>

<Error Condition="'$(Value)' == '$empty'" Text="The element $(Query) cannot have an empty value." />

赞助商

了解更多关于GitHub赞助商的信息