sobre_Trap

Breve descrição

Descreve uma palavra-chave que lida com um erro de terminação.

Descrição longa

Um erro de encerramento interrompe a execução de uma instrução. Se o PowerShell não manipular um erro de encerramento de alguma forma, o PowerShell também interromperá a execução da função ou do script no pipeline atual. Em outras linguagens, como C#, os erros de terminação são conhecidos como exceções.

A palavra-chave trap especifica uma lista de instruções a serem executadas quando ocorre um erro de encerramento. trap instruções podem lidar com erros de encerramento das seguintes maneiras:

  • Exiba o erro depois de processar o bloco de instrução trap e continuar a execução do script ou função que contém o trap. Este é o comportamento padrão.

    Observação

    Quando o erro de encerramento ocorre em um bloco de script subordinado, como uma instrução if ou loop foreach, as instruções no bloco trap são executadas e a execução continua na próxima instrução fora do bloco de script subordinado.

  • Exiba o erro e anule a execução do script ou função que contém o trap usando break na instrução trap.

  • Silencie o erro, mas continue a execução do script ou função que contém o trap usando continue na instrução trap.

A lista de instruções do trap pode incluir várias condições ou chamadas de função. Um trap pode escrever logs, condições de teste ou até mesmo executar outro programa.

Sintaxe

A instrução trap tem a seguinte sintaxe:

trap [[<error type>]] {<statement list>}

A instrução trap inclui uma lista de instruções a serem executadas quando ocorre um erro de encerramento. Uma instrução trap consiste na palavra-chave trap, opcionalmente seguida por uma expressão de tipo, e no bloco de instrução que contém a lista de instruções a serem executadas quando um erro é intercetado. A expressão de tipo refina os tipos de erros que o trap deteta.

Um script ou comando pode ter várias instruções trap. As instruções trap podem aparecer em qualquer parte do script ou comando.

Intercetando todos os erros de terminação

Quando ocorre um erro de encerramento que não é tratado de outra forma em um script ou comando, o PowerShell verifica se há uma trap instrução que manipula o erro. Se uma instrução trap estiver presente, o PowerShell continuará executando o script ou comando na instrução trap.

O exemplo a seguir é uma afirmação muito simples trap :

trap {"Error found."}

Esta instrução trap interceta qualquer erro de encerramento.

No exemplo a seguir, a função inclui uma cadeia de caracteres nonsense que causa um erro de tempo de execução.

function TrapTest {
    trap {"Error found."}
    nonsenseString
}

TrapTest

A execução desta função retorna o seguinte:

Error found.
nonsenseString:
Line |
   3 |      nonsenseString
     |      ~~~~~~~~~~~~~~
     | 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.

O exemplo a seguir inclui uma instrução trap que exibe o erro usando a variável automática $_:

function TrapTest {
    trap {"Error found: $_"}
    nonsenseString
}

TrapTest

A execução desta versão da função retorna o seguinte:

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 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.

Importante

trap As instruções podem ser definidas em qualquer lugar dentro de um determinado escopo, mas sempre se aplicam a todas as instruções nesse escopo. Durante a execução, as instruções trap num bloco são definidas antes de quaisquer outras instruções serem executadas. Em JavaScript, isso é conhecido como elevação. Isso significa que as instruções se aplicam a todas as instruções nesse bloco, mesmo que trap a execução não tenha avançado além do ponto em que estão definidas. Por exemplo, definir um trap no final de um script e gerar um erro na primeira instrução ainda aciona esse trap.

Intercetação de erros específicos

Um script ou comando pode ter várias instruções trap. Uma trap pode ser definida para lidar com erros específicos.

O exemplo a seguir é uma instrução trap que interceta o erro específico CommandNotFoundException:

trap [System.Management.Automation.CommandNotFoundException]
    {"Command error trapped"}

Quando uma função ou script encontra uma cadeia de caracteres que não corresponde a um comando conhecido, essa trap instrução exibe a cadeia de caracteres "Erro de comando intercetado". Depois de executar a lista de instruções trap, o PowerShell grava o objeto de erro no fluxo de erro e continua o script.

O PowerShell usa tipos de exceção .NET. O exemplo a seguir especifica o tipo de erro System.Exception:

trap [System.Exception] {"An error trapped"}

O tipo de erro CommandNotFoundException herda do System.Exception. Esta instrução interceta um erro que é criado por um comando desconhecido. Também captura outros tipos de erro.

Você pode ter mais de uma instrução trap em um script. Cada tipo de erro pode ser preso por apenas uma trap instrução. Quando ocorre um erro de encerramento, o PowerShell procura a trap correspondência com a correspondência mais específica, começando no escopo atual de execução.

O exemplo de script a seguir contém um erro. O script inclui uma instrução geral trap que interceta qualquer erro que termine o processo e uma instrução específica trap que define o tipo CommandNotFoundException.

trap {"Other terminating error trapped" }
trap [System.Management.Automation.CommandNotFoundException] {
  "Command error trapped"
}
nonsenseString

A execução desse script produz o seguinte resultado:

Command error trapped
nonsenseString:
Line |
   5 |  nonsenseString
     |  ~~~~~~~~~~~~~~
     | 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.

