Ratelimit 技术文档

1. 安装指南

为了使用 Ratelimit，您需要先将其添加到您的应用程序的 Gemfile 中：

gem 'ratelimit'

接着执行以下命令来安装：

$ bundle

或者您也可以自行安装：

$ gem install ratelimit

2. 项目使用说明

Ratelimit 是一个利用 Redis 来限制跨多个服务器上动作频率的工具。它可以应用于多种场景，比如批量处理外部 API 数据。

使用方法：

• 添加计数：为指定主体（如电话号码、URL、电子邮件地址等）通过唯一键增加计数。

ratelimit = Ratelimit.new("messages")
5.times do
  ratelimit.add(phone_number)
end

• 获取执行次数：获取在给定秒数间隔内指定主体的执行次数。

ratelimit.count(phone_number, 30)
# 返回值：5

• 检查阈值：检查在过去指定秒数内是否超过了给定阈值。

ratelimit.exceeded?(phone_number, threshold: 10, interval: 30)
# 返回值：false
ratelimit.within_bounds?(phone_number, threshold: 10, interval: 30)
# 返回值：true

• 在阈值内执行代码块：如果指定阈值范围内，执行代码块。

ratelimit.exec_within_threshold phone_number, threshold: 10, interval: 30 do
  some_rate_limited_code
  ratelimit.add(phone_number)
end

连接外部 Redis 实例

默认情况下，Ratelimit 会尝试连接到位于 127.0.0.1:6379 的 Redis 服务器。当您使用独立的 Redis 服务器时，需要指定服务器的位置。

redis = Redis.new(host: "10.0.1.1", port: 6380, db: 15)
...
ratelimit = Ratelimit.new("messages", redis: redis)

3. 项目API使用文档

Ratelimit 的完整 API 文档可以在 这里 找到。但是为了方便，下面列出了基本的 API 方法：

• add(key)：为指定键增加计数。
• count(key, interval)：获取指定键在指定时间间隔内的计数。
• exceeded?(key, threshold, interval)：检查指定键是否超过阈值。
• within_bounds?(key, threshold, interval)：检查指定键是否在阈值范围内。
• exec_within_threshold(key, threshold, interval)：在指定阈值范围内执行代码块。

4. 项目安装方式

请参考上述安装指南部分的内容进行项目安装。简要概述如下：

• 将 Ratelimit 添加到 Gemfile。
• 执行 bundle 或 gem install ratelimit 来安装。