Searching...

[TOC]

gredis

Redis客户端由gredis模块实现,底层采用了链接池设计。

目前gredis暂不支持redis集群功能。

使用方式

import "github.com/gogf/gf/g/database/gredis"

接口文档https://godoc.org/github.com/gogf/gf/g/database/gredis

gredis使用了连接池来进行Redis连接管理,通过Config配置对象或者Set*方法可以对连接池的属性进行管理,通过Stats方法可以获取连接池的统计信息。

我们最常用的方法是Do方法,执行同步指令,通过向Redis Server发送对应的Redis API命令,来使用Redis Server的服务。Do方法最大的特点是内部自行从连接池中获取连接对象,使用完毕后自动丢回连接池中,开发者无序手动调用Close方法,方便使用。

gredis.Redis客户端对象提供了一个Close方法,该方法是关闭Redis客户端(同时关闭客户端的连接池),而不是连接对象,开发者基本不会用到,非高级玩家请不要使用。

Redis配置

配置文件

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

# Redis数据库配置
[redis]
    default = "127.0.0.1:6379,0"
    cache   = "127.0.0.1:6379,1,123456?idleTimeout=600"

其中,Redis的配置格式为:host:port[,db,pass?maxIdle=x&maxActive=x&idleTimeout=x&maxConnLifetime=x]

各配置项说明如下:

配置项名称 是否必须 默认值 说明
host - 地址
port - 端口
db 0 数据库
pass - 授权密码
maxIdle 0 允许限制的连接数(0表示不闲置)
maxActive 0 最大连接数量限制(0表示不限制)
idleTimeout 60 连接最大空闲时间(单位秒,不允许设置为0)
maxConnLifetime 60 连接最长存活时间(单位秒,不允许设置为0)

使用示例:

package main

import (
    "fmt"
    "github.com/gogf/gf/g"
    "github.com/gogf/gf/g/util/gconv"
)

func main() {
    g.Redis().Do("SET", "k", "v")
    v, _ := g.Redis().Do("GET", "k")
    fmt.Println(gconv.String(v))
}

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

v

配置方法

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

func SetConfig(config Config, name ...string)
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 (
	"fmt"
	"github.com/gogf/gf/g/database/gredis"
	"github.com/gogf/gf/g/util/gconv"
)

var (
	config = gredis.Config{
		Host : "127.0.0.1",
		Port : 6379,
		Db   : 1,
	}
)

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

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

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

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

使用Conn

使用Do方法已经能够满足绝大部分的场景需要,如果需要更复杂的Redis操作,那么我们可以使用Conn方法从连接池中获取一个连接对象,随后使用该连接对象进行操作。但需要注意的是,该连接对象不再使用时,应当显示调用Close方法进行关闭(丢回连接池)。

基本使用

package main

import (
    "fmt"
    "github.com/gogf/gf/g"
    "github.com/gogf/gf/g/util/gconv"
)

func main() {
    conn := g.Redis().Conn()
    defer conn.Close()
    conn.Do("SET", "k", "v")
    v, _ := conn.Do("GET", "k")
    fmt.Println(gconv.String(v))
}

执行后,输出结果为:

v

Send方法

Send可以执行批量指令,并通过Receive方法一一获取返回结果。

package main

import (
    "fmt"
    "github.com/gogf/gf/g"
    "github.com/gogf/gf/g/util/gconv"
)

func main() {
    conn := g.Redis().Conn()
    defer conn.Close()
    conn.Send("SET", "foo", "bar")
    conn.Send("GET", "foo")
    conn.Flush()
    // reply from SET
    conn.Receive()
    // reply from GET
    v, _ := conn.Receive()
    fmt.Println(gconv.String(v))
}

执行后,输出结果为:

bar

订阅/发布

package main

import (
    "fmt"
    "github.com/gogf/gf/g"
    "github.com/gogf/gf/g/util/gconv"
)

func main() {
    conn := g.Redis().Conn()
    defer conn.Close()
    _, err := conn.Do("SUBSCRIBE", "channel")
    if err != nil {
        panic(err)
    }
    for {
        reply, err := conn.Receive()
        if err != nil {
            panic(err)
        }
        fmt.Println(gconv.Strings(reply))
    }
}

执行后,程序将阻塞等待获取数据。

另外打开一个终端通过redis-cli命令进入Redis Server,发布一条消息:

$ redis-cli
127.0.0.1:6379> publish channel test
(integer) 1
127.0.0.1:6379>

随后程序终端立即打印出从Redis Server获取的数据:

[message channel test]

结果处理

可以看到通过客户端方法Do/Receive获取的数据都是二进制形式[]byte的,需要开发者手动进行数据转换。

当然,gredis模块也提供了DoVar/ReceiveVar方法,用以获取可供方便转换的gvar.Var通用变量结果。

通过gvar.Var的强大转换功能可以转换为任意的数据类型,如基本数据类型Int,String,Strings,或者结构体Struct等等。

示例1,DoVar

package main

import (
    "fmt"
    "github.com/gogf/gf/g"
    "github.com/gogf/gf/g/util/gconv"
)

func main() {
    conn := g.Redis().Conn()
    defer conn.Close()
    conn.Do("SET", "k", "v")
    v, _ := conn.DoVar("GET", "k")
    fmt.Println(v.String())
}

执行后,输出结果为:

v

示例2,ReceiveVar

package main

import (
	"fmt"
	"github.com/gogf/gf/g"
)

func main() {
	conn := g.Redis().Conn()
	defer conn.Close()
	_, err := conn.Do("SUBSCRIBE", "channel")
	if err != nil {
		panic(err)
	}
	for {
		reply, err := conn.ReceiveVar()
		if err != nil {
			panic(err)
		}
		fmt.Println(reply.Strings())
	}
}

执行后,程序将阻塞等待获取数据。

另外打开一个终端通过redis-cli命令进入Redis Server,发布一条消息:

$ redis-cli
127.0.0.1:6379> publish channel test
(integer) 1
127.0.0.1:6379>

随后程序终端立即打印出从Redis Server获取的数据:

[message channel test]