about_Functions

简短说明

介绍如何在 PowerShell 中创建和使用函数。

长说明

函数是 PowerShell 语句的列表，其中包含分配的名称。 运行函数时，请键入函数名称。 列表中语句的运行方式与在命令提示符处键入这些语句一样。

函数可以很简单，比如：

function Get-PowerShellProcess { Get-Process pwsh }

定义函数后，可以像内置 cmdlet 一样使用它。 例如，若要调用新定义的 Get-PowerShellProcess 函数：

Get-PowerShellProcess

 NPM(K)    PM(M)      WS(M)     CPU(s)      Id  SI ProcessName
 ------    -----      -----     ------      --  -- -----------
    110    78.72     172.39      10.62   10936   1 pwsh

函数也可以像 cmdlet 或应用程序一样复杂。

与 cmdlet 一样，函数可以附带参数。 参数可以是命名参数、位置参数、开关参数或动态参数。 可以从命令行或管道读取函数参数。

函数可以返回可显示、赋给变量或传递给其他函数或 cmdlet 的值。 还可以使用 return 关键字指定返回值。 return 关键字不会影响或抑制从函数返回的其他输出。 但是，return 关键字会在该行退出函数。 有关详细信息，请参阅 about_Return。

函数的语句列表可以包含带有关键字 begin、process、end 和 clean 的不同类型的语句列表。 这些语句列表以不同的方式处理来自管道的输入。

filter 关键字用于创建在管道中的每个对象上运行的函数类型。 筛选器类似于所有语句都位于 process 块中的函数。

函数也可以像 cmdlet 一样运行。 可以创建一个像 cmdlet 一样工作的函数，而无需使用 C# 编程。 有关详细信息，请参阅 about_Functions_Advanced。

重要

在脚本文件和基于脚本的模块中，必须先定义函数，然后才能调用它们。

语法

下面是函数的语法：

function [<scope:>]<name> [([type]$parameter1[,[type]$parameter2])]
{
  begin {<statement list>}
  process {<statement list>}
  end {<statement list>}
  clean {<statement list>}
}

function [<scope:>]<name>
{
  param([type]$parameter1 [,[type]$parameter2])
  dynamicparam {<statement list>}
  begin {<statement list>}
  process {<statement list>}
  end {<statement list>}
  clean {<statement list>}
}

函数包含以下各项：

• function 关键字
• 作用域（可选）
• 选择的名称
• 任意数量的命名参数（可选）
• 括在大括号 {} 中的一个或多个 PowerShell 命令

有关函数中的 dynamicparam 关键字和动态参数的详细信息，请参阅 about_Functions_Advanced_Parameters。

输入处理方法

本部分所述的方法称为输入处理方法。 对于函数，这三种方法由函数的 begin、process 和 end 块表示。 PowerShell 7.3 添加了 clean 块进程方法。

并非必须在函数中使用其中任何一个块。 如果不使用命名块，PowerShell 会将代码置于函数的 end 块中。 但是，如果使用这些命名块中的任何一个，或定义 dynamicparam 块，则必须将所有代码放入命名块中。

以下示例显示了一个函数的轮廓，该函数包含用于一次性预处理的 begin 块、用于多记录处理的 process 块，以及用于一次性处理后处理的 end 块。

Function Test-ScriptCmdlet
{
[CmdletBinding(SupportsShouldProcess=$True)]
    Param ($Parameter1)
    begin{}
    process{}
    end{}
}

begin

此块用于为函数提供可选的一次性预处理。 PowerShell 运行时会为管道中函数的每个实例使用此块中的代码一次。

process

此块用于为函数提供逐记录处理。 可以使用 process 块而无需定义其他块。 process 块执行的次数取决于你如何使用函数以及函数接收怎样的输入。

自动变量 $_ 或 $PSItem 包含管道中的当前对象，以便在 process 块中使用。 $input 自动变量包含一个仅可用于函数和脚本块的枚举器。 有关详细信息，请参阅 about_Automatic_Variables。

• 在管道开头或外部调用函数将执行 process 块一次。
• 在管道中，process 块为到达函数的每个输入对象都执行一次。
• 如果到达函数的管道输入为空，则 process 块不会执行。
  • endclean和begin块仍在执行。

重要

如果函数参数设置为接受管道输入，并且未定义 process 块，则逐记录处理将失败。 在这种情况下，无论输入如何，函数都将只执行一次。

end

此块用于为函数提供可选的一次性后处理。

clean

clean 块是在 PowerShell 7.3 中添加的。

clean 块是一种方便用户清理跨 begin、process 和 end 块的资源的方法。 它在语义上类似于 finally 块，该块涵盖脚本函数或脚本 cmdlet 的所有其他命名块。 对于以下场景，将强制执行资源清理：

