支持词法范围的ScriptBlock参数（例如Where-Object）

Question

考虑以下任意函数和测试用例：

Function Foo-MyBar {
    Param(
        [Parameter(Mandatory=$false)]
        [ScriptBlock] $Filter
    )

    if (!$Filter) { 
        $Filter = { $true } 
    }

    #$Filter = $Filter.GetNewClosure()

    Get-ChildItem "$env:SYSTEMROOT" | Where-Object $Filter   
}

##################################

$private:pattern = 'T*'

Get-Help Foo-MyBar -Detailed

Write-Host "`n`nUnfiltered..."
Foo-MyBar

Write-Host "`n`nTest 1:. Piped through Where-Object..."
Foo-MyBar | Where-Object { $_.Name -ilike $private:pattern  }

Write-Host "`n`nTest 2:. Supplied a naiive -Filter parameter"
Foo-MyBar -Filter { $_.Name -ilike $private:pattern }

在测试1中，我们通过Foo-MyBar过滤器管理Where-Object的结果，该过滤器将返回的对象与私有范围变量$private:pattern中包含的模式进行比较。在这种情况下，这将正确返回C：\中以字母T开头的所有文件/文件夹。

在测试2中，我们将相同的过滤脚本作为参数直接传递给Foo-MyBar。但是，当Foo-MyBar运行过滤器时，$private:pattern不在范围内，因此不返回任何项目。

我理解为什么会这样 - 因为传递给Foo-MyBar的ScriptBlock不是闭包，所以不会关闭$private:pattern变量并且该变量丢失。

我从评论中注意到我之前有一个有缺陷的第三个测试，它试图传递{...}。GetNewClosure（），但这并没有关闭私有范围的变量 - 感谢@PetSerAl帮助我澄清这一点。

问题是，Where-Object如何在测试1中捕获$private:pattern的值，以及我们如何在我们自己的函数/ cmdlet中实现相同的行为？

（最好不要求调用者必须知道闭包，或者知道将过滤器脚本作为闭包传递。）

我注意到，如果我取消注释$Filter = $Filter.GetNewClosure()中的Foo-MyBar线，那么它永远不会返回任何结果，因为$private:pattern丢失了。

（正如我在顶部所说，函数和参数在这里是任意的，作为我真实问题的最短形式再现！）

Answer 1

给出的示例不起作用，因为默认情况下调用函数将进入新范围。 Where-Object仍会调用过滤器脚本而不输入过滤器脚本，但该函数的范围没有private变量。

有三种方法可以解决这个问题。

将功能放在与呼叫者不同的模块中

每个模块都有一个SessionState，它有自己的SessionStateScopes堆栈。每个ScriptBlock都与SessionState绑在一起被解析。

如果调用模块中定义的函数，则会在该模块的SessionState中创建新范围，但不会在顶级SessionState内创建。因此，当Where-Object在不输入新范围的情况下调用过滤器脚本时，它会在SessionState所绑定的ScriptBlock的当前范围内执行此操作。

这有点脆弱，因为如果你想从你的模块中调用该函数，那么你就不能。它会有同样的问题。

使用点源运算符调用该函数

您很可能已经知道用于调用脚本文件而不创建新范围的点源运算符（.）。这也适用于命令名称和ScriptBlock对象。

. { 'same scope' }
. Foo-MyBar

但请注意，这将调用函数所在的SessionState当前范围内的函数，因此您不能依赖.始终在调用者的当前范围内执行。因此，如果使用点源运算符调用与不同SessionState关联的函数（例如（不同）模块中定义的函数），则可能会产生意外影响。创建的变量将持续存在于将来的函数调用中，并且函数本身中定义的任何辅助函数也将持续存在。

写一个Cmdlet

编译的命令（cmdlet）在调用时不会创建新的作用域。你也可以使用类似的API来Where-Object使用（虽然不完全相同）

以下是如何使用公共API实现Where-Object的粗略实现

using System.Management.Automation;

namespace MyModule
{
    [Cmdlet(VerbsLifecycle.Invoke, "FooMyBar")]
    public class InvokeFooMyBarCommand : PSCmdlet
    {
        [Parameter(ValueFromPipeline = true)]
        public PSObject InputObject { get; set; }

        [Parameter(Position = 0)]
        public ScriptBlock FilterScript { get; set; }

        protected override void ProcessRecord()
        {
            var filterResult = InvokeCommand.InvokeScript(
                useLocalScope: false,
                scriptBlock: FilterScript,
                input: null,
                args: new[] { InputObject });

            if (LanguagePrimitives.IsTrue(filterResult))
            {
                WriteObject(filterResult, enumerateCollection: true);
            }
        }
    }
}

Answer 2

Where-Object如何在测试1中捕获$private:pattern的值

从the source code for Where-Object in PowerShell Core可以看出，PowerShell在内部调用过滤器脚本而不将其限制在自己的局部范围内（_script是FilterScript参数的私有支持字段，请注意传递给useLocalScope: false的DoInvokeReturnAsIs()参数）：

protected override void ProcessRecord()
{
    if (_inputObject == AutomationNull.Value)
        return;

    if (_script != null)
    {
        object result = _script.DoInvokeReturnAsIs(
            useLocalScope: false, // <-- notice this named argument right here
            errorHandlingBehavior: ScriptBlock.ErrorHandlingBehavior.WriteToCurrentErrorPipe,
            dollarUnder: InputObject,
            input: new object[] { _inputObject },
            scriptThis: AutomationNull.Value,
            args: Utils.EmptyArray<object>());

        if (_toBoolSite.Target.Invoke(_toBoolSite, result))
        {
            WriteObject(InputObject);
        }
    }
    // ...
}

我们如何在自己的函数/ cmdlet中实现相同的行为？

我们没有 - DoInvokeReturnAsIs()（和类似的scriptblock调用工具）标记为internal，因此只能由System.Management.Automation程序集中包含的类型调用