Обработка прерывающих ошибок в PowerShell.

Здравствуйте.

Обработка прерывающих ошибок (exceptions).

Продолжаем тему обработки ошибок в PowerShell, начатую в предыдущем посте. Сегодня речь пойдет об обработке прерывающих ошибок (исключений). Надо понимать, что сообщение об ошибке — это не то же самое, что исключение. Как вы помните, в PowerShell есть два типа ошибок — непрерывающие процесс и прерывающие. Непрерывающие ошибки позволяют продолжить работу, тогда как прерывающие останавливают выполнение команды. Остановка приводит к исключению (exception), которое и можно отлавливать и обрабатывать.

Примечание. Таким же образом можно обрабатывать и непрерывающие ошибки. Изменение параметра ErrorAction на Stop прервет выполнение команды и произведет исключение, которое можно уловить.


Для наглядности сгенерируем ошибку, попытавшись прочитать файл, на который у нас нет прав. А теперь обратимся к переменной $Error и выведем данные об исключении. Как видите, данное исключение имеет тип UnauthorizedAccessException и относится к базовому типу System.SystemException.

 PS C:\Users\MyName> $Error[0].Exception.GetType()
IsPublic IsSerial Name                                     BaseType                                                                                           
-------- -------- ----                                     --------                                                                                           
True     True     UnauthorizedAccessException              System.SystemException


Для обработки исключений в PowerShell есть несколько способов, которые мы сегодня и рассмотрим.


Try/Catch/Finally


Конструкция Try/Catch/Finally предназначена для обработки исключений, возникающих в процессе выполнения скрипта. В блоке Try располагается исполняемый код, в котором должны отслеживаться ошибки. При возникновении в блоке Try прерывающей ошибки оболочка PowerShell ищет соответствующий блок Catch для обработки этой ошибки, и если он найден, то выполняет находящиеся в нем инструкции. Блок Catch может включать в себя любые команды, необходимые для обработки возникнувшей ошибки и\или восстановления дальнейшей работы скрипта.
Блок Finally располагается обычно в конце скрипта. Команды, находящиеся в нем, выполняются в любом случае, независимо от возникновения ошибок. Была ли  ошибка перехвачена и обработана блоком Catch или при выполнении скрипта ошибок не возникало вообще, блок Finally будет выполнен. Присутствие этого блока в скрипте необязательно, основная его задача — высвобождение ресурсов (закрытие процессов, очистка памяти и т.п.).
В качестве примера в блок Try поместим код, который читает файлы из указанной директории. При возникновении проблем блок Catch выводит сообщение об ошибке, после чего отрабатывает блок Finally и работа скрипта завершается:
try {
Get-Content -Path "C:\Files\*" -ErrorAction Stop
}
catch {
Write-Host "Some error was found."
}
finally {
Write-Host "Finish."
}

 "Some error was found."
"Finish."

Для блока Catch можно указать конкретный тип ошибки, добавив после ключевого слова Catch в квадратных скобках название исключения. Так в следующем примере укажем в качестве типа исключение System.UnauthorizedAccessException, которое возникает при отсутствии необходимых прав доступа к объекту:
try {
Get-Content -Path "C:\Files\*" -ErrorAction Stop
}
catch [System.UnauthorizedAccessException]
{
Write-Host "File is not accessible."
}
finally {
Write-Host "Finish."
}

 File is not accessible.
Finish.

Если для блока Catch указан тип ошибки, то этот блок будет обрабатывать только этот тип ошибок, или тип ошибок, наследуемый от указанного типа. При возникновении другого типа ошибка не будет обработана. Если же тип не указан, то блок будет обрабатывать любые типы ошибок, возникающие в блоке Try.

Блок Try может включать несколько блоков Catch, для разных типов ошибок, соответственно можно для каждого типа ошибки задать свой обработчик. Например, возьмем два блока Catch, один для ошибки при отсутствии прав доступа, а второй — для любых других ошибок, которые могут возникнуть в процессе выполнения скрипта:
try {
Get-Content -Path "C:\Files\*" -ErrorAction Stop
}
catch [System.UnauthorizedAccessException]
{
Write-Host "File is not accessible."
}
catch {
Write-Host "Other type of error was found:"
Write-Host "Exception type is $($_.Exception.GetType().Name)"
}
finally {
Write-Host "Finish."
}

Trap

Еще один способ обработки ошибок — это установка ловушки (trap). В этом варианте обработчик ошибок задается с помощью ключевого слова Trap, определяющего список команд, которые должны выполниться при возникновении прерывающей ошибки и исключения. Когда происходит исключение, то оболочка PowerShell ищет в коде инструкции Trap для данной ошибки, и если находит, то выполняет их.
Возьмем наиболее простой пример ловушки, которая обрабатывает все произошедшие исключения и выводит сообщение об ошибке:
trap {
Write-Host "Error was found."
}
Get-Content -Path C:\File\* -ErrorAction Stop


