Golang实现多种重试策略和心跳检测的插件库repeat的使用

Repeat是一个Go语言实现的库，提供了多种回退策略，可用于重试操作和心跳检测。

示例

回退策略(Backoff)

假设我们需要在远程服务器上进行REST调用，但可能会因各种问题失败。我们可以使用指数回退策略重试失败的操作。

// 示例操作，前5次会失败
var last time.Time
op := func(c int) error {
    printInfo(c, &last)
    if c < 5 {
        return repeat.HintTemporary(errors.New("can't connect to a server"))
    }
    return nil
}

// 在任何错误时重试操作，最多10次，使用回退策略
err := repeat.Repeat(
    // 带计数器的操作函数
    repeat.FnWithCounter(op),
    // 如果操作返回nil则停止重试
    repeat.StopOnSuccess(),
    // 最多10次重试
    repeat.LimitMaxTries(10),
    // 使用带完整抖动的回退延迟
    repeat.WithDelay(
        repeat.FullJitterBackoff(500*time.Millisecond).Set(),
    ),
)

输出示例：

Attempt #0, Delay 0s
Attempt #1, Delay 373.617912ms
Attempt #2, Delay 668.004225ms
Attempt #3, Delay 1.220076558s
Attempt #4, Delay 2.716156336s
Attempt #5, Delay 6.458431017s
Repetition process is finished with: <nil>

带超时的回退策略

下面的示例与上一个几乎相同，但增加了一个重要特性 - 可以使用上下文超时取消操作重试。

// 带取消功能的上下文，3秒后取消重试
ctx, cancelFunc := context.WithCancel(context.Background())
go func() {
    time.Sleep(3 * time.Second)
    cancelFunc()
}()

// 在任何错误时重试操作，最多10次，使用回退策略
err := repeat.Repeat(
    ...
    // 使用带完整抖动的回退延迟和上下文
    repeat.WithDelay(
        repeat.FullJitterBackoff(500*time.Millisecond).Set(),
        repeat.SetContext(ctx),
    ),
    ...
)

输出示例：

Attempt #0, Delay 0s
Attempt #1, Delay 358.728046ms
Attempt #2, Delay 845.361787ms
Attempt #3, Delay 61.527485ms
Repetition process is finished with: context canceled

心跳检测(Heartbeating)

假设我们需要定期向远程服务器报告执行进度。下面的示例每秒重复一次操作，直到通过传递的上下文取消。

// 心跳检测示例操作
var last time.Time
op := func(c int) error {
    printInfo(c, &last)
    return nil
}

// 带取消功能的上下文，7秒后取消
ctx, cancelFunc := context.WithCancel(context.Background())
go func() {
    time.Sleep(7 * time.Second)
    cancelFunc()
}()

err := repeat.Repeat(
    // 心跳检测操作
    repeat.FnWithCounter(op),
    // 使用固定回退延迟和上下文
    repeat.WithDelay(
        repeat.FixedBackoff(time.Second).Set(),
        repeat.SetContext(ctx),
    ),
)

输出示例：

Attempt #0, Delay 0s
Attempt #1, Delay 1.001129426s
Attempt #2, Delay 1.000155727s
Attempt #3, Delay 1.001131014s
Attempt #4, Delay 1.000500428s
Attempt #5, Delay 1.0008985s
Attempt #6, Delay 1.000417057s
Repetition process is finished with: context canceled

带错误超时的心跳检测

下面的示例与上一个几乎相同，但会使用特殊的错误超时来取消。每次操作返回nil时，这个超时都会重置。

// 心跳检测示例操作，3次成功尝试后失败5次
var last time.Time
op := func(c int) error {
    printInfo(c, &last)
    if c > 3 && c < 8 {
        return repeat.HintTemporary(errors.New("can't connect to a server"))
    }
    return nil
}

err := repeat.Repeat(
    // 心跳检测操作
    repeat.FnWithCounter(op),
    // 使用固定回退延迟和错误超时
    repeat.WithDelay(
        repeat.FixedBackoff(time.Second).Set(),
        repeat.SetErrorsTimeout(3*time.Second),
    ),
)

输出示例：

Attempt #0, Delay 0s
Attempt #1, Delay 1.001634616s
Attempt #2, Delay 1.004912408s
Attempt #3, Delay 1.001021358s
Attempt #4, Delay 1.001249459s
Attempt #5, Delay 1.004320833s
Repetition process is finished with: can't connect to a server