【Redis5源码学习】浅析redis命令之exists篇

baiyan

命令语法

命令含义：判断键是否存在。如果过期则不存在，不过期则存在
命令格式：

EXISTS key1 key2 ... keyN

命令实战：

127.0.0.1:6379> set key1 value1
OK
127.0.0.1:6379> exists key1
(integer) 1

返回值： 存在键的数量

源码分析

exists命令对应的处理函数是existsCommand()：

void existsCommand(client *c) {
    long long count = 0;
    int j;

    for (j = 1; j < c->argc; j++) {
        // 去键空间字典寻找给定key是否存在，存在则count++
        if (lookupKeyRead(c->db,c->argv[j])) count++; 
    }
    // 返回找到key的数量
    addReplyLongLong(c,count);
}

同样地，我们使用gdb -p来观察exists命令的执行过程，gdb的过程这里不再赘述。我们在existsCommand处打一个断点，然后在客户端中执行命令：

127.0.0.1:6379> exists key1

观察服务端，已经执行到我们的断点处了：

Breakpoint 1, existsCommand (c=0x7fb459ca3540) at db.c:496
496    void existsCommand(client *c) {
(gdb) n
500        for (j = 1; j < c->argc; j++) {
(gdb)
497        long long count = 0;
(gdb)
501            if (lookupKeyRead(c->db,c->argv[j])) count++;
(gdb) s

我们看到，在入口函数existsCommand()中，遍历了所有的命令参数，即我们传入的key1，这里会调用lookupKeyRead()函数，去键空间中查找键是否过期，如果过期，则返回0，不存在。反之键存在，返回1。跟进这个函数调用：

lookupKeyRead (key=0x7fb462229ad0, db=0x7fb46221a800) at db.c:144
144        return lookupKeyReadWithFlags(db,key,LOOKUP_NONE);
(gdb) s
lookupKeyReadWithFlags (db=0x7fb46221a800, key=0x7fb462229ad0, flags=flags@entry=0) at db.c:100
100    robj *lookupKeyReadWithFlags(redisDb *db, robj *key, int flags) {
(gdb) n
103        if (expireIfNeeded(db,key) == 1) {
(gdb) n
133        val = lookupKey(db,key,flags);
(gdb) n

这个函数直接调用了lookupKeyReadWithFlags()，然后在lookupKeyReadWithFlags函数内部，调用了我们熟悉的expireIfNeeded()，显然在我们调试过程中，并没有进这个if，因为我们的键并没有过期，所以肯定返回0。由于键并没有过期，那么在这里应该直接返回了。但是由于它是一个通用查找函数，还需要返回查找后的值，所以继续调用lookupKey()函数，去键空间中查找key1对应的值value1。继续往下执行：

133        val = lookupKey(db,key,flags);
(gdb) n
134        if (val == NULL)
(gdb) p val
$1 = (robj *) 0x7fb46220e100
(gdb) p *val
$2 = {type = 0, encoding = 8, lru = 8745377, refcount = 1, ptr = 0x7fb46220e113}
137            server.stat_keyspace_hits++;
(gdb)
139    }
(gdb)
existsCommand (c=0x7fb459ca3540) at db.c:501
501            if (lookupKeyRead(c->db,c->argv[j])) count++;

我们看到，在查找完成之后，会判断是否为NULL，显然这里不会为NULL。打印val的值，是一个redisObj结构，这里ptr指向的sds就是我们的value1了。然后，redis会统计一个数据，是在键空间中查找到value的次数，这里由于我们找到了，将其++，然后函数会将查找到的value1返回，最外层判断不为NULL，count++，命令执行结束。

扩展

字典的查找

在exists命令执行过程中，一个核心的函数调用就是lookupKey()。这个函数查找一个键对应的value值。如果存在，返回该value值，否则返回NULL：

robj *lookupKey(redisDb *db, robj *key, int flags) {
    dictEntry *de = dictFind(db->dict,key->ptr); // 找到当前key-value对所在的dictEntry
    if (de) {
        robj *val = dictGetVal(de); // 是一个宏，直接返回dictEntry中的val字段
        ...
        return val;
    } else {
        return NULL;
    }
}

这个函数会首先调用dictFind()，直接返回这个key所在dict中的dictEntry。我们跟进这个函数：

static dictEntry *dictFind(dict *ht, const void *key) {
    dictEntry *he;  // dictEntry结构的指针
    unsigned int h; // 存储哈希值

    if (ht->size == 0) return NULL; // 字典为空，直接返回不存在
    h = dictHashKey(ht, key) & ht->sizemask; // 计算哈希值
    he = ht->table[h]; // 访问字典对应哈希值位置上的元素，它是一个指针，指向dictEntry结构
    // 遍历链地址法解决冲突的链表
    while(he) {
        if (dictCompareHashKeys(ht, key, he->key)) // 挨个比较当前dictEntry的key值是否等于我们要找的key值
            return he; // 找到了，直接返回
        he = he->next; // 没找到，继续往后遍历链表
    }
    return NULL; // 遍历到链表尾部还没有找到，说明没有该元素
}

在说明该函数查找流程之前，我们回顾一下字典的存储结构：

代码中的he = ht->table[h]访问的就是我们**table这个指针。它是一个二级指针，可以看成一个一维数组，每个数组中的元素都是一个dictEntry的指针。我们访问到了第h个（计算后的哈希值）元素的bucket位置上，它也是一个dictEntry指针，指向真正存储key-value对的结构。由于需要解决哈希冲突问题，所以一个bucket后面会以链地址法，通过next指针字段，挂接多个dictEntry，这就是上面代码为什么需要遍历的原因。每遍历一个dictEntry，我们都要比较一下当前dictEntry上的key值是否与我们要比较的key值是否相等，如果相等就找到了我们要找的key-value对。反之如果遍历到链表尾部都没找到，那就说明没有这个key-value对了：

我们回顾一下dictEntry的结构：

typedef struct dictEntry {
    void *key; // 指向存储key值的结构
    union {
        void *val; // 指向存储value值的结构
        uint64_t u64;
        int64_t s64;
        double d;
    } v;
    struct dictEntry *next; // 链地址法解决冲突的指针，指向下一个dictEntry结构
} dictEntry;

在找完之后，该函数会返回一个dictEntry结构的指针，我们调用dictGetVal宏，就能访问到dictEntry中的value值啦：

#define dictGetVal(he) ((he)->v.val)

我们看到，这个宏访问了dictEntry的val字段，成功拿到了当前key对应的value值。

参考资料

【Redis5源码学习】2019-04-19 字典dict