Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Do

Set/

DoVar方法

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

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

Conn连接对象

Get操作

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

Note

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

基本使用

Code Block
languagego
package main

import (
	"fmt"

	_ "github.com/gogf/gf/contrib/nosql/redis/v2"

	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/v2/
util
os/
gconv
gctx"
)

func main() {
	var ctx = 
conn
gctx.New()
	_, err := g.Redis().
Conn(
Set(ctx, "key", "value")
	if err != 
defer conn.Close() conn.Do("SET", "k", "v") v, _ := conn.Do("GET", "k") fmt.Println(gconv.String(v)) }

执行后,输出结果为:

v

Send方法

Send可以执行批量指令,并通过Receive方法一一获取返回结果。
nil {
		g.Log().Fatal(ctx, err)
	}
	value, err := g.Redis().Get(ctx, "key")
	if err != nil {
		g.Log().Fatal(ctx, err)
	}
	fmt.Println(value.String())
}

执行后,终端输出:

Code Block
languagexml
value

SetEx操作

Code Block
languagego
package main

import (
	"fmt"
	"time"

	_ "github.com/gogf/gf/contrib/nosql/redis/v2"

	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/
util
v2/os/
gconv
gctx"
)

func main() {
conn :
	var ctx = 
g.Redis().Conn
gctx.New()
	err 
defer conn.Close() conn.Send("SET"
:= g.Redis().SetEX(ctx, "
foo
key", "
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/frame/g" "github.com/gogf/gf/util/gconv" ) func main() { conn := g.Redis().Conn() defer conn.Close() _, err := conn.Do("SUBSCRIBE", "channel")
value", 1)
	if err != nil {
		g.Log().Fatal(ctx, err)
	}
	value, err := g.Redis().Get(ctx, "key")
	if err != nil {
		g.Log().Fatal(ctx, err)
	}
	fmt.Println(value.IsNil())
	fmt.Println(value.String())

	time.Sleep(time.Second)

	value, err = g.Redis().Get(ctx, "key")
	if err != nil {
panic(
		g.Log().Fatal(ctx, err)
} for { reply, err := conn.Receive() if err != nil { panic(err) } fmt.Println(gconv.Strings(reply)) } }
	}
	fmt.Println(value.IsNil())
	fmt.Println(value.Val())
}

执行后,终端输出:

Code Block
languagexml
false
value
true
<nil>

HSet/HGetAll操作

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

另外打开一个终端通过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存取

Code Block
languagego
package main

import (
	"fmt"

	_ "github.com/gogf/gf/contrib/
container
nosql/redis/
gvar
v2"

	"github.com/gogf/gf/v2/frame/g"
	"github.com/gogf/gf/v2/os/gctx"
)

func main() {
	var (
		
err
ctx 
error result *gvar.Var
= gctx.New()
		key
 
= "
user
key"
	)
	
data
_, err 
=
:= g.Redis().HSet(ctx, key, g.Map{
		
"id":   
10000
 1,
		
"name":  "john",
		"score": 100,
	})
	if err != nil {
		g.Log().Fatal(ctx, err)
	}

	// retrieve hash map
	
_
value, err := g.Redis().
Do
HGetAll(
"SET"
ctx, key
, data
)
	if err != nil {
		
panic(err) } result,
g.Log().Fatal(ctx, err)
	}
	fmt.Println(value.Map())

	// scan to struct
	type User struct {
		Id    uint64
		Name  string
		Score float64
	}
	var user *User
	if err = 
g
value.
Redis
Scan(
).DoVar("GET", key) if
&user); err != nil {
		
panic(
g.Log().Fatal(ctx, err)
	}
	
fmt
g.
Println(result.Map()) }
Dump(user)
}

执行后,终端输出:

Code Block
languagexml
map[id:1 name:john score:100]
{
    Id:    1,
    Name:  "john",
    Score: 100,
}

HMSet/HMGet操作

Code Block
languagego
struct存取
package main

import (
	
"fmt"
_ "github.com/gogf/gf/contrib/nosql/redis/v2"

	"github.com/gogf/gf/v2/
container
frame/
gvar
g"
	"github.com/gogf/gf/v2/
frame
os/
g
gctx"
)

func main() {
	
type User struct { Id int Name string }
var (
		
err
ctx 
error result *gvar.Var
= gctx.New()
		key
 = "
user
key"
	)
	
user
err := 
= &User
g.Redis().HMSet(ctx, key, g.Map{
		
Id
"id":   
10000
 1,
		
Name
"name":  "john",
}

	
)
	
_, err = g.Redis().Do("SET", key, user
"score": 100,
	})
	if err != nil {
		
panic(
g.Log().Fatal(ctx, err)
	}

	
result
// retrieve hash map
	values, err := g.Redis().
DoVar("GET
HMGet(ctx, key, "id", 
key
"name")
	if err != nil {
		
panic(
g.Log().Fatal(ctx, err)
	}
	g.Dump(values.Strings())
var user2 *User if err = result.Struct(&user2); err != nil { panic(err) } fmt.Println(user2.Id, user2.Name) }
}

执行后,终端输出:

Code Block
languagexml
[
    "1",
    "john",
]

As per Redis 4.0.0, HMSET is considered deprecated. Please use HSET in new code.

根据Redis 4.0.0HMSET被视为已弃用。请在新代码中使用HSET






Panel
titleContent Menu

Table of Contents