Redis 配置源

Redis 是高性能的键值存储，适合作为配置中心使用。

安装

dotnet add package Apq.Cfg.Redis

默认层级

该配置源的默认层级为 CfgSourceLevels.Redis (100)。

如果不指定 level 参数，将使用默认层级：

// 使用默认层级 100
.AddRedis(options => { ... })

// 指定自定义层级
.AddRedis(options => { ... }, level: 150)

基本用法

using Apq.Cfg;
using Apq.Cfg.Redis;

var cfg = new CfgBuilder()
    .AddRedis(options =>
    {
        options.ConnectionString = "localhost:6379";
        options.KeyPrefix = "config:myapp:";
    })  // 使用默认层级 100
    .Build();

启用变更通知

var cfg = new CfgBuilder()
    .AddRedis(options =>
    {
        options.ConnectionString = "localhost:6379";
        options.KeyPrefix = "config:myapp:";
        options.Channel = "config:myapp:changes";
    })  // 使用默认层级 100
    .Build();

方法签名

public static CfgBuilder AddRedis(
    this CfgBuilder builder,
    Action<RedisOptions> configure,
    int level,
    bool isPrimaryWriter = false)

配置选项

完整配置

var cfg = new CfgBuilder()
    .AddRedis(options =>
    {
        options.ConnectionString = "localhost:6379,password=secret";
        options.KeyPrefix = "config:myapp:";
        options.Database = 0;
        options.Channel = "config:myapp:changes";
        options.ConnectTimeoutMs = 5000;
        options.OperationTimeoutMs = 5000;
        options.ScanPageSize = 250;
    })  // 使用默认层级 100
    .Build();

选项说明

选项	类型	默认值	说明
ConnectionString	string?	null	Redis 连接字符串
KeyPrefix	string?	null	配置键前缀
Database	int?	null	Redis 数据库索引
Channel	string?	null	变更通知频道
ConnectTimeoutMs	int	5000	连接超时时间（毫秒）
OperationTimeoutMs	int	5000	操作超时时间（毫秒）
ScanPageSize	int	250	SCAN 命令每次返回的键数量

Redis 配置结构

Hash 存储（推荐）

# 使用 Redis CLI
HSET config:myapp Database:Host "localhost"
HSET config:myapp Database:Port "5432"
HSET config:myapp App:Name "MyApplication"

# 批量设置
HMSET config:myapp \
  Database:Host "localhost" \
  Database:Port "5432" \
  App:Name "MyApplication"

字符串存储

SET config:myapp:Database:Host "localhost"
SET config:myapp:Database:Port "5432"

JSON 存储

SET config:myapp '{"Database":{"Host":"localhost","Port":5432}}'

配置变更通知

发布变更

# 修改配置后发布通知
SET config:myapp:Database:Host "new-host"
PUBLISH config:myapp:changes "Database:Host"

订阅变更

var cfg = new CfgBuilder()
    .AddRedis(options =>
    {
        options.ConnectionString = "localhost:6379";
        options.KeyPrefix = "config:myapp:";
        options.Channel = "config:myapp:changes";
    })  // 使用默认层级 100
    .Build();

cfg.ConfigChanges.Subscribe(e =>
{
    Console.WriteLine("Redis 配置已更新:");
    foreach (var (key, change) in e.Changes)
    {
        Console.WriteLine($"  [{change.Type}] {key}: {change.OldValue} -> {change.NewValue}");
    }
});

高可用配置

Redis Sentinel

var cfg = new CfgBuilder()
    .AddRedis(options =>
    {
        options.ConnectionString = "sentinel1:26379,sentinel2:26379,serviceName=mymaster";
        options.KeyPrefix = "config:myapp:";
    })  // 使用默认层级 100
    .Build();

Redis Cluster

var cfg = new CfgBuilder()
    .AddRedis(options =>
    {
        options.ConnectionString = "node1:6379,node2:6379,node3:6379";
        options.KeyPrefix = "config:myapp:";
    })  // 使用默认层级 100
    .Build();

认证配置

密码认证

var cfg = new CfgBuilder()
    .AddRedis(options =>
    {
        options.ConnectionString = "localhost:6379,password=your-password";
        options.KeyPrefix = "config:myapp:";
    })  // 使用默认层级 100
    .Build();

SSL/TLS

var cfg = new CfgBuilder()
    .AddRedis(options =>
    {
        options.ConnectionString = "localhost:6379,ssl=true,sslHost=redis.example.com";
        options.KeyPrefix = "config:myapp:";
    })  // 使用默认层级 100
    .Build();

与本地配置混合使用

var cfg = new CfgBuilder()
    // 本地基础配置
    .AddJsonFile("config.json")
    // Redis 远程配置（使用默认层级 100）
    .AddRedis(options =>
    {
        options.ConnectionString = "localhost:6379";
        options.KeyPrefix = "config:myapp:";
        options.Channel = "config:myapp:changes";
    })
    // 环境变量（使用默认层级 400）
    .AddEnvironmentVariables(prefix: "APP_")
    .Build();

下一步

• Apollo 配置源 - Apollo 配置中心
• Vault 配置源 - HashiCorp Vault