PowerShell 函数：综合初学者指南

我遇到过很多需要多次重复某项任务的情况。最初，我会复制并粘贴代码，更改变量，然后再次执行代码。这种方法效果很好，但耗时且容易出错。就在那时我发现了 PowerShell 函数。 PowerShell 函数是该语言的重要组成部分，使您能够创建可从脚本的不同部分调用的可重用代码块。

在本文中，我将带您逐步掌握PowerShell功能的过程。我们将从基础知识开始，逐步转向更高级的主题，例如函数参数、返回值、默认值和最佳实践。让我们开始吧！

PowerShell函数简介

在深入研究函数的创建之前，了解什么是函数以及它们为何有用非常重要。 PowerShell 函数是执行特定任务的代码块。它们与其他编程语言中的过程类似。可以从脚本的其他部分调用函数，从而使它们可重用且模块化。函数可以接受输入参数、执行一些操作并返回一个值。

在 PowerShell 脚本中定义函数的语法非常简单。您以 function 关键字开始，后跟函数名称和一组括号。在括号内，您可以指定函数采用的参数。在参数后面添加一组花括号，在其中放置函数执行的代码。

使用 PowerShell 函数的好处

以下是使用 PowerShell 函数的一些好处：

• 可重用性 - 函数允许您多次重用代码。这意味着您不必一遍又一遍地编写相同的代码。
• 模块化 - 函数可帮助您将代码分解为更小、更易于管理的模块。这使您的代码更有组织性并且更易于维护。
• 减少错误 - 通过使用函数，您可以减少代码中的错误数量。函数允许您以更小、更易于管理的块来测试代码。
• 可读性 - 函数使您的代码更具可读性。通过将代码分解为更小的模块，它会变得更容易理解和维护。
• 参数化：函数可以接受参数，这使得它们更加可定制和灵活。

如何在 PowerShell 中创建函数？

函数是可重用的代码块，可以执行特定任务并可以在脚本中多次调用。在 PowerShell 中创建函数非常简单。首先使用 function 关键字，后跟函数名称，然后添加一组花括号，在其中放置函数执行的代码。

PowerShell 函数的语法和结构

PowerShell函数的语法和结构如下：

function Function-Name {
    param (
        [parameter-type]$Parameter1,
        [parameter-type]$Parameter2
    )

    # Code to perform the desired tasks

    return $Result
}

• Function-Name：函数的名称，遵循我们之前讨论的命名约定。
• param：用于定义函数参数的关键字。
• $Parameter1、$Parameter2：函数的参数，其各自的类型位于 param 块中。
• # 用于执行所需任务的代码：执行与该函数关联的任务的代码。
• return $Result：返回语句，指定函数返回的值（如果有）。

通过遵循此结构，您可以创建定义明确且组织良好的 PowerShell 函数。这是一个简单的函数示例：

function Say-Hello {
    Write-output "Hello, World!"
}

定义函数后，您可以通过在花括号内添加必要的代码来实现其功能。每当调用该函数时都会执行此代码。

在 PowerShell 中调用函数

定义函数后，我们现在可以使用其名称来调用它。要调用函数，只需键入函数名称，后跟括号即可。例如，要调用我们之前定义的 Say-World 函数，我们可以编写：

PS C:\> Say-Hello

当我们运行此代码时，该函数将执行并输出消息“Hello，World！ ”到 PowerShell 控制台。如果您的函数有参数，则需要在调用函数时提供这些参数的值。

了解 PowerShell 函数参数

函数参数是调用函数时传递给函数的变量。它们使您能够将数据传递给函数并使其更加灵活。 PowerShell 支持两种类型的函数参数：命名参数和位置参数。

命名参数是使用函数定义内的 Param() 块指定的。您可以为命名参数分配默认值，使它们成为可选的。位置参数由它们在函数调用中的位置指定。它们是强制性的，并且它们的顺序很重要。每个参数都应该有一个名称和一个数据类型，以确保正确处理输入数据。 PowerShell 有多种数据类型，包括整数、字符串、布尔值、字符和数组。

创建带参数的 PowerShell 函数

参数允许您将输入值传递给 PowerShell 函数。它们使您能够根据提供的值自定义函数的行为。让我们创建一个简单的 PowerShell 函数，它接受两个参数并返回它们的总和。

function Add-Numbers {
    Param(
        [int]$a,
        [int]$b
    )

    $result = $a + $b
    Write-host $result
}

