Versions Compared

Old Version 13

changes.mady.by.user 黄骞

Saved on

compared with

New Version 14

changes.mady.by.user 黄骞

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

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

配置文件（推荐）

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

Code Block
languageyml
# Redis数据库配置
redis:
  default:
    address: 127.0.0.1:6379
    db: 1
  cache:
    address: 127.0.0.1:6379
    db: 1
    pass: 123456
    idleTimeout: 600
  group:	# 集群模式配置方法
    address: 127.0.0.1:6379,127.0.0.1:6370
    db: 1

各配置项说明如下：

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

address

是-

地址+端口. 使用:分割地址和端口。支持单个和集群配置，使用,分割多个地址。

eg:192.168.1.1:6379, 192.168.1.2:6379

db否0数据库
pass否-授权密码

minIdle

否0允许闲置的最小连接数
maxIdle否10允许闲置的最大连接数(0表示不限制)
maxActive否100最大连接数量限制(0表示不限制)
idleTimeout否10连接最大空闲时间(单位秒,不允许设置为0)
maxConnLifetime否30连接最长存活时间(单位秒,不允许设置为0)

waitTimeout

否0等待连接池连接的超时时间

dialTimeout

否0TCP连接的超时时间

readTimeout

否0TCP的Read操作超时时间

writeTimeout

否0TCP的Write操作超时时间

masterName

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

tlsSkipVerify

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

使用示例：

Code Block
languagego
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

配置方法（高级）

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

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

Code Block
languagego
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客户端操作对象单例。

Code Block
languagego
func Instance(name ...string) *Redis

使用示例：

Code Block
languagego
package main

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

var (
	config = gredis.Config{
		Address: "127.0.0.1192.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))
}



Panel
titleContent Menu

Table of Contents