Redis实现之字典

字典

字典，又称为符号表（symbol table）、关联数组（associative array）或映射（map），是一种用于保存键值对（key-value pair）的抽象数据结构。在字典中，一个键（key）可以和一个值（value）进行关联，这些关联的键和值就称为键值对。字典中每个键都是独一无二的，程序可以在字典中根据键查找与之关联的值，或者通过键来更新值，又或者根据键来删除整个键值对，等等。

字典在Redis中的应用相当广泛，比如Redis的数据库就是使用字典来作为底层实现的，对数据库的增删改查也是构建在对字典的操作上。举个栗子，当我们使用SET命令

127.0.0.1:6379> SET msg "hello world"
OK

　　

在数据库中将创建一个键为"msg"，值为"hello world"的键值对，再把这个键值对保存在代表数据库的字典里面。除了用来表示数据库之外，字典还是哈希键的底层实现之一，当一个哈希键包含的键值对比较多，又或者键值对中元素都是比较长的字符串时，Redis就会使用字典作为哈希键的底层实现。举个栗子，website是一个包含两个键值对的哈希键，这个哈希键的键都是一些网站的名字，而键的值就是网站的域名

127.0.0.1:6379> HMSET website google www.google.com yahoo www.yahoo.com
OK
127.0.0.1:6379> HLEN website
(integer) 2
127.0.0.1:6379> HGETALL website
1) "google"
2) "www.google.com"
3) "yahoo"
4) "www.yahoo.com"

　　

website键的底层就是一个字典，字典中包含两个键值对，如：

• 键值对的键为"goole"，值为"www.google.com"
• 键值对的键为"yahoo"，值为"www.yahoo.com"

字典的实现

Redis的字典使用哈希表作为底层实现，一个哈希表里面可以有多个哈希表节点，而每个哈希表节点就保存了字典中的一个键值对。接下来的三个小节将分别介绍Redis的哈希表、哈希表节点以及字典的实现

哈希表

dict.h

typedef struct dictht {
	//哈希表数组
    dictEntry **table;
	//哈希表大小
    unsigned long size;
	//哈希表大小掩码，用于计算索引值，等于size-1
    unsigned long sizemask;
	//该哈希表已有节点数量
    unsigned long used;
} dictht;

　　

table属性时一个数组，数组中的每个元素都是一个指向dictEntry结构的指针，每个dictEntry结构保存着一个键值对。size属性记录了哈希表的大小，即table数组的大小，而used属性则记录了哈希表目前已有节点（键值对）的数量。sizemask属性的值总是size-1，这个属性和哈希值一起决定一个键应该被放到table数组的哪个索引上面。图1-1展示了一个大小为4的空哈希表（没有包含任何键值对）

图1-1   一个空的哈希表

哈希表节点

哈希表节点使用dictEntry结构表示，每个dictEntry结构都保存着一个键值对：

dict.h

typedef struct dictEntry {
	//键
    void *key;
	//
    union {
        void *val;
        uint64_t u64;
        int64_t s64;
        double d;
    } v;
	//指向下个哈希表节点，形成链表
    struct dictEntry *next;
} dictEntry;

　　

key属性保存着键值对中的键，而v属性则保存着键值对中的值，其中键值对的值可以是一个指针，或者是一个uint64_t整数，又或者是一个int64_t整数。next属性是指向另一个哈希表节点的指针，这个指针可以将多个哈希值相同的键值对连接在一起，以此来解决键冲突问题。举个栗子，图1-2就展示了如何通过next指针，将两个索引值相同的键K1和K0连接到一起

图1-2   连接在一起的键K1和K0

字典

Redis中的字典由dict结构表示

dict.h

typedef struct dict {
	//类型特定函数
    dictType *type;
	//私有函数
    void *privdata;
	//哈希表
    dictht ht[2];
	//rehash索引，当rehash不在进行时，值为-1
    long rehashidx;
} dict;

　　

type属性和privadata属性是针对不同类型的键值对，为创建多态字典而设置的：

• type属性是一个指向dictType结构的指针，每个dictType结构保存了一簇用于操作特性类型键值对的函数，Redis会为用途不同的字典设置不同的类型特性函数
• privadata属性则保存了需要传给那些类型特定函数的可选参数

dict.h

typedef struct dictType {
	//计算哈希值的函数
    uint64_t (*hashFunction)(const void *key);
	//复制键的函数
    void *(*keyDup)(void *privdata, const void *key);
	//复制值的函数
    void *(*valDup)(void *privdata, const void *obj);
	//对比键的函数
    int (*keyCompare)(void *privdata, const void *key1, const void *key2);
	//销毁键的函数
    void (*keyDestructor)(void *privdata, void *key);
	//销毁值的函数
    void (*valDestructor)(void *privdata, void *obj);
} dictType;

　　

