about_Script_Blocks

  • 项目

简短说明

定义什么是脚本块，并解释如何在 PowerShell 编程语言中使用脚本块。

长说明

在 PowerShell 编程语言中，脚本块是可作为单个单元使用的语句或表达式的一个集合。 语句的集合可以括在大括号（{}），定义为函数或保存在脚本文件中。 脚本块可以返回值并接受参数和参数。

从语法上讲，脚本块是大括号中的语句列表，如以下语法所示：

{<statement list>}

脚本块以单个对象或数组的形式返回脚本块中所有命令的输出。

还可以使用 return 关键字指定返回值。 return 关键字 (keyword)不会影响或禁止从脚本块返回的其他输出。 但是，return 关键字会在该行退出脚本块。 有关详细信息，请参阅 about_Return。

与函数一样，脚本块可以包含参数。 使用 Param 关键字分配命名参数，如以下语法所示：

{
    Param([type]$Parameter1 [,[type]$Parameter2])
    <statement list>
}

注意

在脚本块中，与函数不同，不能在大括号之外指定参数。

与函数一样，脚本块可以包含 dynamicparam、begin、process 和 end 关键字。 有关详细信息，请参阅 about_Functions 和 about_Functions_Advanced。

使用脚本块

脚本块是 Microsoft .NET Framework 类型 System.Management.Automation.ScriptBlock 的实例。 命令可以包含脚本块参数值。 例如，Invoke-Command cmdlet 有一个采用脚本块值的 ScriptBlock 参数，如以下示例所示：

Invoke-Command -ScriptBlock { Get-Process }

Handles  NPM(K)    PM(K)     WS(K) VM(M)   CPU(s)     Id ProcessName
-------  ------    -----     ----- -----   ------     -- -----------
999          28    39100     45020   262    15.88   1844 communicator
721          28    32696     36536   222    20.84   4028 explorer
...

Invoke-Command 还可以执行包含参数块的脚本块。 使用 ArgumentList 参数按位置分配参数。

Invoke-Command -ScriptBlock { param($p1, $p2)
"p1: $p1"
"p2: $p2"
} -ArgumentList "First", "Second"

p1: First
p2: Second

前面示例中的脚本块使用 param 关键字创建参数 $p1 和 $p2。 字符串“First”绑定到第一个参数 ($p1)，“Second”绑定到 ($p2)。

有关 ArgumentList 的行为的详细信息，请参阅 about_Splatting。

可以使用变量来存储和执行脚本块。 以下示例将脚本块存储在变量中并将其传递给 Invoke-Command。

$a = { Get-Service BITS }
Invoke-Command -ScriptBlock $a

Status   Name               DisplayName
------   ----               -----------
Running  BITS               Background Intelligent Transfer Ser...

调用运算符是执行存储在变量中的脚本块的另一种方式。 与 Invoke-Command 一样，调用运算符在子范围内执行脚本块。 调用运算符可让你更轻松地在脚本块中使用参数。

$a ={ param($p1, $p2)
"p1: $p1"
"p2: $p2"
}
&$a -p2 "First" -p1 "Second"

p1: Second
p2: First

可以使用赋值将脚本块的输出存储在变量中。

PS>  $a = { 1 + 1}
PS>  $b = &$a
PS>  $b
2

PS>  $a = { 1 + 1}
PS>  $b = Invoke-Command $a
PS>  $b
2

有关调用运算符的详细信息，请参阅 about_Operators。

使用带参数的延迟绑定脚本块

接受管道输入的类型化参数允许在参数中使用 delay-bind 脚本块。 可以使用延迟绑定脚本块作为简写形式在执行管道 cmdlet 之前为其定义参数。

在延迟绑定脚本块中，可以使用管道变量 $_ 引用通过管道传入的对象。

# Both examples rename config.log to old_config.log
# Without delay-binding
dir config.log | ForEach-Object -Process {
  Rename-Item -Path $_ -NewName "old_$($_.Name)"
}
# With delay-binding
dir config.log | Rename-Item -NewName { "old_$($_.Name)" }

在更复杂的 cmdlet 中，延迟绑定脚本块允许重用一个通过管道传入的对象来填充其他参数。

有关将延迟绑定脚本块用作参数的注意事项：

  • 必须显式指定与延迟绑定脚本块一起使用的任何参数名称。

  • 参数不得为非类型化，参数的类型不能为 [scriptblock] 或 [object]。

  • 如果使用延迟绑定脚本块而不提供管道输入，则会收到错误。

    Rename-Item -NewName {$_.Name + ".old"}

    Rename-Item : Cannot evaluate parameter 'NewName' because its argument is
specified as a script block and there is no input. A script block cannot
be evaluated without input.
At line:1 char:23
+  Rename-Item -NewName {$_.Name + ".old"}
+                       ~~~~~~~~~~~~~~~~~~
    + CategoryInfo          : MetadataError: (:) [Rename-Item],
      ParameterBindingException
    + FullyQualifiedErrorId : ScriptBlockArgumentNoInput,
      Microsoft.PowerShell.Commands.RenameItemCommand

另请参阅