在此示例中，我们定义了一个名为 Add-Numbers 的函数，它采用两个整数参数（$a 和 $b）。在函数内部，我们添加了两个参数并将结果存储在名为 $result 的变量中。最后，我们使用 Write-host cmdlet 来获取屏幕上的值。要使用该函数，您只需在 PowerShell 命令行中通过其名称和参数来调用它即可：

Add-Numbers 5 2

让我们看一个更复杂的 PowerShell 函数示例。以下函数检索计算机上运行的前 10 个进程并将它们作为对象数组返回。

function Get-TopProcesses {
    Param(
        [int]$count = 10
    )

    $processes = Get-Process | Sort-Object -Property CPU -Descending | Select-Object -First $count

    $result = @()

    foreach ($process in $processes) {
        $obj = New-Object -TypeName PSObject
        $obj | Add-Member -MemberType NoteProperty -Name "Name" -Value $process.Name
        $obj | Add-Member -MemberType NoteProperty -Name "CPU" -Value $process.CPU
        $obj | Add-Member -MemberType NoteProperty -Name "Memory" -Value $process.WorkingSet
        $result += $obj
    }

    return $result
}

Get-TopProcesses

此函数采用可选的 count 参数，并检索计算机上运行的排名靠前的 count 进程。然后，它将每个进程转换为具有三个属性（Name、CPU 和 Memory）的对象，并返回这些对象的数组。

处理 PowerShell 函数中的多个参数

PowerShell 函数可以有多个参数，允许您以各种方式自定义函数的行为。定义多个参数时，您可以指定它们的类型和默认值（如果有）。调用具有多个参数的函数时，您需要按照函数中定义的顺序提供值。或者，您可以按参数名称指定参数值，这样您就可以按任意顺序提供它们。

具有多个参数的 PowerShell 函数示例

以下是具有多个参数的 PowerShell 函数的一些示例：

function New-User {
    param(
        [string]$FirstName,
        [string]$LastName,
        [string]$Email,
        [string]$Password
    )

    # Code goes here
}

PowerShell 函数中的参数验证

参数验证是编写 PowerShell 函数的重要部分。它确保传递给函数参数的值满足特定标准。这有助于及早捕获错误并向用户提供清晰的错误消息。 PowerShell 提供了多个内置参数验证属性。这里有些例子：

• ValidateNotNullOrEmpty - 此参数属性确保参数值不为 null 或空字符串。
• ValidateRange - 该属性确保参数值落在指定范围内。
• ValidateSet - 确保参数值是一组指定值之一。
• ValidateScript - 此属性允许您使用脚本块来验证参数值。

这里有些例子：

param(
    [Parameter(Mandatory=$true)]
    [ValidateNotNullOrEmpty()]
    [string] $Name
)

验证脚本属性：

param(
    [Parameter(Mandatory=$true)]
    [ValidateScript({
        if ($_ -match '^\d{4}-\d{2}-\d{2}$') { $true }
        else { throw 'Invalid format. The correct format is xxxx-xx-xx.' }
    })]
    [string] $SSN
)

同样，验证范围和验证集可用作：

#Validate Range: 
param(
    [Parameter(Mandatory=$true)]
    [ValidateRange(1,10)]
    [int] $Number
)

#ValidateSet: 
param(
    [Parameter(Mandatory=$true)]
    [ValidateSet('Red', 'Green', 'Blue')]
    [string] $Color
)

PowerShell 从函数返回值

PowerShell 函数可以返回值，允许您捕获函数的输出并在脚本的其他部分使用它。 return 关键字用于指定函数返回的值。如果函数没有 return 语句，它将返回函数中最后一个语句的输出。例如，以下函数返回 $result 变量的值：

function Get-Result {
    $result = "Hello, World!"
    $result
}

您可以使用 return 语句指定 PowerShell 函数返回的值。您可以使用它返回任何数据类型，包括字符串、整数、数组和对象。 return 语句终止函数并将指定值返回给调用者。

function Get-Message {
    return "Hello, World!"
}

在此示例中，Get-Message 函数返回字符串“Hello, World!”当它被调用时。要使用函数的输出，请将其分配给变量：

$Output = Get-Message

PowerShell 参数默认值

PowerShell 函数参数可以有默认值，当调用者未指定参数时使用默认值。默认值使参数成为可选参数，使您能够创建更灵活的函数。要在 PowerShell 中定义默认参数值，您可以在声明参数时为其分配一个值。