1. 管道执行正常完成，没有终止错误
2. 管道执行因终止错误而中断
3. 通过 Select-Object -First 停止管道
4. 通过 Ctrl+c 或 StopProcessing() 停止管道

清理块将丢弃写入 Success 流的任何输出。

注意

添加 clean 块属于一项中断性变更。 由于 clean 是作为关键字分析的，因此它可以阻止用户直接调用名为 clean 的命令作为脚本块中的第一个语句。 然而，这不太可能是个问题。 仍可以使用调用运算符 (& clean) 调用该命令。

简单函数

函数不一定要复杂才有用。 最简单的函数采用以下格式：

function <function-name> {statements}

例如，以下函数使用“以管理员身份运行”选项启动 PowerShell。

function Start-PSAdmin {Start-Process PowerShell -Verb RunAs}

若要运行函数，请键入：Start-PSAdmin

若要向函数添加语句，请在单独的行中键入每个语句，或使用分号 ; 分隔语句。

例如，以下函数查找当前用户目录中在开始日期之后更改的所有 .jpg 文件。

function Get-NewPix
{
  $start = Get-Date -Month 1 -Day 1 -Year 2010
  $allpix = Get-ChildItem -Path $env:UserProfile\*.jpg -Recurse
  $allpix | Where-Object {$_.LastWriteTime -gt $Start}
}

可以创建一个包含实用小型函数的工具箱。 将这些函数添加到 PowerShell 配置文件，如 about_Profiles 及本主题后面部分所述。

函数名称

可以为函数分配任何名称，但与其他人共享的函数应遵循为所有 PowerShell 命令建立的命名规则。

函数名称应包含谓词-名词对，其中谓词标识函数执行的操作，名词标识 cmdlet 对其执行操作的项。

函数应使用已批准用于所有 PowerShell 命令的标准谓词。 这些谓词帮助我们保持命令名称一致并易于用户理解。

有关标准 PowerShell 谓词的详细信息，请参阅批准的谓词。

带参数的函数

可以结合参数使用函数，包括命名参数、位置参数、开关参数和动态参数。 有关函数中动态参数的详细信息，请参阅 about_Functions_Advanced_Parameters。

命名的参数

可以定义任意数量的命名参数。 可以包含命名参数的默认值，如本主题后面所述。

可以使用 param 关键字在大括号内定义参数，如以下示例语法所示：

function <name> {
  param ([type]$parameter1 [,[type]$parameter2])
  <statement list>
}

还可以在大括号之外定义参数而不使用 Param 关键字，如以下示例语法所示：

function <name> [([type]$parameter1[,[type]$parameter2])] {
  <statement list>
}

下面是此替代语法的示例。

function Add-Numbers([int]$one, [int]$two) {
    $one + $two
}

虽然首选第一种方法，但这两种方法之间没有区别。

运行该函数时，为参数提供的值将赋给包含参数名称的变量。 该变量的值可以在函数中使用。

以下示例是一个名为 Get-SmallFiles 的函数。 该函数附带 $Size 参数。 该函数显示所有小于 $Size 参数值的文件，并且不包括目录：

function Get-SmallFiles {
  Param($Size)
  Get-ChildItem $HOME | Where-Object {
    $_.Length -lt $Size -and !$_.PSIsContainer
  }
}

在该函数中，可以使用 $Size 变量，该变量是为参数定义的名称。

若要使用此函数，请键入以下命令：

Get-SmallFiles -Size 50

还可以为没有参数名称的命名参数输入值。 例如，以下命令提供与命名 Size 参数的命令相同的结果：

Get-SmallFiles 50

若要定义参数的默认值，请在参数名称后面键入等号和值，如 Get-SmallFiles 示例中的以下变体所示：

function Get-SmallFiles ($Size = 100) {
  Get-ChildItem $HOME | Where-Object {
    $_.Length -lt $Size -and !$_.PSIsContainer
  }
}

如果键入 Get-SmallFiles 而不指定值，则函数会将 100 赋给 $size。 如果提供值，该函数将使用该值。

或者，可以通过将 PSDefaultValue 属性添加到参数描述中并指定 PSDefaultValue 的 Help 属性来提供描述参数默认值的简短帮助字符串。 若要提供描述 Get-SmallFiles 函数中 Size 参数的默认值 (100) 的帮助字符串，请添加 PSDefaultValue 属性，如以下示例所示。

function Get-SmallFiles {
  param (
      [PSDefaultValue(Help = '100')]
      $Size = 100
  )
  Get-ChildItem $HOME | Where-Object {
    $_.Length -lt $Size -and !$_.PSIsContainer
  }
}

有关 PSDefaultValue 属性类的详细信息，请参阅 PSDefaultValue 属性成员。

位置参数

