about_Trap
简短说明
描述处理终止错误的关键字 (keyword) 。
长说明
终止错误使语句停止运行。 如果 PowerShell 未以某种方式处理终止错误,PowerShell 也会停止在当前管道中运行函数或脚本。 在其他语言(如 C#)中,终止错误称为异常。
trap
关键字 (keyword) 指定要在发生终止错误时运行的语句列表。 trap
语句可以通过以下方式处理终止错误:
在处理
trap
语句块并继续执行包含trap
的脚本或函数后显示错误。 此选项为默认行为。注意
当从属脚本块(如
if
语句或foreach
循环)中发生终止错误时,块中的trap
语句将运行,并在从属脚本块外的下一个语句处继续执行。在 语句中
trap
显示包含trap
的break
脚本或函数的错误和中止执行。将错误静音,但通过在
continue
语句中使用trap
继续执行包含trap
的脚本或函数。
的 trap
语句列表可以包含多个条件或函数调用。 可以 trap
写入日志、测试条件,甚至运行另一个程序。
语法
trap
语句具有以下语法:
trap [[<error type>]] {<statement list>}
语句 trap
包括发生终止错误时要运行的语句列表。 语句trap
由关键字 (keyword) (可选)后跟类型表达式和语句块组成trap
,其中包含在捕获错误时要运行的语句列表。 类型表达式优化捕获的错误 trap
类型。
一个脚本或命令可以有多个 trap
语句。 trap
语句可以出现在脚本或命令中的任何位置。
捕获所有终止错误
在脚本或命令中发生未以其他方式处理的终止错误时,PowerShell 会检查 trap
处理错误的语句。 如果存在 trap
语句,PowerShell 将继续在 语句中 trap
运行脚本或命令。
以下示例是一个 minimal trap
语句:
trap { 'Error found.' }
此 trap
语句捕获任何终止错误。
在以下示例中, 函数包含导致运行时错误的无意义的字符串。
function TrapTest {
trap { 'Error found.' }
nonsenseString
}
TrapTest
运行此函数将返回以下输出:
Error found.
nonsenseString:
Line |
3 | nonsenseString
| ~~~~~~~~~~~~~~
| The term 'nonsenseString' is not recognized as a name of a cmdlet,
function, script file, or executable program.
Check the spelling of the name, or if a path was included, verify that the
path is correct and try again.
以下示例包含一个 trap
语句,该语句使用 $_
自动变量显示错误:
function TrapTest {
trap { "Error found: $_" }
nonsenseString
}
TrapTest
运行此版本的函数将返回以下输出:
Error found: The term 'nonsenseString' is not recognized as the name of a
cmdlet, function, script file, or operable program. Check the spelling of
the name, or if a path was included, verify that the path is correct and
try again.
nonsenseString:
Line |
3 | nonsenseString
| ~~~~~~~~~~~~~~
| The term 'nonsenseString' is not recognized as a name of a cmdlet,
function, script file, or executable program.
Check the spelling of the name, or if a path was included, verify that the
path is correct and try again.
重要
trap
语句可以在给定脚本块内的任意位置定义,但始终应用于该脚本块中的所有语句。 在运行时, trap
块中的语句在执行任何其他语句之前定义。
在 JavaScript 中,这称为 提升。 这意味着语句 trap
应用于该块中的所有语句,即使执行尚未超过定义这些语句的点。 例如,在 trap
脚本末尾定义 并在第一个语句中引发错误仍会触发该 trap
。
捕获特定错误
一个脚本或命令可以有多个 trap
语句。 trap
可以定义 以处理特定错误。
以下示例是捕获 trap
特定错误 CommandNotFoundException 的语句:
trap [System.Management.Automation.CommandNotFoundException] {
'Command error trapped'
}
当函数或脚本遇到与已知命令不匹配的字符串时,此 trap
语句将显示该 Command error trapped
字符串。
运行 trap
语句列表后,PowerShell 将错误对象写入错误流,然后继续执行脚本。
PowerShell 使用 .NET 异常类型。 以下示例指定 System.Exception 错误类型:
trap [System.Exception] { 'An error trapped' }
CommandNotFoundException 错误类型继承自 System.Exception 类型。 此语句捕获未知命令引发的任何错误。 它还捕获其他错误类型。
可以通过检查错误对象来查找错误的异常类型。 以下示例演示如何获取会话中最后一个错误的异常的全名:
nonsenseString
$Error[0].Exception.GetType().FullName
nonsenseString: The term 'nonsenseString' is not recognized as a name of a
cmdlet, function, script file, or executable program. Check the spelling
of the name, or if a path was included, verify that the path is correct
and try again.
System.Management.Automation.CommandNotFoundException
一个脚本中可以有多个 trap
语句。 每个错误类型只能捕获一个 trap
语句。 发生终止错误时,PowerShell 从当前执行脚本块开始搜索 trap
具有最具体匹配项的 。
以下脚本示例包含错误。 该脚本包含捕获任何终止错误的常规trap
语句和指定 CommandNotFoundException 类型的特定trap
语句。
trap { 'Other terminating error trapped' }
trap [System.Management.Automation.CommandNotFoundException] {
'Command error trapped'
}
nonsenseString
运行此脚本会生成以下结果:
Command error trapped
nonsenseString:
Line |
5 | nonsenseString
| ~~~~~~~~~~~~~~
| The term 'nonsenseString' is not recognized as a name of a cmdlet,
function, script file, or executable program.
Check the spelling of the name, or if a path was included, verify that the
path is correct and try again.
由于 PowerShell 无法识别 nonsenseString
为 cmdlet 或其他项,因此它将返回 CommandNotFoundException 错误。 特定 trap
语句捕获此终止错误。
以下脚本示例包含具有不同错误的相同 trap
语句:
trap { 'Other terminating error trapped' }
trap [System.Management.Automation.CommandNotFoundException] {
'Command error trapped'
}
1/$null
运行此脚本会生成以下结果:
Other terminating error trapped
RuntimeException:
Line |
5 | 1/$null
| ~~~~~~~
| Attempted to divide by zero.
尝试除以零不会创建 CommandNotFoundException 错误。 另一 trap
个语句捕获任何终止错误,将除以零误差。
捕获脚本块中的错误
默认情况下,当引发终止错误时,执行将传输到 trap 语句。 运行 trap
块后,控件将返回到错误位置之后的下一个语句块。
例如,当语句中 foreach
发生终止错误时, trap
语句将运行,并在块后的 foreach
下一个语句(而不是块中 foreach
)继续执行。
trap { 'An error occurred!'}
foreach ($x in 3..0) {
1/$x
'after division'
}
'after loop'
0.333333333333333
after division
0.5
after division
1
after division
An error occurred!
RuntimeException:
Line |
3 | 1/$x
| ~~~~
| Attempted to divide by zero.
after loop
在输出中,可以看到循环一直持续到最后一次迭代。 当脚本尝试将 1 除以 0 时,PowerShell 会引发终止错误。 该脚本跳过脚本块的 foreach
其余部分,运行 try
语句,并在脚本块之后 foreach
继续。
捕获错误和范围
如果在与 语句相同的脚本块 trap
中发生终止错误,PowerShell 将运行 由 trap
定义的语句列表。 错误后,在 语句处继续执行。 trap
如果该语句位于与错误不同的脚本块中,则执行在与该语句位于同一脚本块trap
中的下一个语句处继续执行。
例如,如果函数中发生错误,并且 trap
语句位于 函数中,则脚本会在下一个语句中继续。 以下脚本包含错误和 trap
语句:
function function1 {
trap { 'An error: ' }
NonsenseString
'function1 was completed'
}
function1
运行此脚本会生成以下结果:
An error:
NonsenseString:
Line |
3 | NonsenseString
| ~~~~~~~~~~~~~~
| The term 'NonsenseString' is not recognized as a name of a cmdlet,
function, script file, or executable program.
Check the spelling of the name, or if a path was included, verify that the
path is correct and try again.
function1 was completed
trap
函数中的 语句捕获错误。 显示消息后,PowerShell 将继续运行函数。 请注意,在 Function1
语句之后 trap
完成。
将此行为与以下示例进行比较,该示例具有相同的错误和 trap
语句。 在此示例中, trap
语句出现在 函数外部:
function function2 {
NonsenseString
'function2 was completed'
}
trap { 'An error:' }
function2
运行函数 Function2
会生成以下结果:
An error:
NonsenseString:
Line |
2 | NonsenseString
| ~~~~~~~~~~~~~~
| The term 'NonsenseString' is not recognized as a name of a cmdlet,
function, script file, or executable program.
Check the spelling of the name, or if a path was included, verify that the
path is correct and try again.
在此示例中, function2 was completed
命令未运行。 在这两个示例中,终止错误都发生在 函数中。 但是,在此示例中, trap
语句位于 函数外部。 运行 语句后 trap
,PowerShell 不会返回到 函数中。
注意
为相同的错误条件定义多个陷阱时,将使用脚本块) (词法上定义的第一 trap
个陷阱。
在以下示例中,仅 trap
运行具有 whoops 1
的 。
Remove-Item -ErrorAction Stop ThisFileDoesNotExist
trap { 'whoops 1'; continue }
trap { 'whoops 2'; continue }
重要
语句 trap
的作用域限定为它的编译位置。 如果函数或点源脚本中有语句 trap
,则当函数或点源脚本退出时,将删除内部的所有 trap
语句。
使用 break 和 continue 关键字
可以在语句中使用 break
trap
和 continue
关键字来确定脚本或命令在终止错误后是否继续运行。
如果在语句列表中包括 break
语句 trap
,PowerShell 将停止函数或脚本。 以下示例函数在 break
语句中使用 trap
关键字 (keyword) :
function break_example {
trap {
'Error trapped'
break
}
1/$null
'Function completed.'
}
break_example
Error trapped
ParentContainsErrorRecordException:
Line |
6 | 1/$null
| ~~~~~~~
| Attempted to divide by zero.
trap
由于 语句包含 break
关键字 (keyword) ,因此函数不会继续运行,并且Function completed
行不会运行。
如果在continue
语句中包含trap
关键字 (keyword) ,PowerShell 会在导致错误的语句之后恢复,就像没有 break
或 continue
一样。 但是,continue
使用关键字 (keyword) ,PowerShell 不会将错误写入错误流。
以下示例函数在 continue
语句中使用 trap
关键字 (keyword) :
function continue_example {
trap {
'Error trapped'
continue
}
1/$null
'Function completed.'
}
continue_example
Error trapped
Function completed.
函数在捕获错误后恢复,语句 Function completed
运行。 不会将错误写入错误流。
备注
trap
语句提供了一种确保脚本块中的所有终止错误得到处理的方法。 若要更精细地处理错误,请使用 try
/catch
使用 catch
语句定义陷阱的块。 语句 catch
仅适用于关联 try
语句中的代码。 有关详细信息,请参阅 about_Try_Catch_Finally。