Como o PowerShell não reconhece "nonsenseString" como um cmdlet ou outro item, ele retorna um erro CommandNotFoundException . Este erro de encerramento é capturado pela instrução específica trap .

O exemplo de script a seguir contém as mesmas instruções trap com um erro diferente:

trap {"Other terminating error trapped" }
trap [System.Management.Automation.CommandNotFoundException]
    {"Command error trapped"}
1/$null

A execução desse script produz o seguinte resultado:

Other terminating error trapped
RuntimeException:
Line |
   4 |  1/$null
     |  ~~~~~~~
     | Attempted to divide by zero.

A tentativa de dividir por zero não cria um erro CommandNotFoundException . Em vez disso, esse erro é preso pela outra trap instrução, que interceta qualquer erro de encerramento.

Captura de erros num bloco de script

Por padrão, quando ocorre um erro de encerramento, a execução é transferida para a instrução trap. Depois que o bloco trap é executado, o controle retorna para o próximo bloco de instrução após o local do erro.

Por exemplo, quando ocorre um erro de encerramento em uma instrução foreach, a instrução trap é executada e a execução continua na próxima instrução após o bloco foreach, não dentro do bloco 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: untitled:Untitled-1:3:4
Line |
   3 |     1/$x
     |     ~~~~
     | Attempted to divide by zero.

after loop

Na saída acima, você pode ver os loops continuarem até a última iteração. Quando o script tenta dividir 1 por 0, um erro de encerramento é lançado. O restante do foreach scriptblock é ignorado, a try instrução é executada e o script continua após o foreach scriptblock.

Erros de trapping e escopo

Se ocorrer um erro de encerramento no mesmo escopo da instrução, o trap PowerShell executará a lista de instruções definida pelo trap. A execução continua na instrução após o erro. Se a trap instrução estiver em um escopo diferente do erro, a execução continuará na próxima instrução que está no mesmo escopo da trap instrução.

Por exemplo, se ocorrer um erro em uma função e a instrução trap estiver na função, o script continuará na próxima instrução. O script a seguir contém um erro e uma instrução trap:

function function1 {
    trap { "An error: " }
    NonsenseString
    "function1 was completed"
}

function1

A execução desse script produz o seguinte resultado:

An error:
NonsenseString:
Line |
   3 |      NonsenseString
     |      ~~~~~~~~~~~~~~
     | 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.
function1 was completed

A instrução trap na função interceta o erro. Depois de exibir a mensagem, o PowerShell retoma a execução da função. Note que Function1 foi concluído.

Compare isso com o exemplo a seguir, que tem o mesmo erro e trap instrução. Neste exemplo, a instrução trap ocorre fora da função:

function function2 {
    NonsenseString
    "function2 was completed"
}

trap { "An error: " }

function2

A execução da função Function2 produz o seguinte resultado:

An error:
NonsenseString:
Line |
   2 |      NonsenseString
     |      ~~~~~~~~~~~~~~
     | 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.

Neste exemplo, o comando "function2 was completed" não foi executado. Em ambos os exemplos, o erro de encerramento ocorre dentro da função. Neste exemplo, no entanto, a instrução trap está fora da função. O PowerShell não volta para a função depois que a trap instrução é executada.

Atenção

Quando várias armadilhas são definidas para a mesma condição de erro, a primeira trap definida lexicamente (mais alta no escopo) é usada.

No exemplo a seguir, apenas o trap com "whoops 1" é executado.

Remove-Item -ErrorAction Stop ThisFileDoesNotExist
trap { "whoops 1"; continue }
trap { "whoops 2"; continue }

Importante

Uma instrução Trap tem como escopo onde ela é compilada. Se você tiver uma instrução trap dentro de uma função ou script com origem em pontos, quando a função ou o script com origem em pontos for encerrada, todas as instruções trap dentro serão removidas.

Usando as palavras-chave break e continue

Você pode usar as palavras-chave break e continue em uma instrução trap para determinar se um script ou comando continua a ser executado após um erro de encerramento.

Se você incluir uma instrução break em uma lista de instruções trap, o PowerShell interromperá a função ou o script. A função de exemplo a seguir usa a palavra-chave break em uma instrução trap:

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.

Como a trap instrução incluiu a break palavra-chave, a função não continua a ser executada e a linha "Função concluída" não é executada.

Se incluir uma palavra-chave continue numa instrução trap, o PowerShell será retomado após a instrução que causou o erro, da mesma forma que faria sem break ou continue. Com a palavra-chave continue , no entanto, o PowerShell não grava um erro no fluxo de erros.

A função de exemplo a seguir usa a palavra-chave continue em uma instrução trap:

function continue_example {
    trap {
        "Error trapped"
        continue
    }
    1/$null
    "Function completed."
}

continue_example

Error trapped
Function completed.

A função é retomada depois que o erro é intercetado e a instrução "Função concluída" é executada. Nenhum erro é gravado no fluxo de erro.

Observações

trap As instruções fornecem uma maneira simples de garantir amplamente que todos os erros de encerramento dentro de um escopo sejam tratados. Para um tratamento de erros mais refinado, use blocos try/catch onde as armadilhas são definidas usando instruções catch. As instruções catch só se aplicam ao código dentro da instrução try associada. Para obter mais informações, consulte about_Try_Catch_Finally.

Ver também

  • Last updated on