golang 操作redis大全

# 相关

redis 命令中文手册 https://redis.com.cn/commands.html
redis hash list set zset 的对比和使用 https://dev.leiyanhui.com/web/redis-hash-set-list/
golang 常用数据类型转换 https://dev.leiyanhui.com/c/golang-string-byte-int-float-map-json/
go redis客户端手册【没啥可看的】 https://redis.uptrace.dev/zh/guide/
go中文手册还不错 http://c.biancheng.net/golang/intro/
英文手册实例不全，但是细节都有 https://pkg.go.dev/github.com/redis/go-redis/v9@v9.0.2
本文主要内容转载自 https://www.cnblogs.com/itbsl/p/14198111.htm 感谢 itbsl，另外增加了一部分内容

# 项目初始化

这里用redis/go-redis/v9

1
2
go mod init demo
go get github.com/redis/go-redis/v9

# 连接redis

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
package main
import (
	"context"
	"fmt"
	"github.com/go-redis/redis/v8"
)
//Background返回一个非空的Context。 它永远不会被取消，没有值，也没有期限。 
//它通常在main函数，初始化和测试时使用，并用作传入请求的顶级上下文。
var ctx = context.Background()
func main() {
	rdb := redis.NewClient(&redis.Options{
		Addr:     "172.16.147.128:6379",
		Password: "",
		DB:       0,
	})

	pong, err := rdb.Ping(ctx).Result()
	if err != nil {
		fmt.Printf("连接redis出错，错误信息：%v", err)
	}
    fmt.Println("成功连接redis")
}

# 基本指令

# Keys():根据正则获取keys

1
2
3
//*表示获取所有的key
keys, err := rdb.Keys(ctx, "*").Result()
}

# Rename RenameNX 重命名key

Redis Renamenx 命令用于在新的 key 不存在时修改 key 的名称。若 key 不存在返回错误。
Redis RENAME 命令用于修改 key 的名字为 newkey 。若key 不存在返回错误。如果newkey存在将会被覆盖。

1
2
func (c Client) Rename(ctx context.Context, key, newkey string) *StatusCmd
func (c Client) RenameNX(ctx context.Context, key, newkey string) *BoolCmd

# Type():获取key对应值得类型

1
vType, err := rdb.Type(ctx, "key").Result()

# del 删除key

1
2
n, err := rdb.Del(ctx, "key1", "key2").Result()
fmt.Printf("成功删除了 %v 个\n", n)

# Exists():检测缓存项是否存在

注：Exists()方法可以传入多个key,返回的第一个结果表示存在的key的数量,不过工作中我们一般不同时判断多个key是否存在，一般就判断一个key,所以判断是否大于0即可，如果判断判断传入的多个key是否都存在，则返回的结果的值要和传入的key的数量相等

1
2
3
4
5
6
n, err := rdb.Exists(ctx, "key1").Result()
if n > 0 {
	fmt.Println("存在")
} else {
    fmt.Println("不存在")
}

# Expire(),ExpireAt():设置有效期

需要在设置好了缓存项后，再设置有效期 Expire()方法是设置某个时间段(time.Duration)后过期，ExpireAt()方法是在某个时间点(time.Time)过期失效

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
res, err := rdb.Expire(ctx, "key", time.Minute * 2).Result()
if res {
	fmt.Println("设置成功")
} else {
	fmt.Println("设置失败")
}
res, err = rdb.ExpireAt(ctx, "key2", time.Now()).Result()
if res {
	fmt.Println("设置成功")
} else {
	fmt.Println("设置失败")
}

# TTL(),PTTL():获取有效期

1
2
3
4
5
6
7
8
//设置一分钟的有效期
rdb.Expire(ctx, "key", time.Minute)
//获取剩余有效期,单位:秒(s)
ttl, err := rdb.TTL(ctx, "key").Result()
fmt.Println(ttl)
//获取剩余有效期,单位:毫秒(ms)
pttl, err := rdb.PTTL(ctx, "key").Result()
fmt.Println(pttl)

