go-redis 指南 (Go)
将您的Go应用程序连接到Redis数据库
go-redis 是 Go 的 Redis 客户端。
以下部分解释了如何安装 go-redis 并将您的应用程序连接到 Redis 数据库。
go-redis 需要一个正在运行的 Redis 或
Redis Stack 服务器。
有关 Redis 安装说明，请参阅 Getting started。
安装
go-redis 支持最近两个 Go 版本。你只能从 Go 模块中使用它，因此你必须在开始之前初始化一个 Go 模块，或者将你的代码添加到现有的模块中：
go mod init github.com/my/repo
使用go get命令安装go-redis/v9：
go get github.com/redis/go-redis/v9
连接
以下示例展示了连接到Redis服务器的最简单方法：
import (
"context"
"fmt"
"github.com/redis/go-redis/v9"
)
func main() {
client := redis.NewClient(&redis.Options{
Addr: "localhost:6379",
Password: "", // No password set
DB: 0, // Use default DB
Protocol: 2, // Connection protocol
})
}
你也可以使用连接字符串进行连接：
opt, err := redis.ParseURL("redis://<user>:<pass>@localhost:6379/<db>")
if err != nil {
panic(err)
}
client := redis.NewClient(opt)
连接后，您可以通过存储和检索一个简单的字符串来测试连接：
ctx := context.Background()
err := client.Set(ctx, "foo", "bar", 0).Err()
if err != nil {
panic(err)
}
val, err := client.Get(ctx, "foo").Result()
if err != nil {
panic(err)
}
fmt.Println("foo", val)
您还可以轻松存储和检索一个哈希：
hashFields := []string{
"model", "Deimos",
"brand", "Ergonom",
"type", "Enduro bikes",
"price", "4972",
}
res1, err := rdb.HSet(ctx, "bike:1", hashFields).Result()
if err != nil {
panic(err)
}
fmt.Println(res1) // >>> 4
res2, err := rdb.HGet(ctx, "bike:1", "model").Result()
if err != nil {
panic(err)
}
fmt.Println(res2) // >>> Deimos
res3, err := rdb.HGet(ctx, "bike:1", "price").Result()
if err != nil {
panic(err)
}
fmt.Println(res3) // >>> 4972
res4, err := rdb.HGetAll(ctx, "bike:1").Result()
if err != nil {
panic(err)
}
fmt.Println(res4)
// >>> map[brand:Ergonom model:Deimos price:4972 type:Enduro bikes]
使用
结构体标签
形式的 redis:"<字段名称>" 与 Scan() 方法一起，将哈希中的字段直接解析到相应的结构体字段中：
type BikeInfo struct {
Model string `redis:"model"`
Brand string `redis:"brand"`
Type string `redis:"type"`
Price int `redis:"price"`
}
var res4a BikeInfo
err = rdb.HGetAll(ctx, "bike:1").Scan(&res4a)
if err != nil {
panic(err)
}
fmt.Printf("Model: %v, Brand: %v, Type: %v, Price: $%v\n",
res4a.Model, res4a.Brand, res4a.Type, res4a.Price)
// >>> Model: Deimos, Brand: Ergonom, Type: Enduro bikes, Price: $4972
可观测性
go-redis 支持 OpenTelemetry 检测。
用于监控性能并跟踪 Redis 命令的执行。
例如，以下代码检测 Redis 命令以收集跟踪、日志和指标：
import (
"github.com/redis/go-redis/v9"
"github.com/redis/go-redis/extra/redisotel/v9"
)
rdb := redis.NewClient(&redis.Options{...})
// Enable tracing instrumentation.
if err := redisotel.InstrumentTracing(rdb); err != nil {
panic(err)
}
// Enable metrics instrumentation.
if err := redisotel.InstrumentMetrics(rdb); err != nil {
panic(err)
}
查看 go-redis GitHub 仓库 以获取更多 OpenTelemetry 示例。