6

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

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 }

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

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

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

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

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

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

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

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

4

2 回答 2

6

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

从PowerShell Core的源代码Where-Object中可以看出，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()（和类似的脚本块调用工具）被标记internal，因此只能由System.Management.Automation程序集中包含的类型调用

于 2018-08-16T21:03:41.583 回答
5

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

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

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

每个模块都有一个SessionState，它有自己的SessionStateScopes 堆栈。每一个ScriptBlock都与SessionState被解析的 is 相关联。

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

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

使用点源运算符调用函数

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

. { 'same scope' }
. Foo-MyBar

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

编写 Cmdlet

编译的命令 (cmdlet) 在调用时不会创建新范围。您还可以使用与用途类似的 API Where-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);
            }
        }
    }
}
于 2018-08-16T23:40:01.487 回答