Redis源码剖析（三）链表

1 链表的实现

每个链表节点使用一个 adlist.h/listNode 结构来表示：

typedef struct listNode 
{
    // 前置节点
    struct listNode *prev;

    // 后置节点
    struct listNode *next;

    // 节点的值
    void *value;

} listNode;

多个 listNode 可以通过 prev 和 next 指针组成双端链表，如下图所示。

2 表头的实现

虽然仅仅使用多个 listNode 结构就可以组成链表，但使用 adlist.h/list 来持有链表的话，操作起来会更方便：

typedef struct list {

    // 表头节点
    listNode *head;

    // 表尾节点
    listNode *tail;

    // 链表所包含的节点数量
    unsigned long len;

    // 节点值复制函数
    void *(*dup)(void *ptr);

    // 节点值释放函数
    void (*free)(void *ptr);

    // 节点值对比函数
    int (*match)(void *ptr, void *key);

} list;

list 结构为链表提供了表头指针 head 、表尾指针 tail ，以及链表长度计数器 len ，而 dup 、 free 和 match 成员则是用于实现多态链表所需的类型特定函数：

dup 函数用于复制链表节点所保存的值；
free 函数用于释放链表节点所保存的值；
match 函数则用于对比链表节点所保存的值和另一个输入值是否相等。

利用list表头管理链表信息的好处：

head和tail指针：对于链表的头结点和尾结点操作的复杂度为O(1)。

len 链表长度计数器：获取链表中节点数量的复杂度为O(1)。
dup、free和match指针：实现多态，链表节点listNode使用万能指针void *保存节点的值，而表头list使用dup、free和match指针来针对链表中存放的不同对象从而实现不同的方法。

下图是由一个 list 结构和三个 listNode 结构组成的链表：

3 链表迭代器

在adlist.h文件中，使用C语言实现了迭代器，源码如下：

/*
* 双端链表迭代器
*/
typedef struct listIter {

// 当前迭代到的节点
listNode *next;

// 迭代的方向
// #define AL_START_HEAD 0，正向迭代：从表头向表尾进行迭代
// #define AL_START_TAIL 1，反向迭代：从表尾到表头进行迭代
int direction;

} listIter;

在listDup函数中就使用了迭代器，listDup函数的定义如下：

list *listDup(list *orig)
{
    list *copy;
    listIter *iter;
    listNode *node;

    // 创建新链表
    if ((copy = listCreate()) == NULL)
        return NULL;

    // 设置节点值处理函数
    copy->dup = orig->dup;
    copy->free = orig->free;
    copy->match = orig->match;

    // 迭代整个输入链表
    iter = listGetIterator(orig, AL_START_HEAD);
    while((node = listNext(iter)) != NULL) {
        void *value;

        // 复制节点值到新节点
        if (copy->dup) {
            value = copy->dup(node->value);
            if (value == NULL) {
                listRelease(copy);
                listReleaseIterator(iter);
                return NULL;
            }
        } else
            value = node->value;

        // 将节点添加到链表
        if (listAddNodeTail(copy, value) == NULL) {
            listRelease(copy);
            listReleaseIterator(iter);
            return NULL;
        }
    }

    // 释放迭代器
    listReleaseIterator(iter);

    // 返回副本
    return copy;
}

迭代器的好处：

提供一种方法顺序访问一个聚合对象中各个元素, 而又不需暴露该对象的内部表示。
将指针操作进行了统一封装，代码可读性增强。