嵌套 JSON 与 powershell 中的列表和值

Question

我想创建一个像这样的数组

{
  "requestType": "addUsersToGroups",
  "orgToken": "organization_api_key",
  "assignedUsers" :
  [
    [{"name":"group_name"},[{"email":"assigned_user_email"}]]
  ]
}

但是，assignedUsers 中的额外 [] 是我无法获得的。我无法获得assignedUsers 的列表内列表。我得到的只是一个列表。

这是我尝试过的：

$assignedUsers = (
                (
                        @{"name" = "group_members_$productName"},
                        (
                                @{"email" = $user}
                        )
                )
        )
        $body= @{
                "requestType" = "addUsersToGroups"
                "productName" = $productName
                "userKey" = $userKey
                "orgToken" = $orgToken
                "assignedUsers" = $assignedUsers
        } | ConvertTo-Json

        Write-Output $body

但是，输出是

{
    "requestType":  "addUsersToGroups",
    "assignedUsers":  [
                          {
                              "name":  "group_members_NewProduct"
                          },
                          {
                              "email":  "my_Email"
                          }
                      ],
    "userKey":  "userKey",
    "orgToken":  "orgToken",
    "productName":  "NewProduct"
}

Answer 1

数组不是由() 或@() 创建的。它们由, 创建——comma operator^{(*) 见下文}。

只要你用逗号分隔多个项目，或在单个项目前加上逗号，结果就是一个数组：

$a = 1,2,3   # -> [1,2,3]
$a = ,1      # -> [1]

请注意，当, 在前面时，它将始终（！）产生一个单项数组：

$a = ,1,2,3  # -> [[1],2,3]
$a = ,,1     # -> [[1]]

我们可以使用这种行为来创建嵌套的单项数组：

$assignedUsers = ,(
    @{"name" = "group_name"},
    ,@{"email" = "assigned_user_email"}
)

$body = @{
    "assignedUsers" = $assignedUsers
}

$body | ConvertTo-Json -Depth 5 -Compress
# -> {"assignedUsers":[[{"name":"group_name"},[{"email":"assigned_user_email"}]]]}

请注意，我已经为电子邮件再次这样做了。也没有@()，因为它们不是必需的。

---

^(*) 其实@()也创建了一个数组。 @(1) 将是一个单项数组。但是在@(1,2)中，实际上创建的数组是逗号，不管你是否额外包裹在@()中都没有区别，实际上是不必要的。

但是，@() 处理它的内容。如果一个项目是可迭代的，@() 将对其进行迭代并将结果合并到一个新数组中（这称为“展开”）：

$a = 1,2,3
$b = 4,5,6
$c = @(
    $a          # iterable
    $b          # iterable
)               # -> [1,2,3,4,5,6]

这也是为什么你不能嵌套它来创建嵌套数组的原因。 @(@(1,2,3)) 仍然只是 [1,2,3]，因为首先内部 @() 获取一个数组，对其进行迭代并输出它。然后外部@() 得到 that 数组，迭代它，你得到了图片。这些是等价的：

@{"prop" = 1,2,3}       | ConvertTo-Json -Compress  # -> {"prop":[1,2,3]}
@{"prop" = (1,2,3)}     | ConvertTo-Json -Compress  # -> {"prop":[1,2,3]}
@{"prop" = @(1,2,3)}    | ConvertTo-Json -Compress  # -> {"prop":[1,2,3]}
@{"prop" = @(@(1,2,3))} | ConvertTo-Json -Compress  # -> {"prop":[1,2,3]}

另一方面，一元 , 没有做任何此类事情。它只是把它右边的任何东西都放在一个数组中。

@{"prop" = 1,2,3}       | ConvertTo-Json -Compress  # -> {"prop":[1,2,3]}
@{"prop" = ,1,2,3)}     | ConvertTo-Json -Compress  # -> {"prop":[[1],2,3]}
@{"prop" = ,(1,2,3)}    | ConvertTo-Json -Compress  # -> {"prop":[[1,2,3]]}
@{"prop" = ,@(1,2,3)}   | ConvertTo-Json -Compress  # -> {"prop":[[1,2,3]]}

$items = 1,2,3
@{"prop" = $items}      | ConvertTo-Json -Compress  # -> {"prop":[1,2,3]}
@{"prop" = ,$items}     | ConvertTo-Json -Compress  # -> {"prop":[[1,2,3]]}

所以使用@() 是可选的，你并不需要它来创建数组。您可以在需要“展开”行为时使用它，或者为了源代码格式化，因为当您使用换行符分隔元素时，逗号在其中是可选的。结果

@(
  "a very long thing"
  "another very long thing"
  "yet another very long thing"
)

和

"a very long thing","another very long thing","yet another very long thing"

是等价的，但前者更容易阅读。有关@() 工作原理的更深入信息是over here。

Answer 2

尝试像这样构建您的$assignedusers 和$body：

$orgToken    = "organization_api_key"
$userKey     = "userkey"
$productName = "NewProduct"

$assignedUsers = ,@(
    @{"name" = "group_name"},
    @(@{"email" = "assigned_user_email"})
)

$body = [ordered]@{
    "requestType"   = "addUsersToGroups"
    "orgToken"      = $orgToken
    "productName"   = $productName
    "userKey"       = $userKey
    "assignedUsers" = $assignedUsers
}

$body | ConvertTo-Json -Depth 5

因为ConvertTo-Json cmdlet 创建了有效但格式相当丑陋的json，您可以使用Format-Json 函数我前段时间posted here。

使用该功能，只需将代码中的最后一行更改为

$body | ConvertTo-Json -Depth 5 | Format-Json

要得到这个结果：

{
  "requestType": "addUsersToGroups",
  "orgToken": "organization_api_key",
  "productName": "NewProduct",
  "userKey": "userkey",
  "assignedUsers": [
    [
      {
        "name": "group_name"
      },
      [
        {
          "email": "assigned_user_email"
        }
      ]
    ]
  ]
}