PowerShell封装选择函数后表格不显示问题排查及修正

我之前写了一段PowerShell脚本，能正常显示带行号的Azure订阅选择表格，运行完全没问题。但为了复用这个选择逻辑，我把它封装成GetChoice函数后，调用$subChoice = GetChoice $subscriptions 'Choose subscription'时，表格居然不显示了，这到底是哪里出问题了？该怎么修改呢？

原脚本及封装后的函数代码如下：

# 原正常脚本
$subscriptions = $(& az account list --query '[].{name:name}' --output json) | ConvertFrom-Json
$subscriptions | ForEach-Object {$index=0} {$_; $index++} | Format-Table -Property @{ Label="index";Expression={$index}; Width=5 },Name
$subChoice = Read-Host 'Choose subscription'

# 封装后的函数
function GetChoice {
    param (
        [Parameter(Mandatory = $true)][psobject] $list,
        [Parameter(Mandatory = $true)][string] $prompt
    )
    $list | ForEach-Object {$index=0} {$_; $index++} | Format-Table -Property @{ Label="index";Expression={$index}; Width=5 },Name
    $choice = Read-Host $prompt
}

问题原因分析 #

核心问题出在PowerShell函数的输出机制上：

• PowerShell函数默认会把所有未被捕获的输出（包括Format-Table产生的格式化对象）作为函数的返回值返回给调用者。
• 当你用$subChoice = GetChoice ...把函数返回值赋值给变量时，原本应该显示在控制台的表格内容被存到了$subChoice变量里（实际是一堆格式化对象），所以你看不到表格了。
• 另外还有个小隐患：原代码里ForEach-Object {$index=0} {$_; $index++}的初始化写法不太严谨，$index=0只在第一次执行，虽然原脚本能运行，但在函数或复杂场景下可能出现计数错误。
• 你的函数还缺少return语句，导致调用后$subChoice实际是空值，没法拿到用户选择的结果。

解决方法及修改后的代码 #

针对上面的问题，我们可以做这几个调整：

1. 用Out-Host强制把Format-Table的输出发送到控制台，避免被当作函数返回值。
2. 修正$index的初始化方式，确保每次执行函数时都从0开始计数。
3. 添加return $choice语句，让函数返回用户选择的结果。

修改后的函数代码：

function GetChoice {
    param (
        [Parameter(Mandatory = $true)][psobject] $list,
        [Parameter(Mandatory = $true)][string] $prompt
    )
    # 初始化index为0，确保每次调用都从0开始计数
    $index = 0
    $list | ForEach-Object {
        # 给每个对象添加Index属性
        $_ | Add-Member -MemberType NoteProperty -Name 'Index' -Value $index -PassThru
        $index++
    } | Format-Table -Property @{ Label="index";Expression={$_.Index}; Width=5 },Name | Out-Host
    
    $choice = Read-Host $prompt
    # 返回用户选择的结果
    return $choice
}

调用示例和原逻辑一致：

$subscriptions = $(& az account list --query '[].{name:name}' --output json) | ConvertFrom-Json
$subChoice = GetChoice $subscriptions 'Choose subscription'
# 可以验证下选择结果
Write-Host "你选择的订阅索引是: $subChoice"

这样修改后，调用函数时表格会正常显示在控制台，同时$subChoice也能正确拿到用户输入的选择值。

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