Versions Compared
compared with
Key
- This line was added.
- This line was removed.
- Formatting was changed.
goframe框架支持两种方式来管理gredis组件支持两种方式来管理redis配置和获取redis对象，一种是通过配置文件+单例对象的方式；一种是模块化通过配置管理方法及对象创建方法。对象，一种是通过配置组件+单例对象的方式；一种是模块化通过配置管理方法及对象创建方法。
配置文件（推荐）
绝大部分情况下推荐使用g.Redis单例方式来操作redis。因此同样推荐使用配置文件来管理Redis配置，在config.yaml中的配置示例如下：
| Code Block | ||
|---|---|---|
| ||
# 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
# 集群模式配置方法
group:
address: 127.0.0.1:6379,127.0.0.1:6370
db: 1 |
各配置项说明如下：
| 配置项名称 | 是否必须 | 默认值 | 说明 |
|---|---|---|---|
| 是 | - | 格式： 支持
|
db | 否 | 0 | 数据库数据库索引 |
pass | 否 | - | 授权密码访问授权密码 |
| 否 | 0 | 允许闲置的最小连接数 |
maxIdle | 否 | 10 | 允许闲置的最大连接数(0表示不限制0表示不限制) |
maxActive | 否 | 100 | 最大连接数量限制(0表示不限制0表示不限制) |
idleTimeout | 否 | 10连接最大空闲时间(单位秒,不允许设置为0) | 连接最大空闲时间，使用时间字符串例如30s/1m/1d |
maxConnLifetime | 否 | 30连接最长存活时间(单位秒,不允许设置为0) | 连接最长存活时间，使用时间字符串例如30s/1m/1d |
| 否 | 0等待连接池连接的超时时间 | 等待连接池连接的超时时间，使用时间字符串例如30s/1m/1d |
| 否 | 0TCP连接的超时时间 | TCP连接的超时时间，使用时间字符串例如30s/1m/1d |
| 否 | 0TCP的Read操作超时时间 | TCP的Read操作超时时间，使用时间字符串例如30s/1m/1d |
| 否 | 0TCP的Write操作超时时间 | TCP的Write操作超时时间，使用时间字符串例如30s/1m/1d |
| 否 | - | 哨兵模式下使用, 设置MasterName |
tls | 否 | false是否使用TLS认证 | 是否使用TLS认证 |
| 否 | false通过TLS连接时，是否禁用服务器名称验证 | 通过TLS连接时，是否禁用服务器名称验证 |
使用示例：
| Code Block | ||
|---|---|---|
| ||
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 配置方法（高级）
由于gfGoFrame是模块化的框架，除了可以通过耦合且便捷的g模块来自动解析配置文件并获得单例对象之外，也支持有能力的开发者模块化使用gredis包。
gredis提供了全局的分组配置功能，相关配置管理方法如下：
| Code Block | ||
|---|---|---|
| ||
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 | ||
|---|---|---|
| ||
func Instance(name ...string) *Redis |
使用示例：
| Code Block | ||
|---|---|---|
| ||
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))
} |
| Panel | ||
|---|---|---|
| ||
|