about_Foreach
简短说明
描述可用于遍历项集合中的所有项的语言命令。
长说明
语句 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
语句还可以与返回项集合的 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,以显示以 KB 而不是字节为单位的结果,然后使用定点格式说明符对结果进行格式化,以从结果中删除任何十进制值。 0 使格式说明符不显示小数位数。
在以下示例中,定义的函数将分析 PowerShell 脚本和脚本模块,并返回其中包含的函数的位置。 该示例演示如何使用 MoveNext
方法 (该方法的工作方式类似于For
skip 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 {
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
}
}
}