码神营地-redis数据结构-字典

Redis数据结构-字典
字典是比较麻烦的一种数据结构，数据结构也相对复杂一些，redis2-x和redis4-x版本该数据结构定义是一致的，本文拿redis4-x来看。
更过关于redis操作和学习教程请进入码神营地官网：www.icodegod.com

• 数据结构

  
  首先看看哈希表节点实体的结构，简单的由key，v，和一个指向下一个节点的指针next。其中key是void*，这样定义可以支持任意数据类型的key，v是一个共用体，支持void*，uint64_t,int64_t,和double，这么做得目的还是为了区分类型，节省空间。内存结构图如下：
  

  v的内存结构：共用8字节内存空间
  
  第二个结构体是字典类型特定函数结构体，里面是字典类型特定函数，包括hashFunction哈希函数，keyDup键复制函数，valDup值复制函数，keyCompare键复制函数，keyDestructor键销毁函数，valDestructor值销毁函数。dictType结构体类型存在的意义就是为实现特定类型字典提供便利。
  源码中哈希表的结构定义和字典的定义：
  
  dictht是哈希表结构，4部分组成，table是一个指向dicEntry的指针数组，其中每一个元素都是一个dicEntry的结构体，size表示hash表的长度，sizemask大小掩码用于rehash中，used表示该hash表中已使用长度。
  dict是redis中字典的结构，5部分组成，type是一个dictType结构的指针，privdata是void*的指针，用来保存dictType里面函数传递的私有数据，ht[2]是一个大小为2的dictht类型的数组，每一个元素都是一个dictht类型的哈希表，其中ht[0]用于字典使用，ht[1]用于rehash使用，用来对ht[0]进行扩容或者缩容处理，作为后备哈希表，rehashindx标志rehash进度，当没有进行rehash的时候，该值为-1，表示没有进行过一次在哈希操作，以及字典的迭代器iterators。
  源码中iterators的结构体：
  
  d指针指向当前所要操作的字典，index表示下标，table是哈希表，safe用于标志新表格还是旧表，entry表示当前字典实体，nextEntry表示下一个字典实体。fingerprint表示指纹标记，作用是避免不安全的迭代器迭代现象。

• 内存结构
  看完整个字典涉及到的数据结构可以得到整个字典的内存结构图（图太难画，盗用redis设计与实现书中图）：
  

• 字典创建
  在源码中字典创建使用函数dictCreate创建，具体实现如下：
  
  创建字典的过程分为两部分：空间开辟，变量初始化。

  1. 空间开辟。redis源码中的所以内存开辟都采用封装的zmalloc进行分配，zmalloc底层封装了c语言函数malloc来进行实现。
  2. 变量初始化。该过程初始化两个哈希表数据，指针指向null，hash表格大小为0，字典开始不参与rehash，赋予rehashidx = -1。

• 添加元素
  创建完一个字典，要想实现往该字典中添加元素实现步骤如下：
  1. 如果该字典中已经有元素且hash表空间足够能容下这一个键值对，那么不需要进行hash空间再分配操作：

/* Add an element to the target hash table */
int dictAdd(dict *d, void *key, void *val)
{
    dictEntry *entry = dictAddRaw(d,key,NULL);

    if (!entry) return DICT_ERR;
    dictSetVal(d, entry, val);
    return DICT_OK;
}

从源码可知，先做了设置key的操作，然后再做设置val操作。

dictEntry *dictAddRaw(dict *d, void *key, dictEntry **existing)
{
    int index;
    dictEntry *entry;
    dictht *ht;

    if (dictIsRehashing(d)) _dictRehashStep(d);

    /* Get the index of the new element, or -1 if
     * the element already exists. */
    if ((index = _dictKeyIndex(d, key, dictHashKey(d,key), existing)) == -1)
        return NULL;

    /* Allocate the memory and store the new entry.
     * Insert the element in top, with the assumption that in a database
     * system it is more likely that recently added entries are accessed
     * more frequently. */
    ht = dictIsRehashing(d) ? &d->ht[1] : &d->ht[0];
    entry = zmalloc(sizeof(*entry));
    entry->next = ht->table[index];
    ht->table[index] = entry;
    ht->used++;

    /* Set the hash entry fields. */
    dictSetKey(d, entry, key);
    return entry;
}

设置key操作中首先会检查该字典中是否使用了rehash，判断rehash进行到哪一步了，然后会判断该key是否已经存在，如果存在则直接返回null,无需再重新创建。如果该key值已经存在则返回null,如果该key不存在则判断使用哪个哈希表进行新的实体采用头插法插入，然后设置新的实体的key字段。
设置完key调用设置值函数dictSetVal设置key对应值。因为设置key对应的值比较简单，redis对应源码中将该方法设置为宏定义：

#define dictSetVal(d, entry, _val_) do { \
    if ((d)->type->valDup) \
        (entry)->v.val = (d)->type->valDup((d)->privdata, _val_); \
    else \
        (entry)->v.val = (_val_); \
	} while(0)