mcaptcha/cache

mCaptcha/cache 镜像文档

镜像概述

mCaptcha/cache 是一个基于Redis的模块，核心功能是实现漏桶算法（Leaky Bucket Algorithm），用于流量控制和请求速率限制。该模块可无缝集成到Redis服务器中，为分布式系统提供高效、可扩展的请求频率管理能力，适用于API限流、服务保护等场景。

核心功能与特性

• 漏桶算法实现：通过漏桶算法精确控制请求速率，平滑流量波动，防止服务过载
• Redis原生集成：作为Redis模块运行，无需额外服务，降低系统复杂度
• 高性能：基于Redis的高效数据处理能力，支持高并发场景下的速率限制
• 灵活配置：支持自定义桶容量、漏出速率等参数，适应不同场景需求
• 分布式支持：依托Redis的分布式特性，可在集群环境中实现统一的流量控制

使用场景与适用范围

• API服务限流：限制客户端对API接口的请求频率，防止***请求或流量峰值
• 服务保护：保护后端服务免受突发流量冲击，确保服务稳定性
• 资源分配：合理分配系统资源，避免单一用户或服务占用过多资源
• 分布式系统：在微服务架构中提供跨服务的统一流量控制机制

使用方法与配置说明

前提条件

• 已安装Redis 6.0或更高版本（支持模块加载）
• Docker环境

镜像获取

bash
docker pull mcaptcha/cache

基本使用（Docker Run）

bash
# 启动Redis并加载mCaptcha/cache模块
docker run -d \
  --name redis-with-mcaptcha-cache \
  -p 6379:6379 \
  redis:latest \
  redis-server --loadmodule /path/to/mcaptcha_cache.so [配置参数]

注：实际使用时需将/path/to/mcaptcha_cache.so替换为模块在容器内的实际路径，具体可参考GitHub项目文档。

Docker Compose配置示例

yaml
version: '3'
services:
  redis:
    image: redis:latest
    ports:
      - "6379:6379"
    volumes:
      - ./mcaptcha_cache.so:/usr/local/lib/redis/modules/mcaptcha_cache.so
    command: redis-server --loadmodule /usr/local/lib/redis/modules/mcaptcha_cache.so bucket_capacity=100 leak_rate=10

核心配置参数

常用命令示例

加载模块后，可通过Redis CLI执行以下命令：

bash
# 检查模块是否加载成功
redis-cli MODULE LIST | grep mcaptcha_cache

# 对指定键应用漏桶限流
redis-cli MCAPTCHA_CACHE_INCR my_key

参考链接

• 项目GitHub地址：https://github.com/mCaptcha/cache
• Redis模块开发文档：Redis Modules Documentation