14 函数与模块之函数的参数与返回值

在前一篇中，我们详细讲解了如何定义和调用函数。接下来，我们将深入探讨函数的参数与返回值，这是编写有效 PowerShell 函数的重要组成部分。掌握这些概念后，你将能创建更加灵活和可复用的代码。

函数参数

在 PowerShell 中，函数可以接受参数。参数使得函数更加灵活，可以接收外部输入，从而执行不同的操作。参数在函数定义时通过形式参数列出，并在调用时传入实际参数。

定义参数

在 PowerShell 中定义函数的参数，可以使用param块。这里是一个简单的示例：

function Get-Greeting {
    param (
        [string]$Name
    )
    return "Hello, $Name!"
}

调用函数与传递参数

使用以上函数时，可以传递参数如下：

$greeting = Get-Greeting -Name "Alice"
Write-Output $greeting  # 输出: Hello, Alice!

参数类型与验证

你可以为参数指定类型并进行验证。例如：

function Add-Numbers {
    param (
        [int]$A,
        [int]$B
    )
    return $A + $B
}

$result = Add-Numbers -A 5 -B 10
Write-Output $result  # 输出: 15

如果传递非整型的数据，函数将抛出错误。

可选参数

你还可以定义可选参数，这可以通过给参数指定一个默认值来实现。例如：

function Get-Message {
    param (
        [string]$Message = "No message provided."
    )
    return $Message
}

Write-Output (Get-Message)           # 输出: No message provided.
Write-Output (Get-Message -Message "Hello!")  # 输出: Hello!

位置参数与命名参数

在 PowerShell 中，参数可以使用两种方式传递：

1. 位置参数：根据参数的位置传递，例如直接提供值：

   $result = Add-Numbers 3 7  # 位置参数

2. 命名参数：通过指定参数的名称来传递值，这使代码更加清晰，尤其是在有多个参数时：

   $result = Add-Numbers -A 3 -B 7  # 命名参数

函数返回值

在 PowerShell 函数中，返回值是函数执行后输出的结果。使用return语句可以明确指定要返回的值，但并不总是必须的，因为 PowerShell 默认会返回函数中的最后一个表达式的结果。

返回值示例

继续使用之前的Add-Numbers函数：

function Multiply-Numbers {
    param (
        [int]$X,
        [int]$Y
    )
    return $X * $Y  # 明确返回
}

$product = Multiply-Numbers -X 4 -Y 5
Write-Output $product  # 输出: 20

隐式返回值

如果我们省略return，依然可以得到结果：

function Subtract-Numbers {
    param (
        [int]$X,
        [int]$Y
    )
    $X - $Y  # 最后一个表达式会被返回
}

$difference = Subtract-Numbers -X 10 -Y 3
Write-Output $difference  # 输出: 7

返回多个值

在 PowerShell 中，函数可以返回多个值。返回多个值时，PowerShell 会以数组的形式返回。

function Get-Coordinates {
    param (
        [int]$Latitude,
        [int]$Longitude
    )
    return ,($Latitude, $Longitude)  # 使用逗号创建数组
}

$coordinates = Get-Coordinates -Latitude 40 -Longitude -74
Write-Output $coordinates  # 输出: 40  -74

小结

在本章中，我们讨论了 PowerShell 函数的参数与返回值。学习如何定义参数、传递参数，以及有效利用返回值，将极大地提高你编写 PowerShell 脚本的灵活性和可读性。这些知识将为后续课程中模块的创建与使用打下坚实的基础。

在下一篇中，我们将具体介绍模块的创建与使用，这将使你的代码管理更加高效与系统化。