T2FGame.Cache.Redis 1.0.2

T2FGame.Cache.Redis

T2FGame 框架的 Redis 分布式缓存模块，提供高性能的分布式缓存和限流功能。

功能特性

• 分布式 Action 缓存：基于 Redis 的 IActionCache 实现，替代内存缓存
• 分布式限流器：基于 Redis 的 IRateLimiter 实现，支持滑动窗口和令牌桶算法
• 一站式配置：简化 Redis 服务注册
• 连接复用：共享 Redis 连接，减少资源消耗

安装

<PackageReference Include="T2FGame.Cache.Redis" />

快速开始

添加 Redis 缓存

services.AddActionPipeline(options =>
{
    options.UseCacheHandler = true;
});

// 使用 Redis 替代内存缓存
services.AddRedisActionCache(options =>
{
    options.ConnectionString = "localhost:6379";
    options.Database = 0;
    options.KeyPrefix = "t2f:cache";
});

添加 Redis 限流器

services.AddActionPipeline(options =>
{
    options.UseRateLimitHandler = true;
});

// 使用 Redis 替代内存限流器
services.AddRedisRateLimiter(options =>
{
    options.Database = 1;
    options.KeyPrefix = "t2f:ratelimit";
    options.Algorithm = RateLimitAlgorithm.SlidingWindow;
});

一站式配置

services.AddRedisServices(
    connectionString: "localhost:6379",
    configureCache: cache =>
    {
        cache.KeyPrefix = "game:cache";
    },
    configureRateLimiter: limiter =>
    {
        limiter.Algorithm = RateLimitAlgorithm.TokenBucket;
    });

配置选项

RedisActionCacheOptions

RedisRateLimiterOptions

限流算法

滑动窗口（SlidingWindow）

适用于需要精确控制请求频率的场景：

services.AddRedisRateLimiter(options =>
{
    options.Algorithm = RateLimitAlgorithm.SlidingWindow;
});

令牌桶（TokenBucket）

适用于需要允许突发流量的场景：

services.AddRedisRateLimiter(options =>
{
    options.Algorithm = RateLimitAlgorithm.TokenBucket;
});

使用现有连接

如果应用程序已有 Redis 连接，可以复用：

var connection = ConnectionMultiplexer.Connect("localhost:6379");

services.AddRedisConnection(connection);
services.AddRedisActionCache();
services.AddRedisRateLimiter();

与 Action 缓存配合使用

[ActionController(cmd: 1)]
public class ItemController
{
    [ActionMethod(subCmd: 1)]
    [ActionCache(duration: 60, Scope = CacheScope.Global)]
    public async Task<ItemListResponse> GetItemList()
    {
        // 此响应将被缓存 60 秒
        return await _itemService.GetAllItemsAsync();
    }

    [ActionMethod(subCmd: 2)]
    [ActionCache(duration: 30, Scope = CacheScope.User)]
    public async Task<InventoryResponse> GetInventory(FlowContext context)
    {
        // 每个用户独立缓存 30 秒
        return await _inventoryService.GetByUserIdAsync(context.UserId);
    }
}

生产环境建议

Redis 集群配置

services.AddRedisActionCache(options =>
{
    options.ConnectionString = "redis-cluster-1:6379,redis-cluster-2:6379,redis-cluster-3:6379";
    options.Password = Environment.GetEnvironmentVariable("REDIS_PASSWORD");
    options.UseSsl = true;
});

分离缓存和限流数据库

services.AddRedisActionCache(options =>
{
    options.Database = 0;  // 缓存使用 DB 0
});

services.AddRedisRateLimiter(options =>
{
    options.Database = 1;  // 限流使用 DB 1
});

目录结构

T2FGame.Cache.Redis/
├── RedisActionCache.cs      # Redis 缓存实现
├── RedisRateLimiter.cs      # Redis 限流器实现
└── DependencyInjection.cs   # 服务注册扩展