《Limiter：一款优秀的HTTP请求限流中间件使用指南》

2025-01-16 09:03:22作者：俞予舒Fleming

项目地址：https://gitcode.com/gh_mirrors/limit/limiter

在当今互联网世界中，服务器的稳定性和安全性至关重要。为了保护服务器免受恶意流量和过度请求的影响，我们需要使用到HTTP请求限流中间件。今天，我将为大家介绍一个开源项目——Limiter，它是一款优秀的Rack中间件，用于限制HTTP请求的频率，并提供黑白名单功能。下面我将详细介绍Limiter的安装与使用方法。

安装前准备

在开始安装Limiter之前，请确保您的系统满足以下要求：

操作系统：Linux、macOS 或 Windows
Ruby 环境：建议使用较新的版本
依赖项：确保已安装Redis，因为Limiter会使用Redis进行数据存储

安装步骤

下载开源项目资源

首先，您需要将Limiter项目克隆到本地。在终端中执行以下命令：
```
git clone https://github.com/csdn-dev/limiter.git
```
安装过程详解

在项目目录中，通过Gemfile文件添加Limiter依赖。打开Gemfile，添加以下内容：
```
gem 'limiter', :git => "git://github.com/csdn-dev/limiter.git"
```
然后，执行以下命令安装依赖：
```
bundle install
```
常见问题及解决

在安装过程中，可能会遇到一些问题。以下是一些常见问题及其解决方法：
- 如果遇到Redis相关的问题，请检查Redis服务是否已正确安装和启动。
- 如果在安装过程中出现Ruby版本冲突，请尝试升级或切换到推荐的Ruby版本。

基本使用方法

安装完成后，您可以通过以下步骤开始使用Limiter：

加载开源项目

在Rails项目中，将Limiter中间件添加到config/initializers/limiter.rb文件中。以下是一个示例配置：

# config/initializers/limiter.rb

require File.expand_path("../redis", __FILE__)
Rails.configuration.app_middleware.insert_before(Rack::MethodOverride,
                                                 Limiter::RateLimiter,
                                                 :max_get_num => 1000,
                                                 :get_ttl => 20.minutes,
                                                 :max_post_num => 20,
                                                 :post_ttl => 5.seconds,
                                                 :filter_ip_segment => true,
                                                 :black_list => Limiter::BlackList.new($redis),
                                                 :white_list => Limiter::WhiteList.new($redis),
                                                 :allow_path => Rails.env.development? ? /^\/(assets|human_validations|simple_captcha)/ :
                                                                                       /^\/(human_validations|simple_captcha)/,
                                                 :message => "<a href='/human_validations/new'>我不是机器人</a>",
                                                 :visit_counter => Limiter::VisitCounter.new($redis),
                                                 :limit_callback => lambda { |ip| your_callback(ip) }
                                                )

简单示例演示

下面是一个简单的示例，展示了如何使用Limiter对HTTP请求进行限流：

class SomeController < ApplicationController
  before_action :limit_request

  private

  def limit_request
    limiter = Limiter::RateLimiter.new(request)
    limiter.limit!
  end
end

参数设置说明
- :max_get_num：允许的最大GET请求次数。
- :get_ttl：GET请求的存活时间。
- :max_post_num：允许的最大POST请求次数。
- :post_ttl：POST请求的存活时间。
- :filter_ip_segment：是否过滤IP段。
- :black_list：黑名单列表。
- :white_list：白名单列表。
- :allow_path：允许的路径。
- :message：当请求被限流时显示的消息。
- :visit_counter：访问计数器。
- :limit_callback：当请求被限流时执行的回调函数。