gredis组件支持两种方式来管理redis配置和获取redis对象,一种是通过配置组件+单例对象的方式;一种是模块化通过配置管理方法及对象创建方法。

配置文件(推荐)

绝大部分情况下推荐使用g.Redis单例方式来操作redis。因此同样推荐使用配置文件来管理Redis配置,在config.yaml中的配置示例如下:

单实例配置

  1. # Redis 配置示例
  2. redis:
  3. # 单实例配置示例1
  4. default:
  5. address: 127.0.0.1:6379
  6. db: 1
  7. # 单实例配置示例2
  8. cache:
  9. address: 127.0.0.1:6379
  10. db: 1
  11. pass: 123456
  12. idleTimeout: 600

其中的 defaultcache 分别表示配置分组名称,我们在程序中可以通过该名称获取对应配置的 redis 单例对象。不传递分组名称时,默认使用 redis.default 配置分组项)来获取对应配置的 redis 客户端单例对象。

集群化配置

  1. # Redis 配置示例
  2. redis:
  3. # 集群模式配置方法
  4. default:
  5. address: 127.0.0.1:6379,127.0.0.1:6370
  6. db: 1

配置项说明

配置项名称是否必须默认值说明

address

-

格式:地址:端口

支持Redis单实例模式和集群模式配置,使用,分割多个地址。例如:

192.168.1.1:6379, 192.168.1.2:6379

db0数据库索引
user-访问授权用户
pass-访问授权密码

minIdle

0允许闲置的最小连接数
maxIdle10允许闲置的最大连接数(0表示不限制)
maxActive100最大连接数量限制(0表示不限制)
idleTimeout10连接最大空闲时间,使用时间字符串例如30s/1m/1d
maxConnLifetime30连接最长存活时间,使用时间字符串例如30s/1m/1d

waitTimeout

0等待连接池连接的超时时间,使用时间字符串例如30s/1m/1d

dialTimeout

0TCP连接的超时时间,使用时间字符串例如30s/1m/1d

readTimeout

0TCPRead操作超时时间,使用时间字符串例如30s/1m/1d

writeTimeout

0TCPWrite操作超时时间,使用时间字符串例如30s/1m/1d

masterName

-哨兵模式下使用, 设置MasterName
tlsfalse是否使用TLS认证

tlsSkipVerify

false通过TLS连接时,是否禁用服务器名称验证
clusterfalse是否强制设置为集群工作模式。当address是单个endpoint的集群时,系统会自动判定为单实例模式,这时需要设置此项为true
protocol3设置与Redis Server通信的RESP协议版本。

使用示例:

config.yaml内容如下:

  1. # Redis 配置示例
  2. redis:
  3. # 单实例配置示例1
  4. default:
  5. address: 127.0.0.1:6379
  6. db: 1
  7. pass: "password" # 在此配置密码, 没有可去掉
  1. package main
  2. import (
  3. "fmt"
  4. _ "github.com/gogf/gf/contrib/nosql/redis/v2"
  5. "github.com/gogf/gf/v2/frame/g"
  6. "github.com/gogf/gf/v2/os/gctx"
  7. )
  8. func main() {
  9. var ctx = gctx.New()
  10. _, err := g.Redis().Set(ctx, "key", "value")
  11. if err != nil {
  12. g.Log().Fatal(ctx, err)
  13. }
  14. value, err := g.Redis().Get(ctx, "key")
  15. if err != nil {
  16. g.Log().Fatal(ctx, err)
  17. }
  18. fmt.Println(value.String())
  19. }

执行后,输出结果为:

  1. value

配置方法(高级)

由于GoFrame是模块化的框架,除了可以通过耦合且便捷的g模块来自动解析配置文件并获得单例对象之外,也支持有能力的开发者模块化使用gredis包。

gredis提供了全局的分组配置功能,相关配置管理方法如下:

  1. func SetConfig(config Config, name ...string)
  2. func SetConfigByMap(m map[string]interface{}, name ...string) error
  3. func GetConfig(name ...string) (config Config, ok bool)
  4. func RemoveConfig(name ...string)
  5. func ClearConfig()

使用示例:

  1. package main
  2. import (
  3. "fmt"
  4. _ "github.com/gogf/gf/contrib/nosql/redis/v2"
  5. "github.com/gogf/gf/v2/database/gredis"
  6. "github.com/gogf/gf/v2/frame/g"
  7. "github.com/gogf/gf/v2/os/gctx"
  8. )
  9. var (
  10. config = gredis.Config{
  11. Address: "127.0.0.1:6379",
  12. Db: 1,
  13. Pass: "password",
  14. }
  15. group = "cache"
  16. ctx = gctx.New()
  17. )
  18. func main() {
  19. gredis.SetConfig(&config, group)
  20. _, err := g.Redis(group).Set(ctx, "key", "value")
  21. if err != nil {
  22. g.Log().Fatal(ctx, err)
  23. }
  24. value, err := g.Redis(group).Get(ctx, "key")
  25. if err != nil {
  26. g.Log().Fatal(ctx, err)
  27. }
  28. fmt.Println(value.String())
  29. }