关于 Foreach

项目
05/09/2024

简短说明

介绍可用于遍历项集合中的所有项的语言命令。

长说明

语句 Foreach (也称为 Foreach 循环) 是一种语言构造，用于单步执行 (循环访问项集合中的一系列值) 。

要遍历的最简单且最典型的集合类型是数组。 Foreach在循环中，通常针对数组中的每个项运行一个或多个命令。

语法

下面显示了 ForEach 语法：

foreach ($<item> in $<collection>){<statement list>}

括在括号中的语句部分 ForEach 表示要循环访问的变量和集合。 PowerShell 在循环运行时自动Foreach创建变量$<item>。在循环每次迭代之前，变量将设置为集合中的值。语句{<statement list>}后面的Foreach块包含一组命令，用于对集合中的每个项执行。

示例

例如， Foreach 以下示例中的循环显示数组中的 $letterArray 值。

$letterArray = "a","b","c","d"
foreach ($letter in $letterArray)
{
  Write-Host $letter
}

在此示例中，$letterArray将创建数组并使用字符串值 "a"、、 "b""c"和 "d"进行初始化。语句首次Foreach运行时，它将变量设置为$letter等于 () "a" 中的$letterArray第一项。然后，它使用 Write-Host cmdlet 显示字母 a。下一次通过循环时， $letter 设置为 "b"，依依。循环 Foreach 显示字母 d 后，PowerShell 退出循环。

整个 Foreach 语句必须出现在一行中，才能在 PowerShell 命令提示符下以命令的形式运行它。如果将命令置于 .ps1 脚本文件中，则整个 Foreach 语句不必显示在单行中。

Foreach 语句还可以与返回项集合的 cmdlet 一起使用。在以下示例中，Foreach 语句逐步遍历 cmdlet 返回 Get-ChildItem 的项列表。

foreach ($file in Get-ChildItem)
{
  Write-Host $file
}

可以使用语句来限制返回的结果，从而优化示例 If 。在以下示例中 Foreach ，语句执行与上一个示例相同的循环操作，但它添加了一个 If 语句，以将结果限制为大于 100 KB (KB) 的文件：

foreach ($file in Get-ChildItem)
{
  if ($file.length -gt 100KB)
  {
    Write-Host $file
  }
}

在此示例中， Foreach 循环使用变量的 $file 属性 () 执行比较操作 $file.length -gt 100KB 。变量 $file 包含 cmdlet 返回 Get-ChildItem 的对象中的所有属性。因此，可以返回多个文件名。在下一个示例中，PowerShell 返回语句列表中的长度和上次访问时间：

foreach ($file in Get-ChildItem)
{
  if ($file.length -gt 100KB)
  {
    Write-Host $file
    Write-Host $file.length
    Write-Host $file.lastaccesstime
  }
}

在此示例中，不限于在语句列表中运行单个命令。

还可以在循环外部使用变量， Foreach 并在循环内递增变量。以下示例对大小超过 100 KB 的文件进行计数：

$i = 0
foreach ($file in Get-ChildItem) {
  if ($file.length -gt 100KB) {
    Write-Host $file "file size:" ($file.length / 1024).ToString("F0") KB
    $i = $i + 1
  }
}

if ($i -ne 0) {
  Write-Host
  Write-Host $i " file(s) over 100 KB in the current directory."
}
else {
  Write-Host "No files greater than 100 KB in the current directory."
}

在前面的示例中，变量 $i 设置为 0 循环外部，对于发现的每个大于 100 KB 的文件，变量在循环内递增。循环退出时， If 语句计算的值 $i 以显示超过 100 KB 的所有文件的计数。或者，它显示一条消息，指出未找到超过 100 KB 的文件。

上一个示例还演示如何设置文件长度结果的格式：

($file.length / 1024).ToString("F0")

该值除以 1,024 以显示以千字节而不是字节为单位的结果，然后使用定点格式说明符对结果进行格式化，以从结果中删除任何十进制值。 0 使格式说明符不显示小数位数。

在以下示例中，定义的函数将分析 PowerShell 脚本和脚本模块，并返回其中包含的函数的位置。此示例演示如何使用 MoveNext 方法 (该方法的工作方式类似于Forskip X循环) ，以及 Current foreach 脚本块内变量的属性$foreach。即使存在跨多行的异常或不一致的函数定义，示例函数也可以在脚本中查找函数。

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

function Get-FunctionPosition {
  [CmdletBinding()]
  [OutputType('FunctionPosition')]
  param(
    [Parameter(Position = 0, Mandatory,
      ValueFromPipeline, ValueFromPipelineByPropertyName)]
    [ValidateNotNullOrEmpty()]
    [Alias('PSPath')]
    [System.String[]]
    $Path
  )

  process {
    try {
      $filesToProcess = if ($_ -is [System.IO.FileSystemInfo]) {
        $_
      } else {
        $filesToProcess = Get-Item -Path $Path
      }
      $parser = [System.Management.Automation.Language.Parser]
      foreach ($item in $filesToProcess) {
        if ($item.PSIsContainer -or
            $item.Extension -notin @('.ps1', '.psm1')) {
          continue
        }
        $tokens = $errors = $null
        $ast = $parser::ParseFile($item.FullName, ([REF]$tokens),
          ([REF]$errors))
        if ($errors) {
          $msg = "File '{0}' has {1} parser errors." -f $item.FullName,
            $errors.Count
          Write-Warning $msg
        }
        :tokenLoop foreach ($token in $tokens) {
          if ($token.Kind -ne 'Function') {
            continue
          }
          $position = $token.Extent.StartLineNumber
          do {
            if (-not $foreach.MoveNext()) {
              break tokenLoop
            }
            $token = $foreach.Current
          } until ($token.Kind -in @('Generic', 'Identifier'))
          $functionPosition = [pscustomobject]@{
            Name       = $token.Text
            LineNumber = $position
            Path       = $item.FullName
          }
          Add-Member -InputObject $functionPosition `
            -TypeName FunctionPosition -PassThru
        }
      }
    }
    catch {
      throw
    }
  }
}

另请参阅

about_Automatic_Variables

about_If

ForEach-Object

通过

关于 Foreach

简短说明

长说明

语法

示例

另请参阅

其他资源