ht属性是一个包含两个项的数组，数组中每个项 都是一个dictht哈希表，一般情况下，字典只使用ht[0]哈希表，ht[1]哈希表只会在对ht[0]哈希表进行rehash时使用。除了ht[1]之外，另一个和rehash相关的属性就是rehashidx，它记录了rehash目前的进度，如果目前没有在进行rehash，那么它的值为-1

图1-3展示了一个普通状态下（没有进行rehash）的字典

图1-3   普通状态下的字典

哈希算法

当要将一个新的键值对添加到字典里面时，程序需要先根据键值对的键计算出哈希值和索引值，然后在根据索引值，将包含新键值对的哈希表节点放到哈希表数组的指定索引上面。

Redis计算哈希值和索引值的方法如下：

//使用字典设置的哈希函数，计算键key的哈希值
hash = dict->type->hashFunction(key);

//使用哈希表的sizemask属性和哈希值，计算出索引值
//根据情况不同，ht[x]可以是ht[0]或者ht[1]
index = hash & dict->hx[x].sizemask;

图1-4空字典

举个栗子，对于图1-4所示的字典来说，如果我们要将一个键值对k0和v0添加到字典里面，那么程序会先使用语句：hash = dict->type->hashFunction(key)，计算键k0的哈希值，假设计算出k0的哈希值为8，那么程序会使继续使用语句：

index = hash & dict->hx[0].sizemask = 8 & 3 = 0，计算处键k0的索引值0，这表示包含键值对k0和v0的节点应被放置到哈希表数组的索引0位置上，如图1-5所示

图1-5   添加键值对k0和v0之后的字典

当字典被用作数据库的底层实现，或者哈希键的底层实现时，Redis使用MurmurHash2算法来计算键的哈希值，MurmurHash2算法最初由Austin Appleby于2008发明，这种算法的优点在于，即便输入的键是有规律的，算法仍能给出一个很好的随机性分布，并且算法的计算速度也很快

解决键冲突

当有两个以上数量的键被分配到了哈希表数组的同一个索引上，我们称这些键发生了冲突。Redis的哈希表使用链地址法来解决键冲突，每个哈希表节点都有一个next指针，多个哈希表节点可以用next指针构成一个单向链表，被分配到同一个索引上的多个节点可以用这个单向链表连接起来，这就解决了键冲突的问题

举个栗子，假设程序要将键值对k2和v2添加到图1-6所示的哈希表里面，并且计算得出k2的索引值为2，那么键k1和k2将产生冲突，而解决冲突的办法就是使用next指针将键k2和k1所在的节点连接起来，如图1-7所示

图1-6   一个包含两个键值对的哈希表

图1-7   使用链表解决k2和k1的冲突

rehash

随着操作的不断进行，哈希表保存的键值对会逐渐地增多或减少，为了让哈希表的负载因子（load factor）维持在一个合理的范围内，当哈希表保存的键值对数量太多或者太少时，程序需要对哈希表的大小进行相应的扩展或收缩。扩展和收缩哈希表的工作可以通过rehash（重新散列）操作来完成，Redis对字典的哈希表执行rehash的步骤如下：

1. 为字典的ht[1]哈希表分配空间，这个哈希表的空间大小取决于要执行的操作，以及ht[0]当前包含的键值对数量（即ht[0].used属性的值）。如果执行的是扩展操作，那么ht[1]的大小为第一个大于等于ht[0].used*2的2^n（2的n次方幂）；如果执行的是收缩操作，那么ht[1]的大小为第一个大于等于ht[0].used的2^n
2. 将保存在ht[0]中的所有键值对rehash到ht[1]上面：rehash指的是重新计算键的哈希值和索引值，然后将键值对放置到ht[1]哈希表的指定位置上
3. 当ht[0]包含的所有键值对都迁移到了ht[1]之后（ht[0]变为空白表），释放ht[0]，将ht[1]设置为ht[0]，并在ht[1]新创建一个空白哈希表，为下一次rehash做准备

举个栗子，假设程序要对图1-8所示的字典的ht[0]进行扩展操作，那么程序将执行以下步骤：

图1-8   执行rehash之前的字典

1.ht[0].used当前的值为4,4*2=8，而8（2^3）恰好是第一个大于等于4的2的n次方，所以程序会将ht[1]哈希表的大小设置为8。图1-9展示了ht[1]在分配空间之后，字典的样子

图1-9   为字典的ht[1]哈希表分配空间

2.将ht[0]包含的四个键值对都rehash到ht[1]，如图1-10所示

图1-10   ht[0]的所有键值对都已经被迁移到ht[1]

3.释放ht[0]，并将ht[1]设置为ht[0]，然后为ht[1]分配一个空白哈希表，如图1-11所示。至此，对哈希表的扩展操作执行完毕，程序成功将哈希表的大小从原来的4改为了现在的8

图1-11   完成rehash之后的字典

哈希表的扩展与收缩

当以下中的任意一个条件被满足时，程序会自动开始对哈希表进行扩展操作：

