GoFrame gredis缓存DoVar

时间:2022-06-19 王中阳Go 人气:2

前言

上一篇文章为大家介绍了 GoFrame gcache使用实践 | 缓存控制淘汰策略，得到了大家积极的反馈。

后续几篇文章再接再厉，仍然为大家介绍GoFrame框架缓存相关的知识点，以及自己项目使用中的一些总结思考，GoFrame框架下文简称gf。

这篇文章比较硬核，爆肝2千字，阅读大约需要5~8分钟。

详细的介绍了gredis的使用，包括：Do/DoVar方法的使用及区别、复杂场景下使用Conn方法从连接池中获取一个redis连接对象、当给定的参数为map, slice, struct时，gredis内部支持自动对其使用json序列化，并且读取数据时可使用gvar.Var的转换功能实现反序列化。

GoFrame gredis

整体介绍

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

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

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

Do/DoVar方法

我们最常用的是Do/DoVar方法，执行同步指令，通过向Redis Server发送对应的Redis API命令，来使用Redis Server的服务。

Do/Var方法最大的特点是内部自行从连接池中获取连接对象，使用完毕后自动丢回连接池中，开发者无需手动调用Close方法，方便使用。

小技巧

Do和DoVar的区别在于返回的结果类型不一样，DoVar返回的是gvar.Var类型，该类型对象可以执行非常方便的类型转换。

gvar.Var类型就像go原生提供的interface一样，要了解更多的可以查看这篇文章：GoFrame 通用类型变量gvar | 对比 interface{}

基本使用

package main
import (
	"fmt"
	"github.com/gogf/gf/frame/g"
)
func main() {
	g.Redis().Do("SET", "k", "v")
	v, _ := g.Redis().DoVar("GET", "k")
	fmt.Println(v.String())
}

HSET/HGETALL操作

Hset 命令用于为哈希表中的字段赋值。

如果哈希表不存在，一个新的哈希表被创建并进行 HSET 操作。

如果字段已经存在于哈希表中，旧值将被覆盖。

package main
import (
	"fmt"
	"github.com/gogf/gf/container/gvar"
	"github.com/gogf/gf/frame/g"
)
func main() {
	var (
		err    error
		result *gvar.Var
		key    = "user"
	)
	_, err = g.Redis().Do("HSET", key, "id", 10000)
	if err != nil {
		panic(err)
	}
	_, err = g.Redis().Do("HSET", key, "name", "王中阳")
	if err != nil {
		panic(err)
	}
	result, err = g.Redis().DoVar("HGETALL", key)
	if err != nil {
		panic(err)
	}
	fmt.Println(result.Map()) //打印结果： map[id:10000 name:王中阳]
}

HMSET/HMGET操作

强烈推荐，非常好用：我们可以通过map参数执行HMSET操作。

package main
import (
	"fmt"
	"github.com/gogf/gf/frame/g"
	"github.com/gogf/gf/util/gutil"
)
func main() {
	var (
		key  = "user_100"
		data = g.Map{
			"name":  "王中阳",
			"sex":   0,
			"score": 100,
		}
	)
	_, err := g.Redis().Do("HMSET", append(g.Slice{key}, gutil.MapToSlice(data)...)...)
	if err != nil {
		g.Log().Fatal(err)
	}
	v, err := g.Redis().DoVar("HMGET", key, "name")
	if err != nil {
		g.Log().Fatal(err)
	}
	fmt.Println(v.Slice())  //打印结果 [王中阳]
}

我们也可以通过struct参数执行HMSET操作。

package main
import (
	"fmt"
	"github.com/gogf/gf/frame/g"
	"github.com/gogf/gf/util/gutil"
)
func main() {
	type User struct {
		Name  string `json:"name"`
		Sex   int    `json:"sex"`
		Score int    `json:"score"`
	}
	var (
		key  = "user_100"
		data = &amp;User{
			Name:  "王中阳",
			Sex:   0,
			Score: 100,
		}
	)
	_, err := g.Redis().Do("HMSET", append(g.Slice{key}, gutil.StructToSlice(data)...)...)
	if err != nil {
		g.Log().Fatal(err)
	}
	v, err := g.Redis().DoVar("HMGET", key, "name")
	if err != nil {
		g.Log().Fatal(err)
	}
	fmt.Println(v.Slice()) //打印结果： [王中阳]
}

Conn连接对象

使用Do/DoVar方法已经能够满足绝大部分的场景需要，如果需要更复杂的Redis操作，我们可以使用Conn方法从连接池中获取一个连接对象，随后使用该连接对象进行操作。

需要注意的是，该连接对象不再使用时，应当显式调用Close方法进行关闭（丢回连接池）。

由于该Conn是个连接对象，注意该对象存在连接超时的限制，超时和服务端配置有关。

基本使用

package main
import (
    "fmt"
    "github.com/gogf/gf/frame/g"
    "github.com/gogf/gf/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/frame/g"
    "github.com/gogf/gf/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
}

让我想到了之前写的一篇爆文：Redis 如何批量设置过期时间？PIPLINE的使用

订阅/发布

我们可以通过Redis的SUBSCRIBE/PUBLISH命令实现订阅/发布模式。

package main
import (
    "fmt"
    "github.com/gogf/gf/frame/g"
    "github.com/gogf/gf/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]

自动序列化/反序列化

当给定的参数为map, slice, struct时，gredis内部支持自动对其使用json序列化，并且读取数据时可使用gvar.Var的转换功能实现反序列化。

map存取

package test
import (
   "fmt"
   "github.com/gogf/gf/container/gvar"
   "github.com/gogf/gf/frame/g"
)
func Run1() {
   var (
      err    error
      result *gvar.Var
      key    = "test_user"
      data   = g.Map{
         "id":   7,
         "name": "王中阳",
      }
   )
   _, err = g.Redis().Do("SET", key, data)
   if err != nil {
      panic(err)
   }
   result, err = g.Redis().DoVar("GET", key)
   if err != nil {
      panic(err)
   }
   fmt.Println("result:", result) //result: {"id":7,"name":"王中阳"}
   fmt.Println("result.Map():", result.Map()) //result.Map(): map[id:7 name:王中阳]
}

打印结果

struct存取

package test
import (
   "fmt"
   "github.com/gogf/gf/container/gvar"
   "github.com/gogf/gf/frame/g"
)
func Run1() {
   type User struct {
      Id   int
      Name string
   }
   var (
      err    error
      result *gvar.Var
      key    = "test_user"
      user   = &amp;User{
         Id:   007,
         Name: "王中阳",
      }
   )
   _, err = g.Redis().Do("SET", key, user)
   if err != nil {
      panic(err)
   }
   result, err = g.Redis().DoVar("GET", key)
   if err != nil {
      panic(err)
   }
   var user2 *User
   if err = result.Struct(&amp;user2); err != nil {
      panic(err)
   }
   fmt.Println("user2:", user2) //user2: &amp;{7 王中阳}
   fmt.Printf("id:%v, name:%v \n", user2.Id, user2.Name) //id:7, name:王中阳
}

打印结果

总结

详细的介绍了gredis的使用，包括：Do/DoVar方法的使用及区别、复杂场景下使用Conn方法从连接池中获取一个redis连接对象、当给定的参数为map, slice, struct时，gredis内部支持自动对其使用json序列化，并且读取数据时可使用gvar.Var的转换功能实现反序列化，更多关于GoFrame gredis DoVar Conn连接对象自动序列化的资料请关注其它相关文章！

加载全部内容