# DBSize():查看当前数据库key的数量

1
2
num, err := rdb.DBSize(ctx).Result()
fmt.Printf("数据库有 %v 个缓存项\n", num)

# FlushDB():清空当前数据

1
2
3
//清空当前数据库，因为连接的是索引为0的数据库，所以清空的就是0号数据库
res, err := rdb.FlushDB(ctx).Result()
fmt.Println(res)//OK

# FlushAll():清空所有数据库

1
2
res, err := rdb.FlushAll(ctx).Result()
fmt.Println(res)//OK

# 字符串(string)类型

# Set():设置

仅仅支持字符串(包含数字)操作，不支持内置数据编码功能。如果需要存储Go的非字符串类型，需要提前手动序列化，获取时再反序列化。

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
_, err := rdb.Ping(ctx).Result()
//fmt.Println(pong, err)
if err != nil {
	fmt.Printf("连接redis出错，错误信息：%v", err)
	return
}
//Set方法的最后一个参数表示过期时间，0表示永不过期
err = rdb.Set(ctx, "key1", "value1", 0).Err()
if err != nil {
	panic(err)
}
//key2将会在两分钟后过期失效
err = rdb.Set(ctx, "key2", "value2", time.Minute * 2).Err()
if err != nil {
    panic(err)
}

# SetEX():设置并指定过期时间

设置键的同时，设置过期时间

1
2
3
4
err := rdb.SetEX(ctx, "key", "value", time.Hour * 2).Err()
if err != nil {
	panic(err)
}

# SetNX():设置并指定过期时间

注：SetNX()与SetEX()的区别是，SexNX()仅当key不存在的时候才设置，如果key已经存在则不做任何操作，而SetEX()方法不管该key是否已经存在缓存中直接覆盖

介绍了SetNX()与SetEX()的区别后，还有一点需要注意的时候，如果我们想知道我们调用SetNX()是否设置成功了，可以接着调用Result()方法，返回的第一个值表示是否设置成功了，如果返回false,说明缓存Key已经存在，此次操作虽然没有错误，但是是没有起任何效果的。如果返回true，表示在此之前key是不存在缓存中的，操作是成功的

1
2
3
4
5
6
res, err := rdb.SetNX(ctx, "key", "value", time.Minute).Result()
if res {
	fmt.Println("设置成功")
} else {
	fmt.Printf("key已经存在缓存中，设置失败")
}

# get

如果要获取的key在缓存中并不存在，Get()方法将会返回redis.Nil

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
err := rdb.Set(ctx, "key", "value", 0).Err()
val, err := rdb.Get(ctx, "key").Result()
fmt.Printf("key: %v\n", val)
val2, err := rdb.Get(ctx, "key-not-exist").Result()
if err == redis.Nil {
	fmt.Println("key不存在")
} else if err != nil {
	panic(err)
} else {
	fmt.Printf("值为: %v\n", val2)
}

# GetRange():字符串截取

GetRange()方法可以用来截取字符串的部分内容,第二个参数是下标索引的开始位置，第三个参数是下标索引的结束位置(不是要截取的长度)
注：即使key不存在，调用GetRange()也不会报错，只是返回的截取结果是空"",可以使用fmt.Printf("%q\n", val)来打印测试

1
2
3
4
5
6
err := rdb.Set(ctx, "key", "Hello World!", 0).Err()
if err != nil {
	panic(err)
}
val, err := rdb.GetRange(ctx, "key", 1, 4).Result()
fmt.Printf("key: %v\n", val) //截取到的内容为: ello

# Incr():增加+1

Incr()、IncrBy()都是操作数字，对数字进行增加的操作，incr是执行原子加1操作，incrBy是增加指定的数
所谓原子操作是指不会被线程调度机制打断的操作：这种操作一旦开始，就一直运行到结束，中间不会有任何context witch(切换到另一个线程).
(1)在单线程中，能够在单条指令中完成的操作都可以认为是“原子操作”，因为中断只能发生于指令之间。
(2)在多线程中，不能被其它进程(线程)打算的操作叫原子操作。
Redis单命令的原子性主要得益于Redis的单线程

