Gin 系列教程 (03)-使用Redis

Gin框架中使用Redis

Redis是一种高性能的键值对存储数据库，广泛用于缓存、会话管理、消息队列等场景。在Gin框架中使用Redis可以显著提升应用程序的性能。

一、安装Redis驱动

首先，我们需要安装Go语言的Redis驱动。推荐使用go-redis/redis库，它提供了丰富的API和良好的性能。

1	`go get github.com/go-redis/redis/v8`

二、基本连接

1. 简单连接

package main

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

func main() {
	// 创建Redis客户端
	client := redis.NewClient(&redis.Options{
		Addr:     "localhost:6379",  // Redis地址
		Password: "",               // 密码（无密码时为空）
		DB:       0,                // 使用默认数据库
	})

	// 测试连接
	ctx := context.Background()
	pong, err := client.Ping(ctx).Result()
	if err != nil {
		panic(err)
	}
	fmt.Println(pong) // 输出: PONG
}

2. 连接池配置

package main

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

func main() {
	client := redis.NewClient(&redis.Options{
		Addr:         "localhost:6379",
		Password:     "",
		DB:           0,
		PoolSize:     10,                // 连接池大小
		MinIdleConns: 5,                 // 最小空闲连接数
		MaxIdleConns: 10,                // 最大空闲连接数
		IdleTimeout:  5 * time.Minute,   // 空闲连接超时时间
		ReadTimeout:  3 * time.Second,   // 读取超时时间
		WriteTimeout: 3 * time.Second,   // 写入超时时间
		PoolTimeout:  4 * time.Second,   // 连接池超时时间
	})

	ctx := context.Background()
	fmt.Println(client.Ping(ctx).Result())
}

三、在Gin框架中的实际应用

1. 初始化Redis客户端

创建一个专门的包来管理Redis连接：

// pkg/redis/redis.go
package redis

import (
	"context"
	"github.com/go-redis/redis/v8"
	"log"
	"time"
)

var Client *redis.Client

func InitRedis() {
	Client = redis.NewClient(&redis.Options{
		Addr:         "localhost:6379",
		Password:     "",
		DB:           0,
		PoolSize:     10,
		MinIdleConns: 5,
		IdleTimeout:  5 * time.Minute,
	})

	ctx := context.Background()
	_, err := Client.Ping(ctx).Result()
	if err != nil {
		log.Fatalf("Failed to connect to Redis: %v", err)
	}

	log.Println("Connected to Redis successfully")
}

2. 缓存中间件

创建一个Gin中间件来自动缓存API响应：

// middleware/cache.go
package middleware

import (
	"context"
	"encoding/json"
	"github.com/gin-gonic/gin"
	"github.com/go-redis/redis/v8"
	"net/http"
	"time"
)

const CachePrefix = "api_cache:"

func Cache(duration time.Duration, redisClient *redis.Client) gin.HandlerFunc {
	return func(c *gin.Context) {
		key := CachePrefix + c.Request.URL.String()

		// 尝试从缓存中获取数据
		ctx := context.Background()
		cachedData, err := redisClient.Get(ctx, key).Result()

		if err == nil {
			// 缓存命中，直接返回
			var response interface{}
			json.Unmarshal([]byte(cachedData), &response)
			c.JSON(http.StatusOK, gin.H{
				"code":    200,
				"message": "success (cached)",
				"data":    response,
			})
			c.Abort()
			return
		}

		// 缓存未命中，继续处理请求
		c.Next()

		// 如果响应是成功的，缓存结果
		if c.Writer.Status() == http.StatusOK {
			if data, exists := c.Get("response_data"); exists {
				dataBytes, _ := json.Marshal(data)
				redisClient.Set(ctx, key, string(dataBytes), duration)
			}
		}
	}
}

3. 会话管理

使用Redis存储用户会话：

// pkg/session/session.go
package session

import (
	"context"
	"crypto/rand"
	"encoding/base64"
	"github.com/go-redis/redis/v8"
	"time"
)

const SessionPrefix = "session:"

type Session struct {
	ID        string
	UserID    uint
	CreatedAt time.Time
	ExpiresAt time.Time
}

func GenerateSessionID() (string, error) {
	b := make([]byte, 32)
	_, err := rand.Read(b)
	if err != nil {
		return "", err
	}
	return base64.URLEncoding.EncodeToString(b), nil
}

func CreateSession(ctx context.Context, userID uint, redisClient *redis.Client) (*Session, error) {
	id, err := GenerateSessionID()
	if err != nil {
		return nil, err
	}

	session := &Session{
		ID:        id,
		UserID:    userID,
		CreatedAt: time.Now(),
		ExpiresAt: time.Now().Add(24 * time.Hour), // 会话有效期24小时
	}

	// 存储到Redis
	key := SessionPrefix + id
	err = redisClient.Set(ctx, key, userID, 24*time.Hour).Err()
	if err != nil {
		return nil, err
	}

	return session, nil
}