function Greet-User {
    Param(
        [string]$name = "World"
    )

    Write-Host "Hello, $name!"
}

在此示例中，Greet-User 函数有一个 name 参数，默认值为“World”。如果调用者未指定 name 参数的值，则默认为“World”。但是，如果用户提供一个值，它将覆盖默认值。例如。，

#Call function without specifying value for default parameter
Greet-User
#Returns: "Hello, World!"

#Call the function by supplying value to parameter
Greet-User -name "Salaudeen"
#Returns: "Hello, Salaudeen!"

当您有一个通常与特定值一起使用的参数时，这会很有用。使用默认参数可以使您的功能更方便使用，因为如果用户对默认值满意，可以省略某些参数。这是另一个例子：

Function Get-ServiceStatus {
    param (
        [string]$ServiceName
    )

    $service = Get-Service -Name $ServiceName -ErrorAction SilentlyContinue

    if ($Service.Status -eq "Running") {
        return "Service is running"
    } else {
        return "Service is not running"
    }
}

Get-ServiceStatus -ServiceName "Spooler"

在此示例中，我们定义了一个名为 Get-ServiceStatus 的函数，用于检查给定服务的状态。该函数采用 $ServiceName 参数，并使用它通过 Get-Service cmdlet 检索服务状态。我们调用 Get-ServiceStatus 函数并将值“Spooler”传递给 $ServiceName 参数。如果服务正在运行，则返回消息“Service is running”。否则，它返回“服务未运行”。

通过创建这样的函数，您可以将复杂的逻辑封装到可重用的代码块中，以便在需要时调用。

PowerShell 强制参数

默认情况下，PowerShell函数中的参数是可选的，这意味着用户在调用函数时可以省略它们。但是，在某些情况下，您可能希望强制使用某些参数以确保用户提供值。要在 PowerShell 中强制参数，您可以将 [Parameter(Mandatory)] 属性添加到参数声明中。

PowerShell 函数参数可以标记为强制参数，这意味着用户在调用该函数时必须为此参数提供一个值。如果用户未提供值，PowerShell 将提示他们输入该值。强制参数确保使用正确的参数调用函数并使函数更加健壮。

function Get-FileContent {
    Param(
        [Parameter(Mandatory=$true)]
        [string]$path
    )
    #Get contents of the file
    Get-Content $path
}

在此示例中，Get-FileContent 函数具有强制 path 参数。如果调用者未指定 path 参数的值，PowerShell 会提示他们输入一个值。

使用模块中的函数

PowerShell 模块是打包在一起以便于分发和管理的函数和脚本的集合。我们可以通过将模块导入到脚本中来调用模块中的函数。要导入模块，我们使用“Import-Module”cmdlet，后跟模块的名称。

例如，如果我们想使用“7Zip4PowerShell”模块中的“compress-7Zip”函数，我们可以这样写：

#Import 7zip PowerShell Module
Import-Module 7Zip4PowerShell

#Call a function to zip a File
Compress-7Zip "C:\Temp" -ArchiveFileName backup.zip -Format Zip

Tips：如何快速生成带参数和注释文档的函数？

您可以利用 Microsoft PowerShell ISE 中的片段功能快速生成 PowerShell 函数！此功能允许您将预定义脚本插入到当前脚本中。要使用代码片段，请转到编辑菜单，然后启动代码片段，您将看到代码片段列表。对于功能，请选择Cmdlet（高级功能）。

此代码片段将创建一个带有参数和基于注释的基本帮助的函数。您只需要将占位符替换为您的特定内容即可。

<#
.Synopsis
   Short description
.DESCRIPTION
   Long description
.EXAMPLE
   Example of how to use this cmdlet
.EXAMPLE
   Another example of how to use this cmdlet
#>
function Verb-Noun
{
    [CmdletBinding()]
    [Alias()]
    [OutputType([int])]
    Param
    (
        # Param1 help description
        [Parameter(Mandatory=$true,
                   ValueFromPipelineByPropertyName=$true,
                   Position=0)]
        $Param1,

        # Param2 help description
        [int]
        $Param2
    )

    Begin
    {
    }
    Process
    {
    }
    End
    {
    }
}

PowerShell 函数命名约定

在 PowerShell 中创建函数时，遵循命名约定以确保一致性和可读性非常重要。以下是命名 PowerShell 函数的一些最佳实践：

