GoFrame入门教程 GoFrame NoSQL Redis-配置管理

2024-02-25 开发教程 GoFrame入门教程匿名 4℃

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`	否	`0`	`TCP`连接的超时时间，使用时间字符串例如`30s/1m/1d`
`readTimeout`	否	`0`	`TCP`的`Read`操作超时时间，使用时间字符串例如`30s/1m/1d`
`writeTimeout`	否	`0`	`TCP`的`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