PowerShell Cmdlet相关方法的最优返回类型选择咨询

我创建了一个包含自定义Node类的模块，用来生成特定的Node对象。模块里还有个MyClass类，它有两个方法：GetNode用于获取单个Node对象，GetChildNode用于获取Node集合。这两个方法分别支撑Get-Node（类似Get-Item）和Get-ChildNode（类似Get-ChildItem）两个Cmdlet。

单节点方法及对应Cmdlet代码 #

Class Node {}

Class MyClass {
    [Object]GetNode() { # <-- 此处应选择何种最优返回类型
         return [Node]::new()
    }
}

Function Get-Node {
    [CmdletBinding()] Param ()
    $MyClass = [MyClass]::new()
    $MyClass.GetNode()
}

集合方法及对应Cmdlet代码 #

Class MyClass {
    [Object[]]GetChildNode() { # <-- 此处应选择何种最优返回类型
        $NodeList = [System.Collections.Generic.List[Node]]::new()
        1..3 | ForEach-Object {
            $NodeList.Add([Node]::new())
        }
        return $NodeList
    }
}

Function Get-ChildNode {
    [CmdletBinding()] Param ()
    $MyClass = [MyClass]::new()
    $MyClass.GetChildNode()
}

现有类型返回的PSTypeNames情况 #

单节点方法 #

无论选择[Object]还是[Node]作为返回类型，Cmdlet返回对象的PSTypeNames结果一致：

(Get-Node).PSTypeNames
# 输出：
Node
System.Object

集合方法 #

可选返回类型包括[Array]、[Object]、[Object[]]或[Node[]]，其中[Node[]]初始类型与其他类型不同，但枚举后行为和其他类型一致（和Get-ChildItem行为对齐），当前测试结果：

(Get-ChildNode).PSTypeNames
# 输出：
System.Object[]
System.Array
System.Object

疑问 #

1. 这些方法有没有推荐的返回类型？
2. 如果希望Cmdlet像Get-Item和Get-ChildItem那样向管道输出FileSystemInfo对象风格的Node对象，应该怎么选择返回类型？
3. 不同返回类型是否存在性能损耗（比如类型转换导致的）？
4. 是否存在更优的返回类型（比如[System.Collections.ObjectModel.Collection1]）？ *注：这些Cmdlet最终需要支持管道链式调用，比如Get-ChildNode | ...`*

最佳实践与解答 #

1. 单节点方法的推荐返回类型 #

直接声明返回[Node]类型，理由：

• 代码可读性更强，明确告知调用者方法返回的是具体自定义类型，而非模糊的Object。
• 静态类型声明能在PowerShell类方法解析阶段提供类型检查，避免意外返回非Node类型。
• 无额外性能损耗，因为返回的本来就是Node实例，类型匹配无需转换。

2. 集合方法的推荐返回类型 #

推荐使用[System.Collections.Generic.IEnumerable[Node]]作为返回类型，或者直接返回[List[Node]]实例（无需强制转换为数组），理由：

• 对齐Get-ChildItem行为：Get-ChildItem返回的是IEnumerable<FileSystemInfo>实现，管道会自动枚举集合中的每个元素，而非将整个集合作为单个对象传递。
• 若声明返回[Node[]]，PowerShell会自动将List[Node]转换为强类型数组，产生额外内存分配和类型转换开销；返回IEnumerable[Node]或List[Node]时，管道可直接枚举元素，无需转换。
• 兼容PowerShell 5.1及以下版本时，[List[Node]]更稳妥，它是具体集合类型，避免接口类型在部分场景下的枚举问题。

3. 性能损耗分析 #

• 单节点场景：[Node] vs [Object]几乎无差异，实际返回的都是Node实例，Object只是向上转型，运行时开销可忽略。
• 集合场景：
  • 返回[Node[]]/[Object[]]：需要将List[Node]转换为数组，遍历集合并创建新数组，数据量越大开销越明显。
  • 返回[List[Node]]/[IEnumerable[Node]]：无需转换，直接返回原集合，管道自动枚举，性能最优。

4. 更优类型的选择 #

• [System.Collections.Generic.List[Node]]：是最佳选择之一，它是可变集合，支持增删元素，同时实现IEnumerable[Node]，管道可直接枚举，性能好且易用。
• [System.Collections.ObjectModel.Collection[Node]]：和List[Node]功能类似，但属于Collection<T>基类，适合需要自定义集合行为（如重写增删逻辑）的场景；若无自定义需求，List[Node]更轻量。
• 避免返回数组类型：除非明确需要数组的索引访问特性，否则数组不可变，且转换过程有性能损耗。

最终调整后的代码示例 #

单节点方法优化

Class Node {}

Class MyClass {
    [Node]GetNode() { # 明确返回Node类型
         return [Node]::new()
    }
}

Function Get-Node {
    [CmdletBinding()] Param ()
    $MyClass = [MyClass]::new()
    $MyClass.GetNode()
}

集合方法优化

Class MyClass {
    [System.Collections.Generic.IEnumerable[Node]]GetChildNode() { # 返回IEnumerable<Node>
        $NodeList = [System.Collections.Generic.List[Node]]::new()
        1..3 | ForEach-Object {
            $NodeList.Add([Node]::new())
        }
        return $NodeList
    }
}

Function Get-ChildNode {
    [CmdletBinding()] Param ()
    $MyClass = [MyClass]::new()
    $MyClass.GetChildNode()
}

调整后，Get-ChildNode会像Get-ChildItem一样将每个Node对象逐个输出到管道，支持链式调用，同时保持强类型和最优性能。

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