1. 服务器目前没有在执行bgsave命令或bgrewriteaof命令，并且哈希表的负载因子大于等于1
2. 服务器目前正在执行bgsave或bgrewriteaof命令，并且哈希表的负载因子大于等于5。其中哈希表的负载因子可以通过公式：load_factor = ht[0].used/ht[0].size计算得出，例如，对于一个大小为4，包含4个键值对的哈希表来说，这个哈希表的负载因子为1，又比如，对于一个大小为512，包含256个键值对的哈希表来说，负载因子为0.5

根据bgsave命令或bgrewriteaof命令是否正在执行，服务器执行扩展操作所需的负载因子并不同，这是因为在执行bgsave命令或bgrewriteaof的过程中，Redis需要创建当前服务器进程的子进程，而大多数操作系统都采用写时复制（copy-on-write）技术来优化子进程的使用效率，所以在子进程存在期间，服务器会提高扩展操作所需的负载因子，从而尽可能地避免在子进程存在期间进行哈希表扩展操作，这可以避免不必要的内存写入操作，最大限度地节约内存

另一方面，当哈希表的负载因子小于0.1时，程序自动开始对哈希表执行收缩操作

tips：关于save、bgsave、bgrewriteaof可以看Redis持久化详解

渐进式rehash

之前说过，扩展或收缩哈希表需要将ht[0]里面的所有键值对rehash到ht[1]里面，但是，这个rehash动作并不是一次性、集中式地完成的，而是分多次，渐进式完成。这样做的原因在于，如果ht[0]里只保存着四个键值对，那么服务器可以在瞬间就将这些键值对全部rehash到ht[1]；但是，如果哈希表里保存的键值对的数量不止四个，而是四百万、四千万甚至更多，那么要一次性将这些键值对全部rehash到ht[1]的话，庞大的计算量可能会导致服务器在一段时间内停止服务

因此，为了避免rehash对服务器性能造成影响，服务器不是一次性将ht[0]里面的所有键值对全部rehash到ht[1]，而是分多次，渐进式地将ht[0]里面的键值对慢慢地rehash到ht[1]。以下是哈希表渐进式rehash的详细步骤：

1. 为ht[1]分配空间，让字典同时持有ht[0]和ht[1]两个哈希表
2. 在字典中维持一个索引计数器变量rehashidx，并将它的值设置为0，表示rehash工作正式开始
3. 在rehash进行期间，每次对字典执行增删改查时，程序除了执行指定的操作外，还会顺带将ht[0]哈希表在rehashidx索引上的所有键值对rehash到ht[1]，当rehash工作完成之后，程序将rehashidx属性的值增一
4. 随着字典操作的不断执行，最终在某个时间点上，ht[0]的所有键值对都会被rehash到ht[1]，这时程序将rehashidx属性的值设为-1，表示rehash操作已完成

渐进式rehash的好处在于它采取分而治之的方式，将rehash键值对所需计算工作均摊到字典的每个增删改查操作上，从而避免了集中式rehash而带来的庞大计算量

图1-12至图1-17展示了一次完成的渐进式rehash过程，注意观察在整个rehash过程中字典的rehashidx属性是如何变化的

图1-12   准备开始rehash

图-13   rehash索引0上的键值对

图1-14   rehash索引1上的键值对

图1-15   rehash索引2上的键值对

图1-16   rehash索引3上的键值对

图1-17   rehash执行完毕

渐进式rehash执行期间的哈希表

因为在进行渐进式rehash的过程中，字典会同时使用ht[0]和ht[1]两个哈希表，所以在渐进式rehash进行期间，字典的删除、查找、更新等操作会在两个哈希表上进行。例如，要在字典里面查找一个键的话，程序会现在ht[0]里面进行查找，如果没找到，再到ht[1]里面进行查找。另外，在渐进式rehash执行期间，新添加到字典的键值对一律被保存到ht[1]里面，而ht[0]则不再进行任何添加操作，这一措施保证了ht[0]包含的键值对只少不增，随着rehash操作的执行最终变成空表

字典API

表1-1列出了字典的主要操作API

表1-1   字典的主要操作API

dictCreate(dictType *type, void *privDataPtr)	创建一个新的字典	O(1)
dictAdd(dict *d, void *key, void *val)	将给定的键值对添加到字典里面	O(1)
dictReplace(dict *d, void *key, void *val)	将给定的键值对添加到字典里面，如果键已经存在于字典，那么用新值取代原有的值	O(1)
dictFetchValue(dict *d, void *key, void *val)	返回给定键的值	O(1)
dictGetRandomKey(dict *d)	从字典中随机返回一个键值对	O(1)
dictDelete(dict *d, const void *key)	从字典中删除给定键所对应的键值对	O(1)
dictRelease(dict *d)	释放给定字典，以及字典中包含的所有键值对	O(N)，N 为字典包含的键值对数量