PowerShell如何判断函数返回值是否被赋值或管道调用

PowerShell 不存在原生、稳定、受官方支持的内置方法，可以直接检测当前函数的返回值是否被赋值给外部变量。你已知的通过$MyInvocation检测管道上下文的方案，仅能覆盖函数输出直接传入同语句管道下游的场景，无法识别赋值、子表达式捕获、输出重定向等其他输出被消费的场景。

PowerShell 函数的输出本质是向当前运行空间的输出流写入数据，输出数据最终是被丢弃、赋值给变量、传入管道、重定向到文件，是由函数执行完成后的外层调用逻辑处理的，函数自身执行阶段无法获取这部分外层上下文的元数据。
即便通过反射访问PowerShell抽象语法树（AST）回溯调用语句，也无法做到通用兼容：

• 子表达式包裹的赋值（如$x = (Do-Something)）、数组捕获（如$x = @(Do-Something)）会漏判
• 输出重定向（如Do-Something > log.txt）、Out-Variable类通用参数捕获会漏判
• 跨函数、跨模块嵌套调用时，AST回溯逻辑完全失效
• 不同PowerShell版本的AST结构存在差异，实现兼容性极差

如果只需要覆盖最基础的直接赋值、直接接管道的场景，可以通过AST解析调用语句实现简陋的检测逻辑，注意该方案不适合生产环境使用：

function Test-ReturnValueIsCaptured {
    $callLine = $MyInvocation.Line
    $callOffset = $MyInvocation.OffsetInLine
    $ast = [System.Management.Automation.Language.Parser]::ParseInput($callLine, [ref]$null, [ref]$null)
    $commandAst = $ast.Find({
        param($node)
        $node.Extent.StartOffset -le $callOffset -and 
        $node.Extent.EndOffset -ge $callOffset -and 
        $node -is [System.Management.Automation.Language.CommandAst]
    }, $false)

    if (-not $commandAst) { return $false }

    $pipelineNode = $commandAst.Parent
    # 检测是否存在管道下游元素
    if ($pipelineNode -is [System.Management.Automation.Language.PipelineAst] -and $pipelineNode.PipelineElements.Count -gt 1) {
        return $true
    }
    # 检测是否在赋值表达式右侧
    if ($pipelineNode.Parent -is [System.Management.Automation.Language.AssignmentStatementAst]) {
        return $true
    }

    return $false
}

你可以在自己的Do-Something函数里直接调用该函数，实现简单场景下的分支逻辑。

不要实现隐式的行为切换，这类逻辑会让函数行为不可预测，违反PowerShell命令设计规范。建议参考原生cmdlet的设计模式，通过显式参数控制输出行为：

function Do-Something {
    param(
        [Parameter(Position = 0)]
        [string]$OutputPath,
        [switch]$PassThru
    )

    # 替换为你的实际计算逻辑
    $functionResult = Get-Date

    if ($OutputPath) {
        $functionResult | Set-Content -Path $OutputPath
    }

    if ($PassThru -or -not $OutputPath) {
        return $functionResult
    }
}

使用规则非常明确：

• 需要将结果赋值给变量时直接调用：$outsideVariable = Do-Something
• 需要将结果写入文件时指定输出路径：Do-Something -OutputPath "outputfile.txt"
• 需要同时写入文件并返回结果时，追加-PassThru参数：$res = Do-Something -OutputPath "outputfile.txt" -PassThru

内容的提问来源于stack exchange，提问作者an.dr.eas.k