python 操作redis之五(集合)

集合使用与内部实现原理

集合类型 (Set) 是一个无序并唯一的键值集合。

之所以说集合类型是一个无序集合,是因为它的存储顺序不会按照插入的先后顺序进行存储,如下代码所示:

127.0.0.1:6379> sadd myset v2 v1 v3 #插入数据 v2、v1、v3 
(integer) 3
127.0.0.1:6379> smembers myset #查询数据
1) "v1"
2) "v3"
3) "v2"

从上面代码执行结果可以看出,myset 的存储顺序并不是以插入的先后顺序进行存储的。

集合类型和列表类型的区别如下:

  • 列表可以存储重复元素,集合只能存储非重复元素;
  • 列表是按照元素的先后顺序存储元素的,而集合则是无序方式存储元素的。

1 代码实战

集合类型的功能比列表类型丰富一些,集合类型可以用来统计多个集合的交集、错集和并集,如下代码所示。

from redis import StrictRedis

redis_cli = StrictRedis(host="xx", port=xx, password="xx", db=xx, decode_responses=True)

# 1)添加一个或多个元素
redis_cli.sadd("set", "1", "3", 4, 8, 9, 3)  # “3”和 3 被看做是相同的

# 2)查询集合所有元素
mem = redis_cli.smembers("set")
print(mem)

# 3)查询集合的成员数量
num = redis_cli.scard("set")
print(num)

# 4)查询集合中是否包含某个元素
is_exists = redis_cli.sismember("set", "10")
print(is_exists)

# 5)从一个集合中移动一个元素到另一个集合
redis_cli.sadd("set2", 10, 11, 12)

redis_cli.smove("set", "set2", "3")
print(redis_cli.smembers("set2"))
print(redis_cli.smembers("set"))

# 6)移除并返回集合中的一个随机元素
random_key = redis_cli.spop("set2")
print(random_key)
print(redis_cli.smembers("set2"))

# 7)随机返回集合中指定数量的元素列表
mems = redis_cli.srandmember("set2", 2)
print(mems)

# 8)移除集合中一个或多个元素(注意:使用 srem 指令,不存在的元素将会被忽略。)
redis_cli.srem("set", "1", "8")
print(redis_cli.smembers("set"))

# 9)返回一个集合或多个集合的交集
redis_cli.sadd("set3", 1, 3, 5, 7, 8, 9)
redis_cli.sadd("set4", 2, 3, 5, 6, 7)

inter = redis_cli.sinter("set3", "set4")
print(inter)

# 10)把集合的交集复制到新的集合中 (从以下代码可以看出,我们把集合set3和集合set4的交集元素复制到了新的集合des中,但 交集元素并不会从原有集合中移除。)
redis_cli.sinterstore("des", "set3", "set4")
des_mems = redis_cli.smembers("des")
print("des_mems >>>>>>>>>>>>>>>", des_mems)

# 11)查询一个或多个集合的并集
union = redis_cli.sunion("set3", "set4")
print(union)

# 12)把一个或多个集合的并集复制到新集合中(注意:只是把一个或多个集合的并集复制到新集合中,并不会在原集合中删除复制的元素。)
uni_des = redis_cli.sunionstore("uni", "set3", "set4")
print(redis_cli.smembers("uni"))

# 13)查询一个或多个集合的错集 (查询差集是以第一个集合为基准,去除掉与第二个,第三个。。。集合相同的元素,剩下的就是差集)
redis_cli.sadd("set8", 2, 5, 7, 6, 9)
redis_cli.sadd("set9", 1, 3, 6, 8)
redis_cli.sadd("set10", 4, 7, 99)
set6_diff_set5 = redis_cli.sdiff("set8", "set9", "set10")
set5_diff_set6 = redis_cli.sdiff("set9", "set8")
print(set6_diff_set5)
print(set5_diff_set6)

