重试

在软件开发中，经常会遇到由于网络问题、资源不可用或外部依赖等各种因素导致操作暂时失败的情况。在这种情况下，通常希望自动重试操作，使其最终成功。

重试是处理瞬态故障并确保关键操作成功执行的强大机制。在 Effect 中，通过内置函数和调度策略，重试变得简单而灵活。

在本指南中，我们将探索 Effect 中重试的概念，并学习如何使用 retry 和 retryOrElse 函数来处理失败场景。我们将了解如何使用调度来定义重试策略，这些调度决定了操作应该何时重试以及重试多少次。

无论您是在处理网络请求、数据库交互还是任何其他可能出错的操作，掌握 Effect 的重试功能都可以显著增强应用程序的弹性和可靠性。

retry

Effect.retry 函数接受一个 effect 和一个调度策略，如果 effect 失败，将按照策略规则自动重试。

如果 effect 最终成功，将返回结果。

如果达到最大重试次数且 effect 仍然失败，则传播失败。

这在处理间歇性故障时很有用，例如网络问题或临时资源不可用。通过定义重试策略，您可以控制重试次数、重试之间的延迟以及何时停止重试。

示例（使用固定延迟重试）

import { Effect, Schedule } from "effect"

let count = 0

// 模拟一个可能失败的 effect
const task = Effect.async<string, Error>((resume) => {
  if (count <= 2) {
    count++
    console.log("failure")
    resume(Effect.fail(new Error()))
  } else {
    console.log("success")
    resume(Effect.succeed("yay!"))
  }
})

// 定义一个使用固定延迟的重复策略
const policy = Schedule.fixed("100 millis")

const repeated = Effect.retry(task, policy)

Effect.runPromise(repeated).then(console.log)
/*
Output:
failure
failure
failure
success
yay!
*/

立即重试 n 次

您也可以使用更简单的策略立即重试失败的 effect 指定次数：

示例（重试任务最多 5 次）

import { Effect } from "effect"

let count = 0

// 模拟一个可能失败的 effect
const task = Effect.async<string, Error>((resume) => {
  if (count <= 2) {
    count++
    console.log("failure")
    resume(Effect.fail(new Error()))
  } else {
    console.log("success")
    resume(Effect.succeed("yay!"))
  }
})

// 重试任务最多 5 次
Effect.runPromise(Effect.retry(task, { times: 5 }))
/*
Output:
failure
failure
failure
success
*/

基于条件重试

您可以通过指定条件来自定义重试的管理方式。使用 until 或 while 选项来控制何时停止重试。

示例（重试直到满足特定条件）

import { Effect } from "effect"

let count = 0

// 定义一个在每次调用时模拟不同错误的 effect
const action = Effect.failSync(() => {
  console.log(`Action called ${++count} time(s)`)
  return `Error ${count}`
})

// 重试操作直到满足特定条件
const program = Effect.retry(action, {
  until: (err) => err === "Error 3"
})

Effect.runPromiseExit(program).then(console.log)
/*
Output:
Action called 1 time(s)
Action called 2 time(s)
Action called 3 time(s)
{
  _id: 'Exit',
  _tag: 'Failure',
  cause: { _id: 'Cause', _tag: 'Fail', failure: 'Error 3' }
}
*/

替代方案

如果您的重试条件基于成功结果而不是错误，您也可以使用 Effect.repeat。

retryOrElse

Effect.retryOrElse 函数根据定义的调度策略尝试多次重试失败的 effect。

如果重试次数用尽且 effect 仍然失败，它将运行回退 effect。

当您希望通过在重复失败后指定替代操作来优雅地处理失败时，此函数很有用。

示例（带回退的重试）

import { Effect, Schedule, Console } from "effect"

let count = 0

// 模拟一个可能失败的 effect
const task = Effect.async<string, Error>((resume) => {
  if (count <= 2) {
    count++
    console.log("failure")
    resume(Effect.fail(new Error()))
  } else {
    console.log("success")
    resume(Effect.succeed("yay!"))
  }
})

// 重试任务，重试之间有延迟，最多重试 2 次
const policy = Schedule.addDelay(Schedule.recurs(2), () => "100 millis")

// 如果所有重试都失败，运行回退 effect
const repeated = Effect.retryOrElse(
  task,
  policy,
  // 回退
  () => Console.log("orElse").pipe(Effect.as("default value"))
)

Effect.runPromise(repeated).then(console.log)
/*
Output:
failure
failure
failure
orElse
default value
*/