Retryable 使用教程

Retryable 使用教程

retryable Retryable is general-purpose retrying library, written in Ruby, to simplify the task of adding retry behavior to just about anything. 项目地址: https://gitcode.com/gh_mirrors/re/retryable

1. 项目介绍

Retryable 是一个通用的重试库，使用 Ruby 编写，旨在简化为任何任务添加重试逻辑的过程。当处理的任务可能会出现失败（例如网络请求波动）时，Retryable 能够自动重试代码块，直到成功或达到指定的重试次数。

2. 项目快速启动

首先，确保你已经安装了 Ruby。然后，通过以下命令安装 Retryable：

gem install retryable

将 Retryable 添加到你的 Gemfile：

gem 'retryable'

在你的 Ruby 项目中，你可以像下面这样使用 Retryable：

require 'retryable'

Retryable.retryable(tries: 3, on: OpenURI::HTTPError) do
  xml = open('http://example.com/test.xml').read
end

上面的代码会尝试打开一个 URL，如果遇到 OpenURI::HTTPError 错误，它会重试最多 3 次。

3. 应用案例和最佳实践

永远重试

你可以设置重试次数为 Float::INFINITY，使代码块无限重试：

Retryable.retryable(tries: Float::INFINITY) do
  # 你的代码
end

重试特定的异常

你可以指定一个异常列表，只有这些异常发生时才会重试：

Retryable.retryable(tries: 5, on: [ArgumentError, Timeout::Error]) do
  # 你的代码
end

确保代码块执行

即使代码块中发生异常，也可以确保某些代码总是被执行：

ensure_cb = proc do |retries|
  puts "total retry attempts: #{retries}"
end

Retryable.retryable(ensure: ensure_cb) do
  # 你的代码
end

自定义重试间隔

你可以自定义重试之间的等待时间：

Retryable.retryable(sleep: lambda { |n| 2 ** n }) do
  # 你的代码
end

在上面的例子中，重试间隔是指数增长的。

基于异常消息的重试

你可以根据异常的消息内容来决定是否重试：

Retryable.retryable(matching: /IO timeout/) do
  # 你的代码
end

4. 典型生态项目

目前没有特定的生态项目列出，但 Retryable 可以与任何需要重试逻辑的 Ruby 项目配合使用。例如，在网络请求库、数据库操作或任何可能出现失败的操作中，Retryable 都可以作为一个强大的工具来提高代码的健壮性和可靠性。

retryable Retryable is general-purpose retrying library, written in Ruby, to simplify the task of adding retry behavior to just about anything. 项目地址: https://gitcode.com/gh_mirrors/re/retryable