[System.Collections.Generic.List[string]] 作为返回值

Question

我需要/想要从函数返回 [System.Collections.Generic.List[string]]，但它被覆盖到 System.Object[]

我有这个

function TestReturn {
    $returnList = New-Object System.Collections.Generic.List[string]
    $returnList.Add('Testing, one, two')

    return ,@($returnList)
}

$testList = TestReturn
$testList.GetType().FullName

将其作为System.Object[] 返回，如果我将返回行更改为

return [System.Collections.Generic.List[string]]$returnList

或

return [System.Collections.Generic.List[string]]@($returnList)

如果列表中有一项，则返回[System.String]，如果有多个项，则返回System.Object[]，在这两种情况下。列表有什么奇怪的地方不能用作返回值吗？

现在，奇怪的是（我认为）如果我像这样键入接收值的变量，它确实可以工作。

[System.Collections.Generic.List[string]]$testList = TestReturn

但这似乎是一种奇怪的强制转换，其他数据类型不会发生这种情况。

Answer 1

如果您删除数组子表达式 @(...) 并在前面加上一个逗号。下面的代码似乎工作：

function TestReturn {
    $returnList = New-Object System.Collections.Generic.List[string]
    $returnList.Add('Testing, one, two')

    return , $returnList
}

$testList = TestReturn
$testList.GetType().FullName

注意：从技术上讲，这会导致 [Object[]] 返回一个类型为 [System.Collections.Generic.List[string]] 的元素。但同样是因为隐式展开它有点欺骗 PowerShell 输入所需的内容。

在您后面的观点中，[Type]$Var 类型的语法限制了变量。它基本上锁定了该变量的类型。因此，对 .GetType() 的后续调用将返回该类型。

这些问题是由于 PowerShell 如何在输出时隐式展开数组。典型的解决方案（在某种程度上取决于类型）是在返回之前使用 , 或确保调用端的数组，或者通过类型约束变量，如您的问题中所示，或者包装或转换返回本身。后者可能看起来像：

$testList = [System.Collections.Generic.List[string]]TestReturn
$testList.GetType().FullName

为确保在可以进行标量返回时的数组，并且假设您没有在 return 语句之前使用 , ，您可以在调用端使用数组子表达式：

$testList = @( TestReturn )
$testList.GetType().FullName

我相信this answer 处理类似的问题

Answer 2

除了Steven's very helpful answer，您还可以选择使用[CmdletBinding()] 属性，然后调用$PSCmdlet.WriteObject。默认情况下，它将保留类型。

function Test-ListOutput {
    [CmdletBinding()]
    Param ()
    Process {
        $List = New-Object -TypeName System.Collections.Generic.List[System.String]
        $List.Add("This is a string")
        $PSCmdlet.WriteObject($List)
    }
}
$List = Test-ListOutput
$List.GetType()
$List.GetType().FullName

对于数组，你应该指定类型。

function Test-ArrayOutput {
    [CmdletBinding()]
    Param ()
    Process {
        [Int32[]]$IntArray = 1..5
        $PSCmdlet.WriteObject($IntArray)
    }
}
$Arr = Test-ArrayOutput
$Arr.GetType()
$Arr.GetType().FullName

默认情况下PSCmdlet.WriteObject() 的行为是不枚举集合($false)。如果您将值设置为$true，您可以看到管道中的行为。

function Test-ListOutput {
    [CmdletBinding()]
    Param ()
    Process {
        $List = New-Object -TypeName System.Collections.Generic.List[System.String]
        $List.Add("This is a string")
        $List.Add("This is another string")
        $List.Add("This is the final string")
        $PSCmdlet.WriteObject($List, $true)
    }
}

Test-ListOutput | % { $_.GetType() }

IsPublic IsSerial Name                                     BaseType
-------- -------- ----                                     --------
True     True     String                                   System.Object
True     True     String                                   System.Object
True     True     String                                   System.Object

(Test-ListOutput).GetType()

IsPublic IsSerial Name                                     BaseType
-------- -------- ----                                     --------
True     True     Object[]                                 System.Array


# No boolean set defaults to $false
function Test-ListOutput {
    [CmdletBinding()]
    Param ()
    Process {
        $List = New-Object -TypeName System.Collections.Generic.List[System.String]
        $List.Add("This is a string")
        $List.Add("This is another string")
        $List.Add("This is the final string")
        $PSCmdlet.WriteObject($List)
    }
}

Test-ListOutput | % { $_.GetType() }

IsPublic IsSerial Name                                     BaseType
-------- -------- ----                                     --------
True     True     List`1                                   System.Object

(Test-ListOutput).GetType()

IsPublic IsSerial Name                                     BaseType
-------- -------- ----                                     --------
True     True     List`1                                   System.Object

只是想补充一些关于我通常在函数中使用什么以及如何控制行为的信息。