Так же, как и для try\catch, ключевое слово Trap позволяет задавать тип исключения, указав его в квадратных скобках. К примеру, можно задать в скрипте несколько ловушек, одну нацелив на конкретную ошибку, а вторую на обработку оставшихся:
trap [System.Management.Automation.ItemNotFoundException]
{
Write-Host "File is not accessible."
break
}
trap {
Write-Host "Other error was found."
continue
}
Get-Content -Path C:\File\* -ErrorAction Stop

Вместе с Trap можно использовать ключевые слова Break и Continue, которые позволяют определить, должен ли скрипт продолжать выполняться после возникновения прерывающей ошибки. По умолчанию при возникновении исключения выполняются команды, входящие в блок Trap, выводится информация об ошибке, после чего выполнение скрипта продолжается со строки, вызвавшей ошибку:
trap {
Write-Host "Error was found."
}
Write-Host "Before error."
Get-Content -Path C:\File\* -ErrorAction Stop
Write-Host "After error."


Если использовать ключевое слово Break, то при возникновении ошибки будет выполнены команды в блоке Trap, после чего выполнение скрипта будет прервано:
trap {
Write-Host "Error was found."
break
}
Write-Host "Before error."
Get-Content -Path C:\File\* -ErrorAction Stop
Write-Host "After error."

Как  видно из примера, команда, следующая за исключением, не отработала и сообщение "After error." выведено не было.

Если же в Trap включено ключевое слово Continue, то выполнение скрипта будет продолжено, так же как и в случае по умолчанию. Единственное отличие в том, что с Continue ошибка не записывается в поток Error и не выводится на экран.
trap {
Write-Host "Error was found."
continue
}
Write-Host "Before error."
Get-Content -Path C:\File\* -ErrorAction Stop
Write-Host "After error."

Область действия

При отлове ошибок с помощью Trap надо помнить о такой вещи, как область действия (scope). Оболочка PowerShell является глобальной областью, в которую входят все процессы, запущенный скрипт получает собственную область, а если внутри скрипта определены функции, то внутри каждой определена своя, частная область действия. Это создает своего рода родительско-дочернюю иерархию.

При появлении исключения оболочка ищет ловушку в текущей области. Если в ней есть ловушка, она выполняется, если нет — то производится выход в вышестоящую область и поиск ловушки там. Когда ловушка находится, то происходит ее выполнение. Затем, если ловушка предусматривает продолжение работы, то оболочка возобновляет выполнение кода, начиная с той строки, которая вызвала исключение, но при этом оставаясь в той же области, не возвращаясь обратно.

Для примера возьмем функцию Content, внутри которой будет выполняться наш код. Область действия внутри функции назовем scope 1, а снаружи scope 2:
trap {
Write-Host "Error was found."
continue
}
function Content {
Write-Host "Before error, scope1."
Get-Content -Path C:\File\* -ErrorAction Stop
Write-Host "After error, scope 1."
}
Content
Write-Host "After error, scope 2."

При возникновении ошибки в функции Content оболочка будет искать ловушку внутри нее. Затем, не найдя ловушку внутри функции, оболочка выйдет из текущей области и будет искать в родительской области. Ловушка там есть, поэтому будет выполнена обработка ошибки, после чего Continue возобновит выполнение скрипта, но уже в родительской области (scope 2), не возвращаясь обратно в функцию (scope 1).


А теперь немного изменим скрипт, поместив ловушку внутрь функции:
function Content {
trap {
Write-Host "Error was found."
continue
}
Write-Host "Before error, scope 1."
Get-Content -Path C:\File\* -ErrorAction Stop
Write-Host "After error, scope 1."
}
Content
Write-Host "After error, scope 2."

Как видите, теперь при возникновении ошибки внутри функции будет произведена обработка ошибки, после чего выполнение  будет продолжено с той строки, в которой произошла ошибка - не выходя из функции.


Небольшое дополнение.


Один автор предложил для надежности отлавливать исключение глобально, без разделения на Stop или Continue. Для этого он предложил обрабатывать исключение System.Management.Automation.ActionPreferenceStopException.
Например так:


Try
{
    Remove-Item "C:\Files\*" -recurse -force
}
Catch [System.Management.Automation.ActionPreferenceStopException]
{
    Write-Host "It is hard to delete deleted file!"   
    Write-Host "Exception type is $($_.Exception.GetType().Name)"
}


Возможно в этом и есть положительное зерно, но без явного указания -ErrorAction Stop у меня его идея не сработала.

Заключение

Если сравнить Try/Catch и Trap, то у каждого метода есть свои достоинства и недостатки. Конструкцию Try/Catch можно более точно нацелить на возможную ошибку, так как Catch обрабатывает только содержимое блока Try. Эту особенность удобно использовать при отладке скриптов, для поиска ошибок.

И наоборот, Trap является глобальным обработчиком, отлавливая ошибки во всем скрипте независимо от расположения. На мой взгляд это более жизненный вариант, который больше подходит для постоянной работы.