Redis 客户端 for Go 语言的技术文档

1. 安装指南

在开始使用 go-redis 前，确保您的环境已经安装了支持模块的 Go 语言版本。以下是初始化一个 Go 模块并安装 go-redis 的步骤：

go mod init github.com/my/repo
go get github.com/redis/go-redis/v9

2. 项目的使用说明

go-redis 是一个功能丰富的 Redis 客户端库，支持 Redis 的多种特性和命令。以下是一个简单的使用示例：

import (
    "context"
    "fmt"
    "github.com/redis/go-redis/v9"
)

var ctx = context.Background()

func ExampleClient() {
    rdb := redis.NewClient(&redis.Options{
        Addr:     "localhost:6379",
        Password: "", // 未设置密码
        DB:       0,  // 使用默认数据库
    })

    // 设置一个键值对
    err := rdb.Set(ctx, "key", "value", 0).Err()
    if err != nil {
        panic(err)
    }

    // 获取之前设置的键的值
    val, err := rdb.Get(ctx, "key").Result()
    if err != nil {
        panic(err)
    }
    fmt.Println("key", val)

    // 尝试获取一个不存在的键的值
    val2, err := rdb.Get(ctx, "key2").Result()
    if err == redis.Nil {
        fmt.Println("key2 不存在")
    } else if err != nil {
        panic(err)
    } else {
        fmt.Println("key2", val2)
    }
    // 输出: key value
    // key2 不存在
}

3. 项目API使用文档

go-redis 提供了丰富的 API，支持 Redis 的各种命令和使用场景。以下是部分 API 的使用示例：

• 设置键值对并设置过期时间：

err := rdb.Set(ctx, "key", "value", 10*time.Second).Err()

• 使用 NX 选项设置键值对（如果键不存在）：

set, err := rdb.SetNX(ctx, "key", "value", redis.KeepTTL).Result()

• 排序列表：

vals, err := rdb.Sort(ctx, "list", &redis.Sort{Offset: 0, Count: 2, Order: "ASC"}).Result()

• 获取有序集合的值范围：

vals, err := rdb.ZRangeByScoreWithScores(ctx, "zset", &redis.ZRangeBy{
    Min: "-inf",
    Max: "+inf",
    Offset: 0,
    Count: 2,
}).Result()

• 执行 Redis 脚本：

vals, err := rdb.Eval(ctx, "return {KEYS[1],ARGV[1]}", []string{"key"}, "hello").Result()

• 自定义命令：

res, err := rdb.Do(ctx, "set", "key", "value").Result()

更多 API 使用详情，请参考 go-redis 的官方文档。

4. 项目安装方式

项目的安装方式已在“安装指南”部分说明，简要概括如下：

1. 初始化 Go 模块：

go mod init github.com/my/repo

2. 安装 go-redis：

go get github.com/redis/go-redis/v9

通过以上步骤，您就可以在 Go 项目中使用 go-redis 客户端了。