1
2
val, err := rdb.Incr(ctx, "number").Result()
fmt.Printf("key当前的值为: %v\n", val)

# IncrBy():按指定步长增加

1
2
val, err := rdb.IncrBy(ctx, "number", 12).Result()
fmt.Printf("key当前的值为: %v\n", val)

# Decr():减少-1

Decr()和DecrBy()方法是对数字进行减的操作，和Incr正好相反

1
2
val, err := rdb.Decr(ctx, "number").Result()
fmt.Printf("key当前的值为: %v\n", val)

# DecrBy():按指定步长减少

1
2
val, err := rdb.DecrBy(ctx, "number", 12).Result()
fmt.Printf("key当前的值为: %v\n", val)

# Append():追加

Append()表示往字符串后面追加元素，返回值是字符串的总长度

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
err := rdb.Set(ctx, "key", "hello", 0).Err()
if err != nil {
	panic(err)
}
length, err := rdb.Append(ctx, "key", " world!").Result()
if err != nil {
	panic(err)
}
fmt.Printf("当前缓存key的长度为: %v\n", length) //12
val, err := rdb.Get(ctx, "key").Result()
if err != nil {
	panic(err)
}
fmt.Printf("当前缓存key的值为: %v\n", val) //hello world!

# StrLen():获取长度

StrLen()方法可以获取字符串的长度

1
2
3
4
5
6
7
8
9
err := rdb.Set(ctx, "key", "hello world!", 0).Err()
if err != nil {
	panic(err)
}
length, err := rdb.StrLen(ctx, "key").Result()
if err != nil {
	panic(err)
}
fmt.Printf("当前缓存key的长度为: %v\n", length) //12

# 更多

如上所述都是常用的字符串操作，此外，字符串(string)类型还有MGet()、Mset()、MSetNX()等同时操作多个key的方法，详见：https://pkg.go.dev/github.com/go-redis/redis/v9

# 列表(list)类型

# LPush():将元素压入链表

可以使用LPush()方法将数据从左侧压入链表,也可以从右侧压如链表，对应的方法是RPush()

1
2
3
4
5
6
//返回值是当前列表元素的数量
n, err := rdb.LPush(ctx, "list", 1, 2, 3).Result()
if err != nil {
	panic(err)
}
fmt.Println(n)

# LInsert():在某个位置插入新元素

位置的判断，是根据相对的参考元素判断.
注：即使key列表里有多个值为100的元素，也只会在第一个值为100的元素前面插入123，并不会在所有值为100的前面插入123,客户端还提供了从前面插入和从后面插入的LInsertBefore()和LInsertAfer()方法

1
2
3
4
5
//在名为key的缓存项值为100的元素前面插入一个值，值为123
err := rdb.LInsert(ctx, "key", "before", "100", 123).Err()
if err != nil {
	panic(err)
}

# LSet():设置某个元素的值

1
2
//下标是从0开始的
err := rdb.LSet(ctx, "list", 1, 100).Err()

# LLen():获取链表元素个数

1
2
length, err := rdb.LLen(ctx, "list").Result()
fmt.Printf("当前链表的长度为: %v\n", length)

# LIndex():获取链表下标对应的元素

1
2
val, err := rdb.LIndex(ctx, "list", 0).Result()
fmt.Printf("下标为0的值为: %v\n", val)

# LRange():获取某个选定范围的元素集

1
2
vals, err := rdb.LRange(ctx, "list", 0, 2).Result()
fmt.Printf("从下标0到下标2的值: %v\n", vals)

# LPop从链表左侧弹出数据

1
2
val, err := rdb.LPop(ctx, "list").Result()
fmt.Printf("移除的元素为: %v\n", val)

# LRem():根据值移除元素

1
2
n, err := rdb.LRem(ctx, "list", 2, "100").Result()
fmt.Printf("移除了: %v 个\n", n)

# 集合(set)类型