位置参数是没有参数名称的参数。 PowerShell 使用参数值顺序将每个参数值与函数中的参数关联。

使用位置参数时，请在函数名称后面键入一个或多个值。 位置参数值赋给 $args 数组变量。 函数名称后面的值赋给 $args 数组中的第一个位置 $args[0]。

以下 Get-Extension 函数将 .txt 文件扩展名添加到提供的文件名：

function Get-Extension {
  $name = $args[0] + ".txt"
  $name
}

Get-Extension myTextFile

myTextFile.txt

开关参数

开关参数是不需要值的参数。 应该键入函数名称，后跟开关参数的名称。

若要定义开关参数，请在参数名称之前指定类型 [switch]，如以下示例所示：

function Switch-Item {
  param ([switch]$on)
  if ($on) { "Switch on" }
  else { "Switch off" }
}

在函数名称后键入 On 开关参数时，该函数将显示 Switch on。 如果没有开关参数，它将显示 Switch off。

Switch-Item -on

Switch on

Switch-Item

Switch off

还可以在运行函数时将布尔值赋给开关，如以下示例所示：

Switch-Item -on:$true

Switch on

Switch-Item -on:$false

Switch off

使用散列传递表示命令参数

可以使用散列传递来表示命令的参数。 此功能是在 Windows PowerShell 3.0 中引入的。

在会话中调用命令的函数中使用此技术。 无需声明或枚举命令参数，也无需在命令参数更改时更改函数。

以下示例函数调用 Get-Command cmdlet。 该命令使用 @Args 来表示 Get-Command 的参数。

function Get-MyCommand { Get-Command @Args }

调用 Get-MyCommand 函数时，可以使用 Get-Command 的所有参数。 参数和参数值使用 @Args 传递给命令。

Get-MyCommand -Name Get-ChildItem

CommandType     Name                ModuleName
-----------     ----                ----------
Cmdlet          Get-ChildItem       Microsoft.PowerShell.Management

@Args 功能使用 $Args 自动参数，该参数表示未声明的 cmdlet 参数和剩余参数的值。

有关详细信息，请参阅 about_Splatting。

通过管道将对象传递给函数

任何函数都可以从管道获取输入。 可以使用 begin、process、end 和 clean 关键字来控制函数如何处理来自管道的输入。 以下示例语法显示了这些关键字：

process 语句列表针对管道中的每个对象运行一次。 当 process 块运行时，每个管道对象都被分配给 $_ 自动变量，一次分配一个管道对象。

以下函数使用 process 关键字。 该函数显示管道中的值：

function Get-Pipeline
{
  process {"The value is: $_"}
}

1,2,4 | Get-Pipeline

The value is: 1
The value is: 2
The value is: 4

如果想要一个可以从参数获取管道输入或输入的函数，则 process 块需要处理这两种情况。 例如：

function Get-SumOfNumbers {
    param (
        [int[]]$Numbers
    )

    begin { $retValue = 0 }

    process {
        if ($null -ne $Numbers) {
           foreach ($n in $Numbers) {
               $retValue += $n
           }
        } else {
           $retValue += $_
        }
    }

    end { $retValue }
}

PS> 1,2,3,4 | Get-SumOfNumbers
10
PS> Get-SumOfNumbers 1,2,3,4
10

在管道中使用函数时，传递给函数的对象将分配给 $input 自动变量。 在有任何对象来自管道之前，该函数运行带有 begin 关键字的语句。 从管道接收到所有对象后，该函数运行带有 end 关键字的语句。

以下示例演示具有 begin 和 end 关键字的 $input 自动变量。

function Get-PipelineBeginEnd {
    begin   { "Begin: The input is $input" }
    end     { "End:   The input is $input" }
}

如果使用管道运行此函数，则会显示以下结果：

1,2,4 | Get-PipelineBeginEnd

Begin: The input is
End:   The input is 1 2 4

当 begin 语句运行时，该函数没有来自管道的输入。 end 语句在函数获得值后运行。

如果函数有 process 关键字，$input 中的每个对象都会从 $input 中移除并分配给 $_。 以下示例包含 process 语句列表：

function Get-PipelineInput
{
    process {"Processing:  $_ " }
    end     {"End:   The input is: $input" }
}

在此示例中，传递给函数的每个对象都将发送到 process 语句列表。 process 语句在每个对象上运行，一次运行一个对象。 当函数到达 end 关键字时，$input 自动变量为空。

1,2,4 | Get-PipelineInput

Processing:  1
Processing:  2
Processing:  4
End:   The input is:

有关详细信息，请参阅使用枚举器

PowerShell 7.3 添加了 clean 块。 clean 块是一种方便用户清理 begin、process 和 end 块中创建和使用的资源的方法。 它在语义上类似于 finally 块，该块涵盖脚本函数或脚本 cmdlet 的所有其他命名块。 对于以下场景，将强制执行资源清理：

