PowerShell 尝试/捕获和重试

Question

我有一个相当大的 powershell 脚本，其中包含许多（20 多个）执行各种操作的函数。

目前所有代码都没有任何错误处理或重试功能。如果某个特定的任务/功能失败了，它就会失败并继续。

我想改进错误处理并实施重试以使其更加健壮。

我在想类似的事情：

$tries = 0
while ($tries -lt 5) {
    try{    

       # Do Something

       # No retries necessary
       $tries = 5;
    } catch {
       # Report the error
       # Other error handling
    }
 }

问题是我需要执行许多步骤。

我认为将上述代码实现 20 次没有意义。这似乎真的是多余的。

我正在考虑编写一个带有单个参数的“TryCatch”函数，其中包含我要调用的实际函数？

不过，我也不确定这是否是正确的方法。我最终不会得到一个类似以下内容的脚本：

TryCatch "Function1 Parameter1 Parameter2"
TryCatch "Function2 Parameter1 Parameter2"
TryCatch "Function3 Parameter1 Parameter2"

有没有更好的方法来做到这一点？

Answer 1

如果您经常需要多次重试操作的代码，您可以将循环的 try..catch 包装在一个函数中，并在脚本块中传递命令：

function Retry-Command {
    [CmdletBinding()]
    Param(
        [Parameter(Position=0, Mandatory=$true)]
        [scriptblock]$ScriptBlock,

        [Parameter(Position=1, Mandatory=$false)]
        [int]$Maximum = 5,

        [Parameter(Position=2, Mandatory=$false)]
        [int]$Delay = 100
    )

    Begin {
        $cnt = 0
    }

    Process {
        do {
            $cnt++
            try {
                $ScriptBlock.Invoke()
                return
            } catch {
                Write-Error $_.Exception.InnerException.Message -ErrorAction Continue
                Start-Sleep -Milliseconds $Delay
            }
        } while ($cnt -lt $Maximum)

        # Throw an error after $Maximum unsuccessful invocations. Doesn't need
        # a condition, since the function returns upon successful invocation.
        throw 'Execution failed.'
    }
}

像这样调用函数（默认为 5 次重试）：

Retry-Command -ScriptBlock {
    # do something
}

或像这样（如果您在某些情况下需要不同的重试次数）：

Retry-Command -ScriptBlock {
    # do something
} -Maximum 10

该功能可以进一步改进，例如通过在 $Maximum 尝试失败后终止脚本，可以使用另一个参数进行配置，这样您就可以拥有导致脚本在失败时停止的操作，以及可以忽略失败的操作。

Answer 2

我改编了@Victor 的回答并补充道：

• 重试参数
• ErrorAction 设置和恢复（否则异常不会被捕获）
• 指数退避延迟（我知道 OP 没有要求这样做，但我使用它）
• 摆脱了 VSCode 警告（即将 sleep 替换为 Start-Sleep）

# [Solution with passing a delegate into a function instead of script block](https://stackoverflow.com/a/47712807/)
function Retry()
{
    param(
        [Parameter(Mandatory=$true)][Action]$action,
        [Parameter(Mandatory=$false)][int]$maxAttempts = 3
    )

    $attempts=1    
    $ErrorActionPreferenceToRestore = $ErrorActionPreference
    $ErrorActionPreference = "Stop"

    do
    {
        try
        {
            $action.Invoke();
            break;
        }
        catch [Exception]
        {
            Write-Host $_.Exception.Message
        }

        # exponential backoff delay
        $attempts++
        if ($attempts -le $maxAttempts) {
            $retryDelaySeconds = [math]::Pow(2, $attempts)
            $retryDelaySeconds = $retryDelaySeconds - 1  # Exponential Backoff Max == (2^n)-1
            Write-Host("Action failed. Waiting " + $retryDelaySeconds + " seconds before attempt " + $attempts + " of " + $maxAttempts + ".")
            Start-Sleep $retryDelaySeconds 
        }
        else {
            $ErrorActionPreference = $ErrorActionPreferenceToRestore
            Write-Error $_.Exception.Message
        }
    } while ($attempts -le $maxAttempts)
    $ErrorActionPreference = $ErrorActionPreferenceToRestore
}

# function MyFunction($inputArg)
# {
#     Throw $inputArg
# }

# #Example of a call:
# Retry({MyFunction "Oh no! It happened again!"})
# Retry {MyFunction "Oh no! It happened again!"} -maxAttempts 10

Answer 3

将委托传递给函数而不是脚本块的解决方案：

function Retry([Action]$action)
{
    $attempts=3    
    $sleepInSeconds=5
    do
    {
        try
        {
            $action.Invoke();
            break;
        }
        catch [Exception]
        {
            Write-Host $_.Exception.Message
        }            
        $attempts--
        if ($attempts -gt 0) { sleep $sleepInSeconds }
    } while ($attempts -gt 0)    
}

function MyFunction($inputArg)
{
    Throw $inputArg
}

#Example of a call:
Retry({MyFunction "Oh no! It happend again!"})

Answer 4

错误处理总是会为您的脚本添加更多内容，因为它通常必须处理许多不同的事情。如果您想让每个函数都有多次尝试，Try Catch 函数可能最适合您上面描述的内容。自定义函数甚至允许您通过每次传入一个值来设置尝试之间的睡眠计时器，或者改变该函数将尝试的尝试次数。