ForEach-Object

该 ForEach-Object cmdlet 对输入对象集合中的每个项执行作。 可以通过管道将输入对象传递给 cmdlet 或使用 InputObject 参数指定。

从 Windows PowerShell 3.0 开始，可通过两种不同的方法来构造 ForEach-Object 命令。

• 脚本块语法。 可以使用脚本块来指定作。 在脚本块中，使用 $_ 变量来表示当前对象。 脚本块是 Process 参数的值。 脚本块可以包含任何 PowerShell 脚本。

  例如，以下命令获取计算机上的每个进程的 ProcessName 属性的值。

  Get-Process | ForEach-Object {$_.ProcessName}

  ForEach-Object支持about_Functions中所述的begin块process和end块。

  注释

  脚本块在调用方的范围内运行。 因此，这些块有权访问该作用域中的变量，并且可以创建在 cmdlet 完成后保留在该范围的新变量。

• 简化的语法。 使用简化的语法，可以在管道中指定对象的属性或方法名称。 ForEach-Object 返回管道中每个对象的属性或方法的值。

  例如，以下命令还获取计算机上的每个进程的 ProcessName 属性的值。

  Get-Process | ForEach-Object ProcessName

  Windows PowerShell 3.0 中引入了简化的语法。 有关详细信息，请参阅 about_Simplified_Syntax。

• 并行运行的脚本块。 从 PowerShell 7.0 开始，可以使用第三个参数集并行运行每个脚本块。 ThrottleLimit 参数限制一次运行的并行脚本数。 与之前一样，使用 $_ 变量来表示脚本块中的当前输入对象。 使用 Using: 范围修饰符将变量引用传递给正在运行的脚本。

  在 PowerShell 7 中，为每个循环迭代创建新的运行空间，以确保最大隔离。 与创建新运行空间相比，如果所做的工作很小，或者执行大量迭代执行大量工作，则这可以是较大的性能和资源命中率。 从 PowerShell 7.1 起，默认情况下会重复使用运行空间池中的运行空间。 ThrottleLimit 参数设置运行空间池大小。 默认的运行空间池大小为 5。 仍然可以使用 UseNewRunspace 开关为每个迭代创建新的运行空间。

  默认情况下，并行脚本块使用启动并行任务的调用方当前工作目录。

  有关详细信息，请参阅本文的 NOTES 部分。

此示例采用三个整数的数组，并将其中每个整数除以 1024。

30000, 56798, 12432 | ForEach-Object -Process {$_/1024}

29.296875
55.466796875
12.140625

此示例处理 PowerShell 安装目录中的文件和目录 $PSHOME。

Get-ChildItem $PSHOME | ForEach-Object -Process {
    if (!$_.PSIsContainer) {$_.Name; $_.Length / 1024; " " }
}

如果对象不是目录，则脚本块获取文件的名称，将其 Length 属性的值除以 1024，并添加一个空格（“”）以将其与下一项分开。 该 cmdlet 使用 PSIsContainer 属性来确定对象是否为目录。

此示例将 1000 个最新事件从系统事件日志写入文本文件。 当前时间显示在处理事件之前和之后。

Get-EventLog -LogName System -Newest 1000 |
    ForEach-Object -Begin {Get-Date} -Process {
        Out-File -FilePath Events.txt -Append -InputObject $_.Message
    } -End {Get-Date}

Get-EventLog 从系统事件日志中获取 1000 个最新事件，并将其 ForEach-Object 传递给 cmdlet。 Begin 参数显示当前日期和时间。 接下来， Process 参数使用 Out-File cmdlet 创建一个名为 events.txt 的文本文件，并将每个事件的消息属性存储在该文件中。 最后， End 参数用于显示完成所有处理后的日期和时间。

本示例将键下HKCU:\Network的所有子项中的 RemotePath 注册表项的值更改为大写文本。

Get-ItemProperty -Path HKCU:\Network\* |
  ForEach-Object {
    Set-ItemProperty -Path $_.PSPath -Name RemotePath -Value $_.RemotePath.ToUpper()
  }

可以使用此格式更改注册表项值的窗体或内容。