func GetSession(ctx context.Context, sessionID string, redisClient *redis.Client) (*Session, error) {
	key := SessionPrefix + sessionID
	userID, err := redisClient.Get(ctx, key).Uint64()
	if err == redis.Nil {
		return nil, nil // 会话不存在
	} else if err != nil {
		return nil, err
	}

	return &Session{
		ID:        sessionID,
		UserID:    uint(userID),
		CreatedAt: time.Now(), // 实际应用中应存储创建时间
		ExpiresAt: time.Now().Add(24 * time.Hour),
	}, nil
}

func DeleteSession(ctx context.Context, sessionID string, redisClient *redis.Client) error {
	key := SessionPrefix + sessionID
	return redisClient.Del(ctx, key).Err()
}

4. 缓存API响应

// handlers/user.go
package handlers

import (
	"context"
	"github.com/gin-gonic/gin"
	"github.com/go-redis/redis/v8"
	"net/http"
	"time"
)

type User struct {
	ID   uint   `json:"id"`
	Name string `json:"name"`
	Age  int    `json:"age"`
}

func GetUser(c *gin.Context) {
	ctx := context.Background()
	redisClient := c.MustGet("redis_client").(*redis.Client)

	// 模拟数据库查询
	user := User{
		ID:   1,
		Name: "张三",
		Age:  30,
	}

	// 存储到上下文以便中间件缓存
	c.Set("response_data", user)

	c.JSON(http.StatusOK, gin.H{
		"code":    200,
		"message": "success",
		"data":    user,
	})
}

func GetUsers(c *gin.Context) {
	ctx := context.Background()
	redisClient := c.MustGet("redis_client").(*redis.Client)

	// 模拟数据库查询
	users := []User{
		{ID: 1, Name: "张三", Age: 30},
		{ID: 2, Name: "李四", Age: 25},
		{ID: 3, Name: "王五", Age: 35},
	}

	c.Set("response_data", users)

	c.JSON(http.StatusOK, gin.H{
		"code":    200,
		"message": "success",
		"data":    users,
	})
}

5. 主程序

// main.go
package main

import (
	"github.com/gin-gonic/gin"
	"github.com/hawkli-1994/myblog/handlers"
	"github.com/hawkli-1994/myblog/middleware"
	"github.com/hawkli-1994/myblog/pkg/redis"
	"time"
)

func main() {
	// 初始化Redis
	redis.InitRedis()

	// 创建Gin实例
	r := gin.Default()

	// 将Redis客户端存入上下文
	r.Use(func(c *gin.Context) {
		c.Set("redis_client", redis.Client)
		c.Next()
	})

	// 测试路由
	r.GET("/ping", func(c *gin.Context) {
		c.JSON(200, gin.H{
			"message": "pong",
		})
	})

	// 缓存中间件示例
	userGroup := r.Group("/api/users")
	{
		// 5分钟缓存
		userGroup.GET("/:id", middleware.Cache(5*time.Minute, redis.Client), handlers.GetUser)
		// 10分钟缓存
		userGroup.GET("", middleware.Cache(10*time.Minute, redis.Client), handlers.GetUsers)
	}

	// 启动服务器
	r.Run(":8080")
}

四、常见Redis操作

1. 字符串操作

package main

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

func main() {
	ctx := context.Background()
	client := redis.NewClient(&redis.Options{Addr: "localhost:6379"})

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

	// 获取值
	val, err := client.Get(ctx, "key").Result()
	if err != nil {
		panic(err)
	}
	fmt.Println("key:", val)

	// 设置带过期时间的键
	err = client.Set(ctx, "temp_key", "temp_value", 10*time.Second).Err()

	// 递增
	client.Incr(ctx, "counter")
	cnt, _ := client.Get(ctx, "counter").Int64()
	fmt.Println("counter:", cnt)
}

2. 哈希操作

func main() {
	ctx := context.Background()
	client := redis.NewClient(&redis.Options{Addr: "localhost:6379"})

	// 设置哈希字段
	client.HSet(ctx, "user:1", "name", "张三")
	client.HSet(ctx, "user:1", "age", "30")
	client.HSet(ctx, "user:1", "email", "zhangsan@example.com")

	// 获取哈希字段
	name, _ := client.HGet(ctx, "user:1", "name").Result()
	age, _ := client.HGet(ctx, "user:1", "age").Int()
	fmt.Printf("User: %s, Age: %d\n", name, age)

	// 获取所有字段
	allFields, _ := client.HGetAll(ctx, "user:1").Result()
	for key, value := range allFields {
		fmt.Printf("%s: %s\n", key, value)
	}
}

3. 列表操作

