简短说明
描述可用于遍历项集合中的所有项的语言命令。
详细说明
foreach 语句是一种语言构造,用于循环访问集合中的一组值。
要遍历的最简单且最典型的集合类型是数组。
在 foreach 循环中,通常针对数组中的每个项运行一个或多个命令。
Syntax
下面显示了 foreach 语法:
foreach ($<item> in $<collection>){<statement list>}
括号内 foreach 语句的一部分表示要循环访问的变量和集合。 PowerShell 在运行 $<item> 循环时自动创建变量 foreach。 每次迭代开始时,foreach 将项变量设置为集合中的下一个值。
{<statement list>} 块包含要为每个迭代执行的命令。
例子
例如,以下示例中的 foreach 循环显示 $letterArray 数组中的值。
$letterArray = 'a','b','c','d'
foreach ($letter in $letterArray)
{
Write-Host $letter
}
在此示例中,$letterArray 包含字符串值 a、b、c和 d。 第一次运行 foreach 语句时,它将 $letter 变量设置为等于 $letterArray(a)中的第一项。 然后,它使用 Write-Host 来显示值。 下次通过循环时,$letter 设置为 b。 该模式对数组中的每个项重复。
还可以将 foreach 语句与返回项集合的 cmdlet 配合使用。 在以下示例中,foreach 语句逐步讲解 Get-ChildItem cmdlet 返回的项列表。
foreach ($file in Get-ChildItem)
{
Write-Host $file
}
可以使用 if 语句优化示例,以限制返回的结果。 在以下示例中,if 语句将结果限制为大于 100 KB 的文件(KB):
foreach ($file in Get-ChildItem)
{
if ($file.Length -gt 100KB)
{
Write-Host $file
}
}
在此示例中,foreach 循环使用 $file 变量的属性来执行比较运算($file.Length -gt 100KB)。
$file 变量具有 Get-ChildItem返回的对象的所有属性。
在下一个示例中,脚本显示语句列表中的长度和上次访问时间:
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 100KB in the current directory.'
}
else {
Write-Host 'No files greater than 100KB in the current directory.'
}
在前面的示例中,$i 以循环外部 0 的值开头。
然后,每个大于 100KB 的文件在循环内递增 $i。 循环退出时,if 语句将计算 $i 的值以显示超过 100KB 的文件计数。
前面的示例还演示了如何设置文件长度结果的格式:
($file.Length / 1024).ToString('F0')
该值除以 1,024 以千字节而不是字节为单位显示结果,然后使用固定点格式说明符格式化结果,以删除结果中的任何小数值。
0 使格式说明符不显示小数位数。
以下函数分析 PowerShell 脚本和脚本模块,并返回所包含的函数的位置。 该示例演示如何在 MoveNext 脚本块中使用 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
}
$addMemberSplat = @{
InputObject = $functionPosition
TypeName = 'FunctionPosition'
PassThru = $true
}
Add-Member @addMemberSplat
}
}
}
catch {
throw
}
}
}