对于 PowerShell cmdlet，我可以始终将脚本块传递给字符串参数吗？

Question

我正在查看 PowerShell 的Rename-Item cmdlet 的文档，并且有一个这样的示例。

Get-ChildItem *.txt | Rename-Item -NewName { $_.name -Replace '\.txt','.log' }

此示例说明如何使用 Replace 运算符重命名多个文件，即使 NewName 参数不接受通配符也是如此。

此命令将当前目录中的所有 .txt 文件重命名为 .log。

该命令使用 Get-ChildItem cmdlet 获取当前文件夹中具有 .txt 文件扩展名的所有文件。 然后，它使用管道运算符 (|) 将这些文件发送到 Rename-Item 。

NewName 的值是在将值提交给 NewName 参数之前运行的脚本块。

注意最后一句话：

NewName 的值是在将值提交给 NewName 参数之前运行的脚本块。

实际上NewName是一个字符串：

[-NewName] <String>

那么这是否意味着当所需的参数类型是字符串时，我总是可以使用脚本块？

Answer 1

# Delay-bind script-block argument:
# The code inside { ... } is executed for each input object ($_) and
# the output is passed to the -NewName parameter.
... | Rename-Item -NewName { $_.Name -replace '\.txt$','.log' }

上面的调用显示了延迟绑定脚本块( { ... } ) 参数的应用，这是一个隐式功能：

• 仅适用于旨在接受管道输入的参数，

  • 除以下类型外的任何类型，在这种情况下会发生常规参数绑定^[1] ：

    • [scriptblock]
    • [object] （ [psobject]确实有效，因此[pscustomobject]也有效）
    • （未指定类型），实际上与[object]相同

  • 此类参数是按值( ValueFromPipelineBy ) 还是按属性名称( ValueFromPipelineByPropertyName ) 接受管道输入是无关紧要的。

• 通过传递的脚本块而不是类型适当的参数启用每个输入对象的转换； 脚本块针对每个管道对象进行评估，该对象在脚本块内部可作为$_ ，像往常一样，并且脚本块的输出- 假定为适合参数的类型 - 用作参数。

  • 由于此类临时脚本块的定义与您的目标参数类型不匹配，因此在传递它们时必须始终明确使用参数名称。

  • 延迟绑定脚本块无条件提供接入管道输入对象，即使该参数将通常不会被给定的管道对象的约束，如果它被定义为ValueFromPipelineByPropertyName和对象没有该名称的属性。

  • 这启用了诸如以下对Rename-Item调用的技术，其中来自Get-Item的管道输入 - 像往常一样 - 绑定到-LiteralPath参数，但将脚本块传递给-NewName - 通常只绑定到输入对象带有.NewName属性 - 允许访问相同的管道对象，从而从输入文件名中导出目标文件名：

    • Get-Item file | Rename-Item -NewName { $_.Name + '1' } # renames 'file' to 'file1' Get-Item file | Rename-Item -NewName { $_.Name + '1' } # renames 'file' to 'file1' ; 输入同时结合-LiteralPath （隐式地）和-NewName脚本块。

  • 注意：与传递给ForEach-Object或Where-Object脚本块不同，例如，延迟绑定脚本块在子变量作用域^{[2] 中运行}，这意味着您不能直接修改调用者的变量，例如增加一个计数器输入对象。
    作为一种解决方法，使用在调用者范围内声明的[ref]类型变量并访问其脚本块内的.Value属性 - 请参阅此答案以获取示例。

---

[1] 错误条件：

• 如果您错误地尝试将脚本块传递给非管道绑定或[scriptblock] - 或[object] -typed (untyped) 的参数，则会发生常规参数绑定：

  • 在管道输入处理开始之前，脚本块被传递一次，如果有的话。
    也就是说，脚本块作为（可能转换的） value传递，并且不会发生任何评估。
    • 对于[object]或[scriptblock]类型的参数/可转换为脚本块的委托类型（例如System.Func ，脚本块将按原样绑定。
    • 在（非管道绑定） [string]类型参数的情况下，脚本块的文字内容作为字符串值传递。
    • 对于所有其他类型，参数绑定 - 以及整个命令 - 将简单地失败，因为从脚本块转换是不可能的。

• 如果你忽略了提供管道输入，同时通过延迟绑定脚本块到支持他们的管道结合参数，你会得到以下错误：

  • Cannot evaluate parameter '<name>' because its argument is specified as a script block and there is no input. A script block cannot be evaluated without input.

---

^{[2] 此GitHub 问题正在讨论此差异。}

Answer 2

那么这是否意味着当所需的参数类型是字符串时，我总是可以使用脚本块？ :没有

这里的技术称为Delay Binding ，在这种情况下非常有用。

当你做延迟绑定时会发生什么？

PowerShell ParameteBinder 会理解延迟绑定的用法，并会先执行 ScriptBlock，然后将输出转换为相应参数的预期类型，这里是字符串。

下面是一个例子。

#Working one
'Path'|Join-Path -Path {$_} -ChildPath 'File'  

#Not working one
Join-Path -Path {'path'} -ChildPath 'File'
Join-Path : Cannot evaluate parameter 'Path' because its argument is specified as a script block and there is no input. A script block cannot be evaluated without input.

要了解有关 ParameterBinding 的更多信息，您可以执行如下所示的Trace-Command 。

Trace-Command ParameterBinding -Expression {'Path'|Join-Path -Path {$_} -ChildPath 'File'} -PSHost

Answer 3

使用延迟绑定，参数可以使用脚本块而不是参数的实际数据类型从管道接收值。

在脚本块中，$_ 代表管道值。

它仅在管道上有输入时可用。