func main() {
	ctx := context.Background()
	client := redis.NewClient(&redis.Options{Addr: "localhost:6379"})

	// 添加元素到列表
	client.LPush(ctx, "queue", "task1")
	client.LPush(ctx, "queue", "task2")
	client.RPush(ctx, "queue", "task3")

	// 获取列表长度
	length, _ := client.LLen(ctx, "queue").Result()
	fmt.Println("Queue length:", length)

	// 弹出元素
	task, _ := client.RPop(ctx, "queue").Result()
	fmt.Println("Processed task:", task)
}

4. 集合操作

func main() {
	ctx := context.Background()
	client := redis.NewClient(&redis.Options{Addr: "localhost:6379"})

	// 添加成员
	client.SAdd(ctx, "tags", "golang")
	client.SAdd(ctx, "tags", "redis")
	client.SAdd(ctx, "tags", "gin")

	// 获取所有成员
	tags, _ := client.SMembers(ctx, "tags").Result()
	fmt.Println("Tags:", tags)

	// 检查成员是否存在
	isMember, _ := client.SIsMember(ctx, "tags", "golang").Result()
	fmt.Println("Is 'golang' a tag?", isMember)

	// 获取集合大小
	size, _ := client.SCard(ctx, "tags").Result()
	fmt.Println("Tag count:", size)
}

五、错误处理最佳实践

1. 连接错误处理

func main() {
	client := redis.NewClient(&redis.Options{Addr: "invalid:6379"})

	ctx := context.Background()
	_, err := client.Ping(ctx).Result()

	if err != nil {
		switch {
		case redis.ErrClosedConn == err:
			fmt.Println("Connection closed")
		case err.Error() == "dial tcp: lookup invalid: no such host":
			fmt.Println("Invalid address")
		default:
			fmt.Printf("Unknown error: %v", err)
		}
	}
}

2. 命令执行错误

func main() {
	ctx := context.Background()
	client := redis.NewClient(&redis.Options{Addr: "localhost:6379"})

	// 尝试获取不存在的键
	_, err := client.Get(ctx, "nonexistent_key").Result()

	if err == redis.Nil {
		fmt.Println("Key does not exist")
	} else if err != nil {
		fmt.Printf("Error: %v", err)
	}
}

3. 超时处理

func main() {
	ctx := context.Background()
	client := redis.NewClient(&redis.Options{
		Addr:     "localhost:6379",
		Password: "",
		DB:       0,
	})

	// 设置超时上下文
	timeoutCtx, cancel := context.WithTimeout(ctx, 2*time.Second)
	defer cancel()

	_, err := client.Get(timeoutCtx, "slow_operation").Result()

	if err == context.DeadlineExceeded {
		fmt.Println("Operation timed out")
	} else if err != nil {
		fmt.Printf("Error: %v", err)
	}
}

六、性能优化建议

1. 连接池配置

根据应用程序的并发数调整PoolSize
保持适当的MinIdleConns以避免频繁创建连接
合理设置IdleTimeout以释放空闲连接

2. 命令优化

避免使用O(N)复杂度的命令（如KEYS、HGETALL）
尽可能使用管道（Pipeline）减少网络往返
使用MGET、MSET等批量操作

3. 数据结构选择

根据场景选择合适的数据结构
使用字符串存储简单值
使用哈希存储对象
使用列表作为队列
使用集合进行去重
使用有序集合实现排行榜

4. 内存优化

使用过期时间自动清理数据
压缩大值
避免存储重复数据

七、生产环境部署

1. 安全配置

client := redis.NewClient(&redis.Options{
	Addr:     "localhost:6379",
	Password: "strong_password", // 生产环境必须设置密码
	DB:       0,
	// 启用TLS
	TLSConfig: &tls.Config{
		MinVersion: tls.VersionTLS12,
	},
})

2. 监控与调优

启用Redis慢查询日志
使用INFO命令监控服务器状态
使用MONITOR命令调试
使用redis-cli的–stat选项监控性能

3. 高可用性

使用Redis Sentinel实现故障转移
使用Redis Cluster实现分布式存储
定期备份数据

八、总结

在Gin框架中使用Redis可以显著提升应用程序的性能和响应速度。通过合理配置连接池、使用缓存中间件、管理会话以及正确处理常见错误，开发者可以构建出高效稳定的Web应用程序。

Redis提供了丰富的数据结构和功能，适用于多种场景。了解并正确使用这些功能，可以让您的应用程序更加高效和可扩展。

Golang

#Go #gin教程 #Redis

Gin 系列教程 (03)-使用Redis

https://www.krli.org/2018/04/03/Gin-系列教程-03-使用Redis/

作者

李科燃

发布于

2018年4月3日

许可协议

设计模式(01)-简单工厂模式的 Python 实现与工程边界上一篇

Gin 系列教程 (02)：Go 里的数据库访问层该怎么选下一篇