# 14)把一个或多个集合的错集复制到新集合
redis_cli.sdiffstore("diff", "set8", "set9")
print(redis_cli.smembers("diff"))

2 内部实现

集合类型是由 intset (整数集合) 或 hashtable (普通哈希表) 组成的。当集合类型以 hashtable 存储时,哈希表的 key 为要插入的元素值,而哈希表的 value 则为 Null,如下图所示:

集合Set-hashtable.png

当集合中所有的值都为整数时,Redis 会使用 intset 结构来存储,如下代码所示:

127.0.0.1:6379> sadd myset 1 9 3 -2
(integer) 4
127.0.0.1:6379> object encoding myset
"intset"

从上面代码可以看出,当所有元素都为整数时,集合会以 intset 结构进行(数据)存储。 当发生以下两种情况时,会导致集合类型使用 hashtable 而非 intset 存储: 1)当元素的个数超过一定数量时,默认是 512 个,该值可通过命令 set-max-intset-entries xxx 来配置。 2)当元素为非整数时,集合将会使用 hashtable 来存储,如下代码所示:

127.0.0.1:6379> sadd myht "redis" "db"
(integer) 2
127.0.0.1:6379> object encoding myht
"hashtable"

从上面代码可以看出,当元素为非整数时,集合会使用 hashtable 进行存储

3 源码解析

集合源码在 t_set.c 文件中,核心源码如下:

/* 
 * 添加元素到集合
 * 如果当前值已经存在,则返回 0 不作任何处理,否则就添加该元素,并返回 1。
 */
int setTypeAdd(robj *subject, sds value) {
    long long llval;
    if (subject->encoding == OBJ_ENCODING_HT) { // 字典类型
        dict *ht = subject->ptr;
        dictEntry *de = dictAddRaw(ht,value,NULL);
        if (de) {
            // 把 value 作为字典到 key,将 Null 作为字典到 value,将元素存入到字典
            dictSetKey(ht,de,sdsdup(value));
            dictSetVal(ht,de,NULL);
            return 1;
        }
    } else if (subject->encoding == OBJ_ENCODING_INTSET) { // inset 数据类型
        if (isSdsRepresentableAsLongLong(value,&llval) == C_OK) {
            uint8_t success = 0;
            subject->ptr = intsetAdd(subject->ptr,llval,&success);
            if (success) {
                // 超过 inset 的最大存储数量,则使用字典类型存储
                if (intsetLen(subject->ptr) > server.set_max_intset_entries)
                    setTypeConvert(subject,OBJ_ENCODING_HT);
                return 1;
            }
        } else {
            // 转化为整数类型失败,使用字典类型存储
            setTypeConvert(subject,OBJ_ENCODING_HT);

            serverAssert(dictAdd(subject->ptr,sdsdup(value),NULL) == DICT_OK);
            return 1;
        }
    } else {
        // 未知编码(类型)
        serverPanic("Unknown set encoding");
    }
    return 0;
}

以上这些代码验证了,我们上面所说的内容,当元素都为整数并且元素的个数没有到达设置的最大值时,键值的存储使用的是 intset 的数据结构,反之到元素超过了一定的范围,又或者是存储的元素为非整数时,集合会选择使用 hashtable 的数据结构进行存储。

4 使用场景

集合类型的经典使用场景如下:

  • 微博关注我的人和我关注的人都适合用集合存储,可以保证人员不会重复;
  • 中奖人信息也适合用集合类型存储,这样可以保证一个人不会重复中奖。

5 小结

通过本文我们知道了,集合类型是由整数集合 (intset) 或者是哈希表 (hashtable) 组成的,集合类型比较适合用来数据去重和保障数据的唯一性,除此之外,集合类型还可以用来统计多个集合的交集、错集和并集。当我们存储的数据是无序并且需要去重的情况下,比较适合使用集合类型进行存储。


版权声明:本文为myli_binbin原创文章,遵循CC 4.0 BY-SA版权协议,转载请附上原文出处链接和本声明。