网络密钥中的每个子项表示在登录时重新连接的映射网络驱动器。 RemotePath 条目包含连接的驱动器的 UNC 路径。 例如，如果将驱动器映射到其中，则会在将 RemotePath 注册表值设置为 的情况下创建 E 子项。

该命令使用 Get-ItemProperty cmdlet 获取 网络 密钥的所有子项和 Set-ItemProperty cmdlet 来更改每个键中 RemotePath 注册表项的值。 在命令中 Set-ItemProperty ，路径是注册表项的 PSPath 属性的值。 这是表示注册表项而不是注册表项的 Microsoft .NET Framework 对象的属性。 该命令使用 RemotePath 值的 ToUpper（）方法，这是字符串REG_SZ。

由于 Set-ItemProperty 正在更改每个键的属性， ForEach-Object 因此需要 cmdlet 才能访问该属性。

此示例显示将自动变量管道到 $nullForEach-Object cmdlet 的效果。

1, 2, $null, 4 | ForEach-Object {"Hello"}

Hello
Hello
Hello
Hello

由于 PowerShell 被视为 $null 显式占位符，因此 ForEach-Object cmdlet 会生成 $null 一个值，就像对传递给它的其他对象一样。

此示例使用 cmdlet 的 MemberName 参数获取所有已安装 PowerShell 模块的 ForEach-ObjectPath 属性的值。

Get-Module -ListAvailable | ForEach-Object -MemberName Path
Get-Module -ListAvailable | foreach Path

第二个命令等效于第一个命令。 它使用 Foreach cmdlet 的 ForEach-Object 别名，并省略 MemberName 参数的名称，这是可选的。

该 ForEach-Object cmdlet 可用于获取属性值，因为它获取的值而不更改类型，这与 格式 cmdlet 或 Select-Object cmdlet 不同，后者更改属性值类型。

此示例演示了将两个点分隔的模块名称拆分为其组件名称的三种方法。 这些命令调用字符串的 Split 方法。 这三个命令使用不同的语法，但它们等效且可互换。 这三种情况的输出相同。

"Microsoft.PowerShell.Core", "Microsoft.PowerShell.Host" |
    ForEach-Object {$_.Split(".")}
"Microsoft.PowerShell.Core", "Microsoft.PowerShell.Host" |
    ForEach-Object -MemberName Split -ArgumentList "."
"Microsoft.PowerShell.Core", "Microsoft.PowerShell.Host" |
    foreach Split "."

Microsoft
PowerShell
Core
Microsoft
PowerShell
Host

第一个命令使用传统语法，其中包括脚本块和当前对象运算符 $_。 它使用点语法来指定方法和括号以将分隔符参数括起来。

第二个命令使用 MemberName 参数指定 Split 方法和 ArgumentList 参数，以将点 （.） 标识为拆分分隔符。

第三个命令使用 foreach cmdlet 的 ForEach-Object 别名，并省略 MemberName 和 ArgumentList 参数的名称（可选）。

在此示例中，我们以位置传递两个脚本块。 所有脚本块都绑定到 Process 参数。 但是，它们被视为已传递到 Begin 和 Process 参数。

1..2 | ForEach-Object { 'begin' } { 'process' }

begin
process
process

在此示例中，我们将定位传递四个脚本块。 所有脚本块都绑定到 Process 参数。 但是，它们被视为已传递到 Begin、 Process 和 End 参数。

1..2 | ForEach-Object { 'begin' } { 'process A' }  { 'process B' } { 'end' }

begin
process A
process B
process A
process B
end

如前面的示例所示，使用 Process 参数传递的多个脚本块将映射到 Begin 和 End 参数。 若要避免此映射，必须为 Begin 和 End 参数提供显式值。

1..2 | ForEach-Object -Begin $null -Process { 'one' }, { 'two' }, { 'three' } -End $null

one
two
three
one
two
three

此示例运行一个脚本块，该脚本块计算字符串并休眠一秒。

$Message = "Output:"

1..8 | ForEach-Object -Parallel {
    "$Using:Message $_"
    Start-Sleep 1
} -ThrottleLimit 4

Output: 1
Output: 2
Output: 3
Output: 4
Output: 5
Output: 6
Output: 7
Output: 8