1. 使用动词-名词格式：函数名称以描述函数执行的操作的动词开头，后跟代表函数所作用的对象的名词。
2. 使用 PascalCase：将函数名称中每个单词的首字母大写，如 Get-Process。
3. 具有描述性：选择一个能够准确描述函数用途的名称。避免使用可能导致混淆的通用名称。

通过遵循这些命名约定，您可以使您的函数更加直观，并且对于您自己和可能需要使用您的代码的其他用户来说更容易理解。

function Get-ProcessCount {
    # Code to retrieve and count running processes
}

在上面的示例中，我们定义了一个名为 Get-ProcessCount 的函数，用于检索和计算正在运行的进程的数量。请注意，函数名称遵循动词-名词格式并以 PascalCase 书写。此命名约定有助于其他用户理解该函数的用途。

使用 PowerShell 函数的最佳实践

以下是使用 PowerShell 函数的一些最佳实践：

• 为您的函数使用描述性名称。使用动词-名词格式来命名您的函数。
• 使用基于注释的帮助来记录您的功能。
• 使用参数验证来确保传递给函数的参数有效。这有助于减少代码中的错误。
• 使用命名参数而不是位置参数。
• 使用可选参数的默认值。
• 必要时使用强制参数。
• 使用管道输入允许您的函数接受来自其他 cmdlet 的输入。这使您的代码更加灵活和可重用。
• 从函数返回一个值，即使它只是一个状态代码。
• 使用错误处理来捕获和报告错误。
• 测试您的功能：在生产中使用它们之前，请彻底测试以确保它们按预期工作。这有助于及早发现并修复任何问题或错误。

包起来

PowerShell 函数是该语言的重要组成部分，使您能够创建可从脚本的不同部分调用的可重用代码块。函数有助于简化代码、减少错误并提高脚本的可读性。在 PowerShell 中创建函数对于高效的代码管理和执行至关重要。

在本分步指南中，我们探索了在 PowerShell 中创建函数的过程。我们首先了解使用函数的目的和好处，然后了解 PowerShell 函数的命名约定和结构。然后我们深入研究了添加参数、使用默认参数、处理多个参数以及强制参数。我们还讨论了从函数返回值、调用函数，并提供了一个示例函数来说明这些概念。最后，我们重点介绍了在 PowerShell 中创建函数的最佳实践。

经常问的问题：

PowerShell 中的函数和方法有什么区别？

在 PowerShell 中，函数是执行特定任务的独立代码块，可以从脚本中的任何位置调用。另一方面，方法是与特定对象或类型关联的函数，并且只能在该对象或类型上调用。方法通常用于操纵与其关联的对象或与之交互。

如何使用参数调用PowerShell函数？

要调用带参数的 PowerShell 函数，您只需在调用函数时提供参数值即可。例如，如果您有一个名为“MyFunction”的函数，其参数为“Param1”和“Param2”，则可以这样调用它：“MyFunction -Param1 Value1 -Param2 Value2”。

如何从 ps1 文件调用 PowerShell 函数？

要从 .ps1 文件调用 PowerShell 函数，您必须使用句点 (.) 后跟一个空格，然后是 ps1 文件的路径 (. .\YourFile) 将其加载到 PowerShell 会话中.ps1，如果您的文件位于同一目录中）。现在，您可以调用该函数。

. "C:\Scripts\Utility.ps1"
Say-Hello

如何在 PowerShell 中永久添加函数？

要在 PowerShell 中永久添加函数，您可以创建 PowerShell 脚本文件 (.ps1) 并在其中定义函数。然后，您可以将脚本文件保存在系统 PATH 环境变量中包含的目录中。这样，就可以从任何 PowerShell 会话访问该函数。

如何在 PowerShell 中的函数内调用函数？

要在 PowerShell 中调用另一个函数内的函数，只需使用函数名称后跟括号即可。例如，如果您有一个名为“Function1”的函数，并且想要从另一个名为“Function2”的函数调用它，则可以使用语法“Function1()”。

如何退出PowerShell函数？

要退出 PowerShell 函数，您可以使用“return”关键字，后跟要返回的值。这将立即退出该函数并返回指定的值。

PowerShell 函数可以返回多个值吗？

是的，PowerShell 函数可以返回多个值。您可以使用“return”语句后跟逗号分隔的值列表来从函数返回多个值。或者，您可以使用“Write-Output”cmdlet 从函数输出多个值。例如。，

Function Get-PersonInfo {
$name = "John"
$age = 30
$city = "New York"
return @{Name = $name; Age = $age; City = $city}
}
$person = Get-PersonInfo