gredis

    使用方式

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

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

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

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

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

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

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

    使用示例:

    1. package main
    2. import (
    3. "fmt"
    4. "github.com/gogf/gf/frame/g"
    5. "github.com/gogf/gf/util/gconv"
    6. )
    7. func main() {
    8. g.Redis().Do("SET", "k", "v")
    9. v, _ := g.Redis().Do("GET", "k")
    10. fmt.Println(gconv.String(v))
    11. }

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

    1. v

    配置方法

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

    1. func SetConfig(config Config, name ...string)
    2. func GetConfig(name ...string) (config Config, ok bool)
    3. func RemoveConfig(name ...string)
    4. func ClearConfig()

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

    1. func Instance(name ...string) *Redis

    使用示例:

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

    1. package main
    2. import (
    3. "github.com/gogf/gf/frame/g"
    4. "github.com/gogf/gf/util/gconv"
    5. )
    6. func main() {
    7. conn := g.Redis().Conn()
    8. conn.Do("SET", "k", "v")
    9. v, _ := conn.Do("GET", "k")
    10. fmt.Println(gconv.String(v))
    11. }

    执行后,输出结果为:

    1. v

    Send方法

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

    1. package main
    2. import (
    3. "fmt"
    4. "github.com/gogf/gf/frame/g"
    5. "github.com/gogf/gf/util/gconv"
    6. )
    7. func main() {
    8. conn := g.Redis().Conn()
    9. defer conn.Close()
    10. conn.Send("SET", "foo", "bar")
    11. conn.Send("GET", "foo")
    12. conn.Flush()
    13. // reply from SET
    14. conn.Receive()
    15. // reply from GET
    16. v, _ := conn.Receive()
    17. fmt.Println(gconv.String(v))
    18. }
    1. bar
    1. package main
    2. import (
    3. "fmt"
    4. "github.com/gogf/gf/frame/g"
    5. "github.com/gogf/gf/util/gconv"
    6. )
    7. func main() {
    8. conn := g.Redis().Conn()
    9. defer conn.Close()
    10. _, err := conn.Do("SUBSCRIBE", "channel")
    11. if err != nil {
    12. panic(err)
    13. }
    14. for {
    15. reply, err := conn.Receive()
    16. if err != nil {
    17. panic(err)
    18. fmt.Println(gconv.Strings(reply))
    19. }

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

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

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

    1. [message channel test]

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

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

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

    示例1,DoVar

    1. package main
    2. import (
    3. "fmt"
    4. "github.com/gogf/gf/frame/g"
    5. "github.com/gogf/gf/util/gconv"
    6. )
    7. func main() {
    8. conn := g.Redis().Conn()
    9. defer conn.Close()
    10. conn.Do("SET", "k", "v")
    11. v, _ := conn.DoVar("GET", "k")
    12. fmt.Println(v.String())
    13. }

    执行后,输出结果为:

    1. v
    1. package main
    2. import (
    3. "fmt"
    4. "github.com/gogf/gf/frame/g"
    5. )
    6. func main() {
    7. conn := g.Redis().Conn()
    8. defer conn.Close()
    9. _, err := conn.Do("SUBSCRIBE", "channel")
    10. if err != nil {
    11. panic(err)
    12. }
    13. for {
    14. reply, err := conn.ReceiveVar()
    15. if err != nil {
    16. panic(err)
    17. }
    18. fmt.Println(reply.Strings())
    19. }
    20. }

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

    1. $ redis-cli
    2. 127.0.0.1:6379> publish channel test

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