Redis set对外提供的功能与list类似是一个列表的功能，特殊之处在于set是可以自动排重的，当你需要存储一个列表数据，又不希望出现重复数据，set是一个很好的选择，并且set提供了判断某个成员是否在一个set集合内的接口，这是也是list所不能提供了。
Redis的Set是string类型的无序集合。它底层其实是一个value为null的hash表，所以添加、删除、查找的复杂度都是O(1)。
集合数据的特征：
元素不能重复，保持唯一性
元素无序，不能使用索引(下标)操作
更多内容参考 redis hash list set zset 的对比和使用 https://dev.leiyanhui.com/web/redis-hash-set-list/

# SAdd():添加元素

1
2
3
rdb.SAdd(ctx, "team", "kobe", "jordan")
rdb.SAdd(ctx, "team", "curry")
rdb.SAdd(ctx, "team", "kobe") //由于kobe已经被添加到team集合中，所以重复添加时无效的

# SPop():随机获取一个元素

SPop()方法是从集合中随机取出元素的，如果想一次获取多个元素，可以使用SPopN()方法

1
2
val, err := rdb.SPop(ctx, "team").Result()
fmt.Println(val)

# SRem():删除集合里指定的值

1
2
n, err := rdb.SRem(ctx, "team", "kobe", "v2").Result()
fmt.Println(n)

# SSMembers():获取所有成员

1
2
vals, err := rdb.SMembers(ctx, "team").Result()
fmt.Println(vals)

# SIsMember():判断元素是否在集合中

1
2
3
4
5
6
exists, err := rdb.SIsMember(ctx, "team", "jordan").Result()
if exists {
	fmt.Println("存在集合中")
} else {
	fmt.Println("不存在集合中")
}

# SCard():获取集合元素个数

1
2
total, err := rdb.SCard(ctx, "team").Result()
fmt.Printf("集合总共有 %v 个元素\n", total)

# SUnion():并集,SDiff():差集,SInter():交集

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
rdb.SAdd(ctx, "setA", "a", "b", "c", "d")
rdb.SAdd(ctx, "setB", "a", "d", "e", "f")

//并集
union, err := rdb.SUnion(ctx, "setA", "setB").Result()
fmt.Println(union)
//差集
diff, err := rdb.SDiff(ctx, "setA", "setB").Result()
fmt.Println(diff)
//交集
inter, err := rdb.SInter(ctx, "setA", "setB").Result()
fmt.Println(inter)

# 有序集合(zset)类型

Redis 有序集合和集合一样也是string类型元素的集合,且不允许重复的成员。
不同的是每个元素都会关联一个double类型的分数。redis正是通过分数来为集合中的成员进行从小到大的排序。
有序集合的成员是唯一的,但分数(score)却可以重复。
集合是通过哈希表实现的，所以添加，删除，查找的复杂度都是O(1)。集合中最大的成员数为 232 - 1 (4294967295, 每个集合可存储40多亿个成员)。

# ZAdd():添加元素

添加6个元素1~6,分值都是0

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
rdb.ZAdd(ctx, "zSet", &redis.Z{
	Score: 0,
	Member: 1,
})
rdb.ZAdd(ctx, "zSet", &redis.Z{
	Score: 0,
	Member: 2,
})
rdb.ZAdd(ctx, "zSet", &redis.Z{
	Score: 0,
	Member: 3,
})
rdb.ZAdd(ctx, "zSet", &redis.Z{
	Score: 0,
	Member: 4,
})
rdb.ZAdd(ctx, "zSet", &redis.Z{
	Score: 0,
	Member: 5,
})
rdb.ZAdd(ctx, "zSet", &redis.Z{
	Score: 0,
	Member: 6,
})

# ZIncrBy():增加元素分值

分值可以为负数，表示递减

