PowerShell复杂对象转JSON：单元素数组格式异常问题排查

问题原因 #

这是PowerShell的返回值处理机制导致的：

• 当函数返回仅含单个元素的数组时，PowerShell会自动“展开”这个数组，把它转换成单个对象输出，而非保留数组类型。
• 你的代码里，当GetMyArrayData处理"xyz"这个单值时，$myReturnArray确实是只有1个元素的数组，但执行return $myReturnArray后，PowerShell会拆包这个数组，最终返回的是数组里的哈希表对象，不是数组本身。
• 后续把这个单个哈希表赋值给myArray2，ConvertTo-Json自然会将其解析为单个JSON对象，而非带方括号的数组。

你可以通过以下代码验证变量类型：

$mySecondArray.GetType().Name # 输出 Hashtable，而非 Object[]
$myFirstArray.GetType().Name # 输出 Object[]

解决方法 #

有三种常用方式可以强制保留数组类型：

方法1：用逗号包裹返回值 #

修改函数的return语句，用逗号包裹数组，强制PowerShell将其视为数组（逗号运算符会创建数组，哪怕只有一个元素）：

return ,$myReturnArray

方法2：使用Write-Output的NoEnumerate参数 #

用Write-Output替代return，加上-NoEnumerate参数阻止数组展开：

Write-Output $myReturnArray -NoEnumerate

方法3：构造强类型数组 #

初始化$myReturnArray时指定强类型，避免被自动转换：

$myReturnArray = [System.Collections.Generic.List[hashtable]]::new()
# 添加元素用Add方法替代+=
$myReturnArray.Add($hashObj)
# 返回时同样用逗号包裹确保类型
return ,$myReturnArray

修改后的示例代码（方法1） #

function GetMyArrayData
{
    param($myData)

    $myArrayOfInfo = $myData  -split '\s*[,;]\s*'

    $myReturnArray = @()

    foreach($infoItem in $myArrayOfInfo)
    {
        $hashObj = @{
            field1 = "standard-value"
            field2 = $infoItem
        }

        $myReturnArray += $hashObj
    }
    return ,$myReturnArray # 此处添加逗号强制保留数组类型
}

$myFirstArray = GetMyArrayData -myData "abc;def"

$mySecondArray = GetMyArrayData -myData "xyz"

$myBigObject = @{
    item1 = "my-first-item"
    item2 = "my-second-item"
    myArray1 = $myFirstArray
    myArray2 = $mySecondArray
}

$myJsonVersion = ConvertTo-Json $myBigObject -Depth 5

Write-Output $myJsonVersion

运行后myArray2会以带方括号的数组形式出现在JSON中，符合预期输出。

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