1. 管道执行正常完成，没有终止错误
2. 管道执行因终止错误而中断
3. 通过 Select-Object -First 停止管道
4. 通过 Ctrl+C 或 StopProcessing() 停止管道

注意

添加 clean 块属于一项中断性变更。 由于 clean 是作为关键字分析的，因此它可以阻止用户直接调用名为 clean 的命令作为脚本块中的第一个语句。 然而，这不太可能是个问题。 仍可以使用调用运算符 (& clean) 调用该命令。

筛选器

筛选器是在管道中的每个对象上运行的函数类型。 筛选器类似于所有语句都位于 process 块中的函数。

筛选器的语法如下所示：

filter [<scope:>]<name> {<statement list>}

以下筛选器从管道获取日志条目，然后显示整个条目或仅显示条目的消息部分：

filter Get-ErrorLog ([switch]$Message)
{
  if ($Message) { Out-Host -InputObject $_.Message }
  else { $_ }
}

使用方法如下所示：

Get-WinEvent -LogName System -MaxEvents 100 | Get-ErrorLog -Message

函数作用域

函数存在于创建时所在的作用域中。

如果函数是脚本的一部分，该函数可用于该脚本中的语句。 默认情况下，脚本中的函数在该脚本之外不可用。

可以指定函数的作用域。 例如，该函数将添加到以下示例中的全局作用域：

function global:Get-DependentSvs {
  Get-Service | Where-Object {$_.DependentServices}
}

当函数位于全局作用域内时，可以在脚本、函数和命令行中使用函数。

函数会创建新的作用域。 在函数中创建的项（如变量）仅存在于函数作用域中。

有关详细信息，请参阅 about_Scopes。

使用 Function: 驱动器查找和管理函数

PowerShell 中的所有函数和筛选器都自动存储在 Function: 驱动器中。 此驱动器由 PowerShell Function 提供程序公开。

引用 Function: 驱动器时，请在 Function 后键入冒号，就像引用计算机的 C 或 D 驱动器那样。

以下命令显示 PowerShell 当前会话中的所有函数：

Get-ChildItem function:

函数中的命令作为脚本块存储在函数的定义属性中。 例如，若要在 PowerShell 附带的 Help 函数中显示命令，请键入：

(Get-ChildItem function:help).Definition

还可以使用以下语法。

$function:help

有关 Function: 驱动器的详细信息，请参阅 Function 提供程序的帮助主题。 键入 Get-Help Function。

在新会话中重用函数

在 PowerShell 命令提示符下键入函数后，该函数将成为当前会话的一部分。 该函数在会话结束之前可用。

若要在所有 PowerShell 会话中使用函数，请将该函数添加到 PowerShell 配置文件。 有关配置文件的详细信息，请参阅 about_Profiles。

还可以将函数保存在 PowerShell 脚本文件中。 在文本文件中键入函数，然后使用 .ps1 文件扩展名保存该文件。

编写函数帮助

Get-Help cmdlet 可获取有关函数以及 cmdlet、提供程序和脚本的帮助。 若要获取有关某个函数的帮助，请键入 Get-Help，后跟函数名称。

例如，若要获取有关 Get-MyDisks 函数的帮助，请键入：

Get-Help Get-MyDisks

可以使用以下两种方法之一为函数编写帮助：

• 基于注释的函数帮助

  使用注释中的特殊关键字创建帮助主题。 若要为函数创建基于注释的帮助，必须将注释放在函数正文的开头或末尾，或放在函数关键字前面的行上。 有关基于注释的帮助的详细信息，请参阅 about_Comment_Based_Help。

• 基于 XML 的函数帮助

  创建基于 XML 的帮助主题，例如通常为 cmdlet 创建的类型。 如果要将帮助主题本地化为多种语言，则需要基于 XML 的帮助。

  若要将函数与基于 XML 的帮助主题关联，请使用基于注释的帮助关键字 .EXTERNALHELP。 如果没有此关键字，Get-Help 将无法找到函数帮助主题，并且调用 Get-Help 函数将仅返回自动生成的帮助。

  有关 .EXTERNALHELP 关键字的详细信息，请参阅 about_Comment_Based_Help。 有关基于 XML 的帮助的详细信息，请参阅如何编写 Cmdlet 帮助。

另请参阅

• about_Automatic_Variables
• about_Comment_Based_Help
• about_Function_Provider
• about_Functions_Advanced
• about_Functions_Advanced_Methods
• about_Functions_Advanced_Parameters
• about_Functions_CmdletBindingAttribute
• about_Functions_OutputTypeAttribute
• about_Parameters
• about_Profiles
• about_Scopes
• about_Script_Blocks