ThrottleLimit 参数值设置为 4，以便以四批方式处理输入。 范围 Using: 修饰符用于将 $Message 变量传递到每个并行脚本块。

此示例从本地 Windows 计算机上的 5 个系统日志中检索 50,000 个日志条目。

$logNames = 'Security', 'Application', 'System', 'Windows PowerShell',
    'Microsoft-Windows-Store/Operational'

$logEntries = $logNames | ForEach-Object -Parallel {
    Get-WinEvent -LogName $_ -MaxEvents 10000
} -ThrottleLimit 5

$logEntries.Count

50000

Parallel 参数指定为每个输入日志名称并行运行的脚本块。 ThrottleLimit 参数可确保所有五个脚本块同时运行。

此示例创建一个作业，该作业一次以两个并行方式运行脚本块。

PS> $job = 1..10 | ForEach-Object -Parallel {
    "Output: $_"
    Start-Sleep 1
} -ThrottleLimit 2 -AsJob

PS> $job

Id     Name            PSJobTypeName   State         HasMoreData     Location      Command
--     ----            -------------   -----         -----------     --------      -------
23     Job23           PSTaskJob       Running       True            PowerShell    …

PS> $job.ChildJobs

Id     Name            PSJobTypeName   State         HasMoreData     Location      Command
--     ----            -------------   -----         -----------     --------      -------
24     Job24           PSTaskChildJob  Completed     True            PowerShell    …
25     Job25           PSTaskChildJob  Completed     True            PowerShell    …
26     Job26           PSTaskChildJob  Running       True            PowerShell    …
27     Job27           PSTaskChildJob  Running       True            PowerShell    …
28     Job28           PSTaskChildJob  NotStarted    False           PowerShell    …
29     Job29           PSTaskChildJob  NotStarted    False           PowerShell    …
30     Job30           PSTaskChildJob  NotStarted    False           PowerShell    …
31     Job31           PSTaskChildJob  NotStarted    False           PowerShell    …
32     Job32           PSTaskChildJob  NotStarted    False           PowerShell    …
33     Job33           PSTaskChildJob  NotStarted    False           PowerShell    …

ThrottleLimit 参数限制一次运行的并行脚本块数。 AsJob 参数会导致 ForEach-Object cmdlet 返回作业对象，而不是将输出流式传输到控制台。 该 $job 变量接收收集输出数据和监视运行状态的作业对象。 该 $job.ChildJobs 属性包含运行并行脚本块的子作业。

此示例并行调用脚本块以收集唯一命名的 Process 对象。

$threadSafeDictionary = [System.Collections.Concurrent.ConcurrentDictionary[string,object]]::new()
Get-Process | ForEach-Object -Parallel {
    $dict = $Using:threadSafeDictionary
    $dict.TryAdd($_.ProcessName, $_)
}

$threadSafeDictionary["pwsh"]

NPM(K)    PM(M)      WS(M)     CPU(s)      Id  SI ProcessName
 ------    -----      -----     ------      --  -- -----------
     82    82.87     130.85      15.55    2808   2 pwsh

ConcurrentDictionary 对象的单个实例将传递给每个脚本块以收集对象。 由于 ConcurrentDictionary 是线程安全的，因此可以安全地由每个并行脚本修改。 非线程安全对象（如 System.Collections.Generic.Dictionary）在这里使用是不安全的。

此示例并行写入错误流，其中写入错误的顺序是随机的。

1..3 | ForEach-Object -Parallel {
    Write-Error "Error: $_"
}

Write-Error: Error: 1
Write-Error: Error: 3
Write-Error: Error: 2

此示例演示了一个并行运行的 scriptblock 中的终止错误。

1..5 | ForEach-Object -Parallel {
    if ($_ -eq 3)
    {
        throw "Terminating Error: $_"
    }

    Write-Output "Output: $_"
}

Exception: Terminating Error: 3
Output: 1
Output: 4
Output: 2
Output: 5

Output: 3 从不写入，因为该迭代的并行脚本块已终止。

可以在作用域脚本块之外ForEach-Object -Parallel创建一个变量，并将其与范围修饰符一起使用。Using: 从 PowerShell 7.2 开始，可以在作用域内脚本块中创建 ForEach-Object -Parallel 一个变量，并在嵌套的脚本块内使用它。

