「Redis设计与实现」链表篇

链表简介

链表提供了高效的节点重排能力， 以及顺序性的节点访问方式， 并且可以通过增删节点来灵活地调整链表的长度。作为一种常用数据结构， 链表内置在很多高级的编程语言里面， 因为 Redis 使用的 C 语言并没有内置这种数据结构， 所以 Redis 构建了自己的链表实现。

链表及链表节点的实现

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

typedef struct listNode {
    struct listNode *prev; /* 前置节点 */
    struct listNode *next; /* 后置节点 */
    void *value; /* 节点值 */
} listNode;

• Reids还定义了链表结构，用于持有链表

typedef struct list {
    listNode *head; /* 表头结点 */
    listNode *tail; /* 表尾结点 */
    void *(*dup)(void *ptr); /* 节点复制函数 */
    void (*free)(void *ptr); /* 节点释放函数 */
    int (*match)(void *ptr, void *key); 
    unsigned long len; /* 链表节点数量 */
} list;

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

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

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

list持有listNode示例.png

这样定义好处是

1. 快速获取链表的头尾
2. 快速查询链表的节点数，像动态字符串sdshr里的len那样，不用遍历全部字符就可以获取字符串的长度，这里也类似。

• adlist.h/listIter还定义了迭代器

typedef struct listIter {
    listNode *next; /* 当前迭代到的节点 */
    int direction; /* 迭代方向 */
} listIter;
/* Directions for iterators 
 *
 * 迭代器进行迭代的方向
 */
// 从表头向表尾进行迭代
#define AL_START_HEAD 0
// 从表尾到表头进行迭代
#define AL_START_TAIL 1

可以这样迭代

iter = listGetIterator(list, AL_START_HEAD);
while ((node = listNext(iter)) != NULL) {
    doSomethingWith(node);
}

链表和链表节点的API

函数	作用	时间复杂度
listSetDupMethod	将给定的函数设置为链表的节点值复制函数。	O(1)
listGetDupMethod	返回链表当前正在使用的节点值复制函数。	复制函数可以通过链表的 dup 属性直接获得， O(1)
listSetFreeMethod	将给定的函数设置为链表的节点值释放函数。	O(1)
listGetFree	返回链表当前正在使用的节点值释放函数。	释放函数可以通过链表的 free 属性直接获得， O(1)
listSetMatchMethod	将给定的函数设置为链表的节点值对比函数。	O(1)
listGetMatchMethod	返回链表当前正在使用的节点值对比函数。	对比函数可以通过链表的 match 属性直接获得， O(1)
listLength	返回链表的长度（包含了多少个节点）。	链表长度可以通过链表的 len 属性直接获得， O(1)
listFirst	返回链表的表头节点。	表头节点可以通过链表的 head 属性直接获得， O(1)
listLast	返回链表的表尾节点。	表尾节点可以通过链表的 tail 属性直接获得， O(1)
listPrevNode	返回给定节点的前置节点。	前置节点可以通过节点的 prev 属性直接获得， O(1)
listNextNode	返回给定节点的后置节点。	后置节点可以通过节点的 next 属性直接获得， O(1)
listNodeValue	返回给定节点目前正在保存的值。	节点值可以通过节点的 value 属性直接获得， O(1)
listCreate	创建一个不包含任何节点的新链表。	O(1)
listAddNodeHead	将一个包含给定值的新节点添加到给定链表的表头。	O(1)
listAddNodeTail	将一个包含给定值的新节点添加到给定链表的表尾。	O(1)
listInsertNode	将一个包含给定值的新节点添加到给定节点的之前或者之后。	O(1)
listSearchKey	查找并返回链表中包含给定值的节点。	O(N) ， N 为链表长度
listIndex	返回链表在给定索引上的节点。	O(N) ， N 为链表长度
listDelNode	从链表中删除给定节点。	O(1)
listRotate	将链表的表尾节点弹出，然后将被弹出的节点插入到链表的表头， 成为新的表头节点。	O(1)
listDup	复制一个给定链表的副本。	O(N) ， N 为链表长度
listRelease	释放给定链表，以及链表中的所有节点。	O(N) ， N 为链表长度