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

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

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不在范围内，因此不会返回任何项目。

我明白why情况就是这样——因为 ScriptBlock 传递给Foo-MyBar不是一个closure，所以不会关闭$private:pattern变量并且该变量丢失。

我从评论中注意到，我之前有一个有缺陷的第三个测试，它试图通过 {...}.GetNewClosure()，但这不会关闭私有范围的变量 - 感谢 @PetSerAl 帮助我澄清这一点。

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

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

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

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

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

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

将函数放在与调用者不同的模块中

每个模块都有一个SessionState它有自己的堆栈SessionStateScopes。每一个ScriptBlock与SessionStateis 被解析到.

如果调用模块中定义的函数，则会在该模块的范围内创建一个新作用域SessionState，但不在顶层内SessionState。因此当Where-Object调用过滤器脚本而不输入新的范围，它在当前范围内执行此操作SessionState到那个ScriptBlock被绑住了。

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

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

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

. { 'same scope' }
. Foo-MyBar

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

编写 Cmdlet

编译命令 (cmdlet) 在调用时不会创建新作用域。您还可以使用类似的 APIWhere-Object使用（虽然不完全相同）

这是如何实施的粗略实施Where-Object使用公共 API

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);
            }
        }
    }
}