如何将数组传递给 PowerShell 中的函数

您需要将数组传递给 PowerShell 函数吗？在本 PowerShell 教程中，我将通过示例解释如何将数组传递给 PowerShell 中的函数。

要将数组传递给 PowerShell 中的函数，请定义函数参数以接受数组类型，然后使用该数组作为参数调用该函数。例如， function Get-Data([array]$items) { … } 定义一个接受数组的函数，并且 Get-Data $myArray 将数组传递给该函数。

在 PowerShell 中声明函数

在 PowerShell 中，您可以使用 function 关键字声明函数，后跟函数名称和一对包含代码块的大括号 {}。

function MyFunction {
    # Code goes here
}

现在，让我们看看如何将数组传递给 PowerShell 函数。

将数组传递给 PowerShell 中的函数

在 PowerShell 中将数组传递给函数非常简单。您在函数中定义一个参数，并在调用该函数时将数组传递给它。

方法一：直接传递

以下是如何将数组直接传递给 PowerShell 中的函数的示例：

function Process-Array ($array) {
    foreach ($item in $array) {
        Write-Host "Processing item: $item"
    }
}

# Define an array
$numbers = 1..5

# Pass the array to the function
Process-Array -array $numbers

在此示例中，$numbers 是一个从 1 到 5 的整数数组。Process-Array 函数采用一个参数 $array，并且使用 foreach 循环处理数组中的每个项目。

我已经使用 VS code 执行了上述 PowerShell 脚本，您可以在下面的屏幕截图中看到输出：

方法 2：使用泼溅

Splatting 是一种将参数传递给函数的方法，您可以使用哈希表或数组来保存参数值。以下是如何在 PowerShell 中对数组使用展开：

function Get-Total ($numbers) {
    $sum = 0
    foreach ($number in $numbers) {
        $sum += $number
    }
    return $sum
}

# Define an array
$numbers = 1..5

# Splatting the array to the function
$total = Get-Total -numbers $numbers

Write-Host "The total is: $total"

在此示例中，Get-Total 函数计算数组中数字的总和。在这种情况下，splatting 与直接传递没有什么不同，但当你有很多参数时它很有用。

方法 3：通过引用传递

您还可以通过引用 PowerShell 函数来传递数组，这允许该函数修改原始数组。

以下是如何将数组传递给 PowerShell 中的函数的完整示例。

function Add-Element ([ref]$array, $newElement) {
    $array.Value += $newElement
}

# Define an array
$numbers = @(1, 2, 3)

# Pass the array by reference to the function
Add-Element ([ref]$numbers) 4

Write-Host "Array after adding element: $numbers"

当您运行此脚本时，Add-Element 函数会向原始数组添加一个新元素，您可以看到添加了新元素的更新后的数组。执行脚本后，您可以在下面的屏幕截图中看到输出。

在函数中使用数组的技巧

• 为数组定义函数参数时，可以使用 [array] 或 [type[]] 显式将其声明为数组类型，其中 type 是数组元素的具体数据类型。
• 为函数参数使用有意义的名称，使代码更具可读性。
• 请记住，PowerShell 中的数组是零索引的，这意味着第一个元素位于索引 0 处。

结论

有多种方法可以将数组传递给 PowerShell 中的函数。在本 PowerShell 教程中，我解释了如何使用以下方法将数组传递给 PowerShell 中的函数：

• 直接通过
• 使用泼溅
• 通过引用传递