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

配置文件（推荐）

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

单实例配置

# Redis 配置示例
redis:
  # 单实例配置示例1
  default:
    address: 127.0.0.1:6379
    db:      1

  # 单实例配置示例2
  cache:
    address:     127.0.0.1:6379
    db:          1
    pass:        123456
    idleTimeout: 600

集群化配置

# Redis 配置示例
redis:
   # 集群模式配置方法
  group:	
    address: 127.0.0.1:6379,127.0.0.1:6370
    db:      1

配置项说明

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

address

是-

格式：地址:端口

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

192.168.1.1:6379, 192.168.1.2:6379

db否0数据库索引
pass否-访问授权密码

minIdle

否0允许闲置的最小连接数
maxIdle否10允许闲置的最大连接数(0表示不限制)
maxActive否100最大连接数量限制(0表示不限制)
idleTimeout否10连接最大空闲时间，使用时间字符串例如30s/1m/1d
maxConnLifetime否30连接最长存活时间，使用时间字符串例如30s/1m/1d

waitTimeout

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

dialTimeout

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

readTimeout

否0TCP的Read操作超时时间，使用时间字符串例如30s/1m/1d

writeTimeout

否0TCP的Write操作超时时间，使用时间字符串例如30s/1m/1d

masterName

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

tlsSkipVerify

否false通过TLS连接时，是否禁用服务器名称验证

使用示例：

func main() {
	var (
		ctx = context.Background()
	)
	conn, _ := g.Redis().Conn(ctx)
	conn.Do(ctx, "SET", "Key", "Value")
	v, _ := conn.Do(ctx, "GET", "Key")
	fmt.Println(v.String())
}

其中的 default 和 cache 分别表示配置分组名称，我们在程序中可以通过该名称获取对应配置的 redis 单例对象。不传递分组名称时，默认使用 redis.default 配置分组项)来获取对应配置的 redis 客户端单例对象。 执行后，输出结果为：

Value

配置方法（高级）

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

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

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

其中name参数为分组名称，即为通过分组来对配置对象进行管理，我们可以为不同的配置对象设置不同的分组名称，随后我们可以通过Instance单例方法获取redis客户端操作对象单例。

func Instance(name ...string) *Redis

使用示例：

package main

import (
	"context"
	"fmt"
	"github.com/gogf/gf/v2/database/gredis"
	"github.com/gogf/gf/v2/util/gconv"
)

var (
	config = gredis.Config{
		Address: "192.168.1.2:6379, 192.168.1.3:6379",
		Db   : 1,
	}
	ctx = context.Background()
)

func main() {
	group := "test"
	gredis.SetConfig(&config, group)

	redis := gredis.Instance(group)
	defer redis.Close(ctx)

	_, err := redis.Do(ctx, "SET", "k", "v")
	if err != nil {
		panic(err)
	}

	r, err := redis.Do(ctx, "GET", "k")
	if err != nil {
		panic(err)
	}
	fmt.Println(gconv.String(r))
}
Content Menu

  • No labels

4 Comments

  1. unite小伟

    key的过期时间是在哪里设置?

    1. aries

      g.Redis().Do("EXPIRE", key, timeout)



      1. gleke

        ttl,errTTL:=g.Redis().DoVar("TTL", prefixHash)
        if errTTL != nil {
           g.Log().Error(err)
           return false
        }
        g.Redis().DoVar("EXPIRE", prefixHash,2*24*time.Hour)
        ttl返回是-2，并不是-1  设置过期也没效果

  2. D.Rose

    你好，我将 redis 闲置的最小连接数设置为 4，为什么这四个闲置连接，永远不会被用到呢？


    fd=9 name= age=14 idle=14 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=0 obl=0 oll=0 omem=0 events=r cmd=NULL

    fd=11 name= age=14 idle=14 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=0 obl=0 oll=0 omem=0 events=r cmd=NULL

    fd=14 name= age=14 idle=14 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=0 obl=0 oll=0 omem=0 events=r cmd=NULL

    fd=12 name= age=14 idle=14 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=0 obl=0 oll=0 omem=0 events=r cmd=NULL

    fd=10 name= age=14 idle=3 flags=N db=0 sub=0 psub=0 multi=-1 qbuf=0 qbuf-free=0 obl=0 oll=0 omem=0 events=r cmd=get


    我执行的命令，都会再重新创建啊一个连接，那 4 个闲置连接，好像用于都不会被使用，是我的配置有问题吗？


    minIdle:          "4"   # 允许闲置的最小连接数
    maxIdle:          "8"  # 允许闲置的最大连接数(0表示不限制)
    maxActive:        "16" # 最大连接数量限制(0表示不限制)
    idleTimeout:      "30m"  # 连接最大空闲时间，使用时间字符串例如30s/1m/1d

    @郭强