Open source APMGolang ORMGolang ClickHouseBlog
Go Redis

Go Redis Ring 客户端

提示

要了解如何使用 go-redis 客户端，请参阅 入门 指南。

介绍

Ring 分片客户端，是采用了一致性 HASH 算法在多个 redis 服务器之间分发 key，每个节点承担一部分 key 的存储。

Ring 客户端会监控每个节点的健康状况，并从 Ring 中移除掉宕机的节点，当节点恢复时，会再加入到 Ring 中。这样实现了可用性和容错性，但节点和节点之间没有一致性，仅仅是通过多个节点分摊流量的方式来处理更多的请求。如果你更注重一致性、分区、安全性，请使用 Redis Cluster。

go-redis 默认使用 Rendezvous在新窗口打开 Hash 算法，你也可以通过设置 RingOptions.NewConsistentHash 自定义一致性 HASH 算法，更多 Ring 客户端设置请参照 redis.RingOptions。

开始使用

创建一个由三个节点组成的 Ring 客户端，更多设置请参照 redis.RingOptions:

import "github.com/redis/go-redis/v9"

rdb := redis.NewRing(&redis.RingOptions{
    Addrs: map[string]string{
        // shardName => host:port
        "shard1": "localhost:7000",
        "shard2": "localhost:7001",
        "shard3": "localhost:7002",
    },
})

你可以像其他客户端一样执行命令：

if err := rdb.Set(ctx, "foo", "bar", 0).Err(); err != nil {
    panic(err)
}

遍历每个节点:

err := rdb.ForEachShard(ctx, func(ctx context.Context, shard *redis.Client) error {
    return shard.Ping(ctx).Err()
})
if err != nil {
    panic(err)
}

节点选项配置

你可以手动设置连接节点，例如设置用户名和密码：

rdb := redis.NewRing(&redis.RingOptions{
    NewClient: func(opt *redis.Options) *redis.NewClient {
        user, pass := userPassForAddr(opt.Addr)
        opt.Username = user
        opt.Password = pass

        return redis.NewClient(opt)
    },
})

自定义 Hash 算法

go-redis 默认使用 Rendezvous在新窗口打开 Hash 算法将 Key 分布到多个节点上，你可以更改为其他 Hash 算法：

import "github.com/golang/groupcache/consistenthash"

ring := redis.NewRing(&redis.RingOptions{
    NewConsistentHash: func() {
        return consistenthash.New(100, crc32.ChecksumIEEE)
    },
})