1
2
3
4
5
6
rdb.ZIncrBy(ctx, "zSet", float64(rand.Intn(100)), "1")
rdb.ZIncrBy(ctx, "zSet", float64(rand.Intn(100)), "2")
rdb.ZIncrBy(ctx, "zSet", float64(rand.Intn(100)), "3")
rdb.ZIncrBy(ctx, "zSet", float64(rand.Intn(100)), "4")
rdb.ZIncrBy(ctx, "zSet", float64(rand.Intn(100)), "5")
rdb.ZIncrBy(ctx, "zSet", float64(rand.Intn(100)), "6")

# ZRange()、ZRevRange():获取根据score排序后的数据段

根据分值排序后的，升序和降序的列表获取

1
2
3
//获取排行榜
//获取分值(点击率)前三的文章ID列表
res, err := rdb.ZRevRange(ctx, "zSet", 0, 2).Result()

# ZRangeByScore()、ZRevRangeByScore():获取score过滤后排序的数据段

根据分值过滤之后的列表,需要提供分值区间

1
2
3
4
res, err := rdb.ZRangeByScore(ctx, "zSet", &redis.ZRangeBy{
	Min:    "40",
	Max:    "85",
}).Result()

# ZCard():获取元素个数

1
count, err := rdb.ZCard(ctx, "zSet").Result()

# ZCount():获取区间内元素个数

获取分值在[40, 85]的元素的数量

1
n, err := rdb.ZCount(ctx, "zSet", "40", "85").Result()

# ZScore():获取元素的score

1
score, err := rdb.ZScore(ctx, "zSet", "5").Result()

# ZRank()、ZRevRank():获取某个元素在集合中的排名

ZRank()方法是返回元素在集合中的升序排名情况，从0开始。ZRevRank()正好相反

1
res, err := rdb.ZRevRank(ctx, "zSet", "2").Result()

# ZRem():删除元素

1
res, err := rdb.ZRem(ctx, "zSet", "2").Result()

# ZRemRangeByRank():根据排名来删除

1
2
//按照升序排序删除第一个和第二个元素
res, err := rdb.ZRemRangeByRank(ctx, "zSet",  0, 1).Result()

# ZRemRangeByScore():根据分值区间来删除

1
2
//删除score在[40, 70]之间的元素
res, err := rdb.ZRemRangeByScore(ctx, "zSet", "40", "70").Result()

# 哈希(hash)类型

Redis hash 是一个 string 类型的 field（字段）和 value（值）的映射表，hash 特别适合用于存储对象。

Redis 中每个 hash 可以存储 232 - 1 键值对（40多亿）。

当前服务器一般都是将用户登录信息保存到Redis中，这里存储用户登录信息就比较适合用hash表。hash表比string更合适，如果我们选择使用string类型来存储用户的信息的时候，我们每次存储的时候就得先序列化(json_encode()、serialize())成字符串才能存储redis,

从redis拿到用户信息后又得反序列化(UnMarshal()、Marshal())成数组或对象，这样开销比较大。如果使用hash的话我们通过key(用户ID)+field(属性标签)就可以操作对应属性数据了，既不需要重复存储数据，也不会带来序列化和并发修改控制的问题。

# HSet():设置

1
2
3
rdb.HSet(ctx, "user", "key1", "value1", "key2", "value2")
rdb.HSet(ctx, "user", []string{"key3", "value3", "key4", "value4"})
rdb.HSet(ctx, "user", map[string]interface{}{"key5": "value5", "key6": "value6"})

# HMset():批量设置

1
2
rdb.Del(ctx, "user")
rdb.HMSet(ctx, "user", map[string]interface{}{"name":"kevin", "age": 27, "address":"北京"})

# HGet():获取某个元素

1
address, err := rdb.HGet(ctx, "user", "address").Result()

# HGetAll():获取全部元素

1
user, err := rdb.HGetAll(ctx, "user").Result()

# HDel():删除某个元素

HDel():删除某个元素

1
res, err := rdb.HDel(ctx, "user", "name", "age").Result()

# HExists():判断元素是否存在

1
res, err := rdb.HExists(ctx, "user", "address").Result()

# HLen():获取长度

1
2
res, err := rdb.HLen(ctx, "user").Result()
```本文转自：https://www.cnblogs.com/itbsl/p/14198111.html