psCustomObject 作为返回的数据，奇怪的管道错误答案

【问题标题】：psCustomObject as returned data, odd pipeline errorspsCustomObject 作为返回的数据，奇怪的管道错误
【发布时间】：2021-03-23 15:21:39
【问题描述】：

我试图满足我对返回类型性能的好奇心。基本上我想看看在返回复杂数据时哈希表、psCustomObject 和我自己的类之间是否存在有意义的差异。但我遇到了 psCustomObject 的问题。

所以，我开始了

class pxObject {
    [String]$String
    [String]$Failure
    [String]$Error

    pxObject ([String]$string, [String]$failure, [String]$error) {
        $this.String = $string
        $this.Failure = $failure
        $this.Error = $error
    }
}


class pxReturn {
    static [HashTable] Hash ([String]$string, [String]$failure, [String]$error) {
        [HashTable]$returnHash = @{
            String  = $string
            Failure = $failure
            Error   = $error
        }

        return $returnHash
    }
    static [psCustomObject] psObject ([String]$string, [String]$failure, [String]$error) {
        [psCustomObject]$returnObject = [psCustomObject]@{    
            String  = $string
            Failure = $failure
            Error   = $error
        }

        return $returnObject
    }

    static [pxObject] pxObject ([String]$string, [String]$failure, [String]$error) {
        [pxObject]$returnObject = [pxObject]::new($string, $failure, $error)

        return $returnObject
    }
    
}

[Int]$count = 1000
CLS

Write-Host 'Hash ' -NoNewLine
(Measure-Command {
    foreach ($i in 1..$count) {
        [pxReturn]::Hash("String $i", "Failure $i", "Error $i")
    }
}).TotalSeconds
Write-Host 'psObject ' -NoNewLine
(Measure-Command {
    foreach ($i in 1..$count) {
        [pxReturn]::psObject("String $i", "Failure $i", "Error $i")
    }
}).TotalSeconds
Write-Host 'pxObject ' -NoNewLine
(Measure-Command {
    foreach ($i in 1..$count) {
        [pxReturn]::pxObject("String $i", "Failure $i", "Error $i")
    }
}).TotalSeconds

我在Measure-Command 行得到Measure-Command : The given key was not present in the dictionary. 用于psObject 测试。鉴于 Measure-Command 有一个代码块，并且有时会掩盖真正的错误，因此我将该代码修改为

Write-Host 'psObject ' -NoNewLine
#(Measure-Command {
    foreach ($i in 1..$count) {
        [pxReturn]::psObject("String $i", "Failure $i", "Error $i")
    }
#}).TotalSeconds

现在我得到An error occurred while creating the pipeline. 没有线路信息。这似乎很简单，所以我对它失败的原因感到有些困惑。特别是因为我从另一个工作正常的项目中复制了 psCustomObject 代码。这就是返回数据看起来如此的原因，我之前已经成功地将 psCustomObject 用于这个用例。

编辑：与我的工作内容和我正在尝试做的事情的一个区别是，在我使用函数之前。于是我修改了上面的代码，添加了一个返回psCustomObject的函数，像这样

function psObjectReturn ([String]$string, [String]$failure, [String]$error) {
    [psCustomObject]$returnObject = [psCustomObject]@{    
        String  = $string
        Failure = $failure
        Error   = $error
    }
    return $returnObject
}

并添加了适当的测试

Write-Host 'psObject (function) ' -NoNewLine
(Measure-Command {
    foreach ($i in 1..$count) {
        $test = psObjectReturn "String $i" "Failure $i" "Error $i"
    }
}).TotalSeconds

这是一种享受。但是我将所有内容都移到了课堂上，因此它并没有真正直接解决主要问题。虽然如果您根本不能使用 [psCustomObject] 作为类方法的返回类型，则可能会出现这种情况。

另外，性能看起来像这样

Hash                0.01107
psObject (function) 0.0453963
pxObject            0.0245367

这几乎表明哈希表是最快的，但不足以使其成为强制性的，我可以根据其他标准在哈希表和我自己的类之间做出决定。但我敢肯定，类错误中的 psObject 在幕后会发生一些有趣的事情。

【问题讨论】：

PSCustomObject 类型加速器解析为 PSObject（not PSCustomObject type 用于通过使用加速器） - 您需要在方法签名中指定完整的类型名称，例如。 static [System.Management.Automation.PSCustomObject] psObject() { ... }
@mathias-r-jessen，越来越好奇。我尝试了您提到的完整类型描述，但仍然出现错误。也尝试了新鲜的 ISE。没有喜悦。然后，在百灵鸟中，我尝试更改方法的名称，所以static [PSCustomObject] customObject () { ...}。这对我有用，即使仍然使用加速器作为所示的类型。最后，PSObject 是迄今为止最慢的，我自己的自定义类型只比哈希表慢一点。如果我在某处构造错误，只有我自己的类型会给我想要的错误。所以 pxObject 就是这样。我学到了一些东西。 :)

标签： powershell pscustomobject

【解决方案1】：

问题是您使用psObject 作为方法名，与hidden, intrinsic .psobject property 冲突。

问题的简化再现：

class Foo { static [pscustomobject] psobject() { return [pscustomobject] @{ foo = 1 } } }
[Foo]::psobject() # -> An error occurred while creating the pipeline.

只需选择不同的方法名称即可解决问题：

class Foo { static [pscustomobject] pscustomobject() { return [pscustomobject] @{ foo = 1 } } }
[Foo]::pscustomobject() # OK

【讨论】：