about_Try_Catch_Finally

项目
10/06/2023

简短说明

介绍如何使用 try、catch 和 finally 块来处理终止错误。

长说明

使用 try、catch 和 finally 块响应或处理脚本中的终止错误。 Trap 语句还可用于处理脚本中的终止错误。有关详细信息，请参阅 about_Trap。

终止错误阻止语句运行。如果 PowerShell 不以某种方式处理终止错误，PowerShell 也会停止使用当前管道运行函数或脚本。在其他语言（如 C#）中，终止错误称为异常。

使用 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 关键字。

语法

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”），则即使运行了 finally 块，也不会在按 CTRL+C 后显示该语句。

捕获错误

以下示例脚本显示了具有 catch 块的 try 块：

try { NonsenseString }
catch { "An error occurred." }

catch 关键字必须紧跟 try 块或其他 catch 块。

PowerShell 不会将“NonsenseString”识别为 cmdlet 或其他项。运行此脚本会产生以下结果：

An error occurred.

当脚本遇到“NonsenseString”时，会导致终止错误。 catch 块通过在块内运行语句列表来处理错误。

使用多个 catch 语句

一个 try 语句可以包含任意数量的 catch 块。例如，以下脚本具有下载 MyDoc.doc 的 try 块，其中包含两个 catch 块：

try {
   $wc = new-object System.Net.WebClient
   $wc.DownloadFile("http://www.contoso.com/MyDoc.doc","c:\temp\MyDoc.doc")
}
catch [System.Net.WebException],[System.IO.IOException] {
    "Unable to download MyDoc.doc from http://www.contoso.com."
}
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.Exception 类型。以下示例还捕获“找不到命令”错误：

catch [System.SystemException] {"Base Exception" }

此 catch 块处理从 SystemException 类型继承的“找不到命令”错误和其他错误。

如果指定错误类及其派生类之一，请将派生类的 catch 块放在常规类的 catch 块之前。

注意

PowerShell 在 RuntimeException 类型中包装所有异常。因此，指定错误类型 System.Management.Automation.RuntimeException 的行为与未限定的 catch 块的行为相同。

在 Try Catch 中使用 Trap

当在 try 块中定义了 Trap 的 try 块中发生终止错误时，即使存在匹配的 catch 块，Trap 语句也会控制。

如果 Trap 位于高于 try 的块，并且当前作用域内没有匹配的 catch 块，则即使任何父作用域具有匹配的 catch 块，Trap 也会控制。

访问异常信息

在 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、Exception 和 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 块是否遇到终止错误，finally 块语句都会运行。 PowerShell 在脚本终止或当前块超出作用域之前运行 finally 块。

即使使用 CTRL+C 来停止脚本，finally 块也会运行。如果 Exit 关键字在 catch 块中停止脚本，则 finally 块也会运行。