$test1 = 'TestA'
1..2 | ForEach-Object -Parallel {
    $Using:test1
    $test2 = 'TestB'
    1..2 | ForEach-Object -Parallel {
        $Using:test2
    }
}

TestA
TestA
TestB
TestB
TestB
TestB

ThrottleLimit 参数限制在每个实例 ForEach-Object -Parallel期间运行的并行脚本数。 它不会限制使用 AsJob 参数时可以创建的作业数。 由于作业本身同时运行，因此可以创建多个并行作业，每个作业都运行到并发脚本块的限制数。

$jobs = for ($i=0; $i -lt 10; $i++) {
    1..10 | ForEach-Object -Parallel {
        ./RunMyScript.ps1
    } -AsJob -ThrottleLimit 5
}

$jobs | Receive-Job -Wait

此示例创建 10 个正在运行的作业。 每个作业并发运行不超过 5 个脚本。 并发运行的实例总数限制为 50（10 个作业次数为 ThrottleLimit 为 5 次）。

PSObject

你可以通过管道将任何对象传递给此 cmdlet。

PSObject

此 cmdlet 返回由输入确定的对象。

PowerShell 包含以下与 ForEach-Object相关的别名：

• 所有平台：
  • %
  • foreach

该 ForEach-Object cmdlet 的工作方式与语句非常类似 foreach ，只是无法通过管道将输入传递给 foreach 语句。 有关该语句的详细信息 foreach ，请参阅 about_Foreach。

从 PowerShell 4.0 开始， Where 添加了 ForEach 用于集合的方法。 可以在此处阅读有关这些新方法的详细信息 ，about_Arrays

使用 ForEach-Object -Parallel：

• ForEach-Object -Parallel 在新运行空间中运行每个脚本块。 新的运行空间比使用顺序处理运行的 ForEach-Object 开销要高得多。 与脚本块执行的工作相比，使用 并行 运行的开销很小，这一点很重要。 例如：

  • 在多核计算机上计算密集型脚本
  • 等待结果或执行文件作的脚本

  使用 Parallel 参数可能会导致脚本运行速度比正常慢得多。 尤其是当并行脚本是微不足道的时。 试验 并行 ，发现它在哪里可能有益。

• 并行运行时，如果用 ScriptProperties 或 ScriptMethods 修饰的对象在最初附加到脚本的不同运行空间中运行，则无法保证它们正常运行。

  Scriptblock 调用始终尝试在其 主 运行空间中运行，而不考虑实际调用的位置。 但是， ForEach-Object -Parallel 创建在使用后删除的临时运行空间，因此脚本不再有运行空间。

  只要 主 运行空间仍然存在，此行为就可以工作。 但是，如果脚本依赖于仅存在于调用方运行空间而不是 主 运行空间中的外部变量，则可能无法获得所需的结果。

• 非终止错误将写入 cmdlet 错误流，因为它们在并行运行的脚本块中出现。 由于并行 scriptblock 执行顺序是不确定的，因此错误流中出现错误的顺序是随机的。 同样，写入到其他数据流的消息（如警告、详细或信息）按不确定顺序写入这些数据流。

  终止错误（如异常）会终止其发生的脚本块的各个并行实例。 一个脚本块中的终止错误可能会导致 cmdlet 终止 ForEach-Object 。 其他脚本块（并行运行）将继续运行，除非它们也遇到终止错误。 终止错误以 ErrorRecord 形式写入错误数据流，其值为 FullyQualifiedErrorIdPSTaskException。 可以使用 PowerShell try/catch 或 trap 块将终止错误转换为非终止错误。

• 即使使用范围修饰符，也不支持并行方案中的 Using:PipelineVariable 通用参数变量。

  重要

  参数 ForEach-Object -Parallel 集在单独的进程线程上并行运行脚本块。 修饰 Using: 符允许将变量引用从 cmdlet 调用线程传递到每个正在运行的脚本块线程。 由于脚本块在不同的线程中运行，因此必须安全地使用引用传递的对象变量。 通常，从不更改的引用对象进行读取是安全的。 如果需要修改对象状态，则必须使用线程安全对象，例如 .NET System.Collection.Concurrent 类型（请参阅示例 14）。