go 使用 redis

准备redis环境

docker启动一个名为redis507的5.0.7版本的redis server：

docker run --name redis507 -p 6379:6379 -d redis:5.0.7

启动一个redis-cli连接上面的redis server：

docker run -it --network host --rm redis:5.0.7 redis-cli

使用 go-redis 库：

"github.com/go-redis/redis/v8"

文档可参见：go-redis文档 - 掘金

连接

普通连接

rdb := redis.NewClient(&redis.Options{
    Addr:     "localhost:6379",
    Password: "", // 密码
    DB:       0,  // 数据库
    PoolSize: 20, // 连接池大小
})

哨兵

rdb := redis.NewFailoverClient(&redis.FailoverOptions{
    MasterName:    "master-name",
    SentinelAddrs: []string{":9126", ":9127", ":9128"},
})

集群

rdb := redis.NewClusterClient(&redis.ClusterOptions{
    Addrs: []string{":7000", ":7001", ":7002", ":7003", ":7004", ":7005"},

    // 若要根据延迟或随机路由命令，请启用以下命令之一
    // RouteByLatency: true,
    // RouteRandomly: true,
})

基本使用

var rdb *redis.Client

// 初始化连接
func initClient(ctx context.Context) (err error) {
    rdb = redis.NewClient(&redis.Options{
        Addr:     "192.168.48.142:6379",
        Password: "", // no password set
        DB:       0,  // use default DB
    })

    _, err = rdb.Ping(ctx).Result()
    if err != nil {
        return err
    }

    return nil
}

func doCommand() {
    ctx, cancel := context.WithTimeout(context.Background(), 500*time.Millisecond)
    defer cancel()

    err := initClient(ctx)
    if err != nil {
        fmt.Println("initClient redis failed, err=", err)
    }

    // 执行命令获取结果
    val, err := rdb.Get(ctx, "age").Result()
    fmt.Println(val, err)

    // 先获取到命令对象
    cmder := rdb.Get(ctx, "age")
    fmt.Println(cmder.Val()) // 获取值
    fmt.Println(cmder.Err()) // 获取错误

    // 直接执行命令获取错误
    err = rdb.Set(ctx, "age", 10, time.Hour).Err()
    if err != nil {
        fmt.Println("set age failed, err=", err)
    }

    // 直接执行命令获取值
    value := rdb.Get(ctx, "age").Val()
    fmt.Println(value)
}

func main() {
    doCommand()
}

go-redis 还提供了一个执行任意命令或自定义命令的 Do 方法，特别是一些 go-redis 库暂时不支持的命令都可以使用该方法执行。具体使用方法如下：

// doDemo rdb.Do 方法使用示例
func doDemo() {
    ctx, cancel := context.WithTimeout(context.Background(), 500*time.Millisecond)
    defer cancel()

    // 直接执行命令获取错误
    err := rdb.Do(ctx, "set", "key", 10, "EX", 3600).Err()
    fmt.Println(err)

    // 执行命令获取结果
    val, err := rdb.Do(ctx, "get", "key").Result()
    fmt.Println(val, err)
}

redis.Nil

go-redis 库提供了一个 redis.Nil 错误来表示 Key 不存在的错误。因此在使用 go-redis 时需要注意对返回错误的判断。在某些场景下我们应该区别处理 redis.Nil 和其他不为 nil 的错误。

func getValueFromRedis(key, defaultValue string) (string, error) {
    ctx, cancel := context.WithTimeout(context.Background(), 500*time.Millisecond)
    defer cancel()

    val, err := rdb.Get(ctx, key).Result()
    if err != nil {
        // 如果返回的错误是key不存在
        if errors.Is(err, redis.Nil) {
            return defaultValue, nil
        }
        // 出其他错了
        return "", err
    }
    return val, nil
}

分布式锁

TODO