简短说明
介绍如何使用try和catchfinally块来处理语句终止和脚本终止错误。
详细说明
使用 try、catch和 finally 块响应或处理脚本中的终止错误。 PowerShell 有两种类型的终止错误:
- 停止当前语句和
- 展开整个调用堆栈的脚本终止错误
这两种都被 try/catch抓住了。 还可以使用 trap 语句来处理终止错误。 有关详细信息,请参阅 about_Trap。 有关所有错误类型的全面概述,请参阅 about_Error_Handling。
语句终止错误会停止当前语句运行,但 PowerShell 在下一个语句中继续,除非该错误也是脚本终止。 脚本终止错误(如关键字生成的 throw 错误)将停止整个脚本,除非被 try/catch 块或 trap 语句捕获。
注意
$ErrorActionPreference 可以抑制 throw。 如果设置为 SilentlyContinue 或设置为, Ignore则错误不会传播和执行在下一个语句中继续。 有关详细信息,请参阅about_Error_Handling的“脚本终止错误”部分。
使用 try 块定义希望 PowerShell 监视错误的脚本部分。 在 try 块中发生错误时,错误首先保存到 $Error 自动变量。 然后,PowerShell 搜索 catch 块来处理错误。 如果 try 语句没有匹配的 catch 块,PowerShell 将继续在父范围中搜索适当的 catch 块或 trap 语句。 完成 catch 块或者找不到适当的 catch 块或 trap 语句后,将运行 finally 块。 如果无法处理错误,错误将写入错误流。
catch 块可以包含用于跟踪错误或恢复脚本预期流的命令。
catch 块可以指定捕获的错误类型。 对于不同类型的错误,try 语句可以包含多个 catch 块。
finally 块可用于释放脚本不再需要的任何资源。
try、catch和 finally 类似于 C# 编程语言中使用的 try、catch和 finally 关键字。
Syntax
try 语句包含一个 try 块、零个或多个 catch 块,以及零个或一个 finally 块。
try 语句必须至少有一个 catch 块或一个 finally 块。
下面显示了 try 块语法:
try {<statement list>}
try 关键字后跟大括号中的语句列表。 如果在运行语句列表中的语句时发生终止错误,脚本会将错误对象从 try 块传递到适当的 catch 块。
下面显示了 catch 块语法:
catch [[<error type>][',' <error type>]*] {<statement list>}
错误类型显示在括号中。 最外部的方括号表示元素是可选的。
catch 关键字后跟错误类型规范和语句列表的可选列表。 如果在 try 块中出现终止错误,PowerShell 将搜索相应的 catch 块。 如果找到一个语句,则执行 catch 块中的语句。
catch 块可以指定一个或多个错误类型。 错误类型是Microsoft .NET Framework 异常或派生自 .NET Framework 异常的异常。
catch 块处理指定 .NET Framework 异常类或任何派生自指定类的类的错误。
如果 catch 块指定错误类型,catch 块处理该类型的错误。 如果 catch 块未指定错误类型,catch 块将处理 try 块中遇到的任何错误。
try 语句可以包含不同指定错误类型的多个 catch 块。
下面显示了 finally 块语法:
finally {<statement list>}
finally 关键字后跟每次运行脚本时运行的语句列表,即使运行 try 语句时没有出错或 catch 语句中捕获错误。
请注意,按 CTRL+C 会停止管道。 发送到管道的对象不会显示为输出。 因此,如果包含要显示的语句(例如“Finally block has run”),则即使运行了 块,也不会在按 ctrl +finally后显示该语句。
捕获错误
以下示例脚本显示了具有 try 块的 catch 块:
try { NonsenseString }
catch { "An error occurred." }
catch 关键字必须紧跟 try 块或其他 catch 块。
PowerShell 无法将“NonsenseString”识别为 cmdlet 或其他项。 运行此脚本将返回以下结果:
An error occurred.
当脚本遇到“NonsenseString”时,会导致终止错误。
catch 块通过在块内运行语句列表来处理错误。
使用多个 CATCH 语句
try 语句可以具有任意数量的 catch 块。 例如,以下脚本具有下载 try的 MyDoc.doc 块,并且包含两个 catch 块:
try {
$wc = New-Object System.Net.WebClient
$wc.DownloadFile("https://httpbin.org/MyDoc.doc","C:\temp\MyDoc.doc")
} catch [System.Net.WebException],[System.IO.IOException] {
"Unable to download MyDoc.doc from https://httpbin.org."
} catch {
"An error occurred that could not be resolved."
}
第一个 catch 块处理 System.Net.WebException 和 System.IO.IOException 类型的错误。 第二个 catch 块未指定错误类型。 第二个 catch 块处理发生的任何其他终止错误。
PowerShell 通过继承匹配错误类型。
catch 块处理指定 .NET Framework 异常类或任何派生自指定类的类的错误。 以下示例包含捕获“找不到命令”错误的 catch 块:
catch [System.Management.Automation.CommandNotFoundException] {
"Inherited Exception"
}
指定的错误类型 CommandNotFoundException继承自 system.SystemException 类型。 以下示例还捕获“找不到命令”错误:
catch [System.SystemException] {"Base Exception" }
此 catch 块处理从 systemException 类型继承 的“找不到命令”错误和其他错误。
如果指定错误类及其派生类之一,请将派生类的 catch 块放在常规类的 catch 块之前。
注意
PowerShell 包装 RuntimeException 类型中的所有异常。 因此,System.Management.Automation.RuntimeException 指定错误类型的行为与未限定的 catch 块的行为相同。
在 try catch 中使用陷阱
当 try 块中出现终止错误时,trap 块中定义的 try,即使存在匹配的 catch 块,trap 语句也会控制。
如果 trap 位于高于 try的块,并且当前范围内没有匹配的 catch 块,则即使任何父范围都有匹配的 trap 块,catch 也会控制。
访问异常信息
catch在块中,可以使用或$_自动变量访问$PSItem当前错误。 对象的类型 ErrorRecord。
try { NonsenseString }
catch {
Write-Host "An error occurred:"
Write-Host $_
}
运行此脚本将返回以下结果:
An Error occurred:
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.
可以访问其他属性,例如 ScriptStackTrace、异常和 ErrorDetails。 例如,如果将脚本更改为以下内容:
try { NonsenseString }
catch {
Write-Host "An error occurred:"
Write-Host $_.ScriptStackTrace
}
结果将类似于:
An Error occurred:
at <ScriptBlock>, <No file>: line 2
使用最后释放资源
若要释放脚本使用的资源,请在 finally 和 try 块之后添加 catch 块。 无论 finally 块是否遇到终止错误,try 块语句都会运行。 PowerShell 在脚本终止或当前块超出范围之前运行 finally 块。
即使使用 finally+ 来停止脚本, 块也会运行。 如果 finally 关键字在 exit 块中停止脚本,则 catch 块也会运行。
在以下示例中,try 块尝试将文件下载到 C:\temp 文件夹中。
catch 阻止处理下载期间发生的错误。
finally 块释放 WebClient 对象,并删除临时文件(如果存在)。
try {
$wc = New-Object System.Net.WebClient
$tempFile = "C:\temp\MyDoc.doc"
$wc.DownloadFile("https://httpbin.org/MyDoc.doc",$tempFile)
} catch [System.Net.WebException],[System.IO.IOException] {
"Unable to download MyDoc.doc from https://httpbin.org."
} catch {
"An error occurred that could not be resolved."
} finally {
$wc.Dispose()
if (Test-Path $tempFile) { Remove-Item $tempFile }
}