Redis实现之链表

链表

链表提供了高效的节点重排能力，以及顺序性的节点访问顺序，并且可以通过增删节点来灵活地调整链表的长度。作为一种常用数据结构，链表内置在很多高级的编程语言里面，因为Redis使用的C语言并没有内置这种数据结构，所以Redis构建了自己的链表实现。链表在Redis中的应用非常广泛，比如列表键的底层实现之一就是链表。当一个列表键包含了数量比较多的元素，又或者列表中包含的元素都是比较长的字符串时，Redis就会使用链表作为列表键的底层实现

举个栗子，以下的示例中list1和list2都是列表键，只不过list1和list2元素的推入方式不一样，list1是使用的是LPUSH命令，从左到右（从头部）添加元素，list2使用的是RPUSH命令，从右到左（从尾部）添加元素

127.0.0.1:6379> LPUSH list1 "foo"
(integer) 1
127.0.0.1:6379> LPUSH list1 "bar"
(integer) 2
127.0.0.1:6379> LPUSH list1 "test"
(integer) 3
127.0.0.1:6379> LPUSH list1 "hello"
(integer) 4
127.0.0.1:6379> LPUSH list1 "world"
(integer) 5
127.0.0.1:6379> LLEN list1
(integer) 5
127.0.0.1:6379> LRANGE list1 0 2
1) "world"
2) "hello"
3) "test"
127.0.0.1:6379> RPUSH list2 "foo"
(integer) 1
127.0.0.1:6379> RPUSH list2 "bar"
(integer) 2
127.0.0.1:6379> RPUSH list2 "test"
(integer) 3
127.0.0.1:6379> RPUSH list2 "hello"
(integer) 4
127.0.0.1:6379> RPUSH list2 "world"
(integer) 5
127.0.0.1:6379> LLEN list2
(integer) 5
127.0.0.1:6379> LRANGE list2 0 2
1) "foo"
2) "bar"
3) "test"

　　

list1和list2列表键的底层实现就是一个链表，链表中的每个节点都保存了一个字符串。除了链表键之外，发布与订阅、慢查询、监视器等功能也用到了链表，Redis服务器本身还使用链表来保存多个客户端的状态信息，以及使用链表来构建客户端输出缓冲区

链表和链表节点的实现

adlist.h

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

　　

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

图1-1   由多个listNode组成的双端链表

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

adlist.h

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成员则是用于实现多态链表所需的类型特定函数：

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

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

图1-2   由list结构和listNode结构组成的链表

Redis的链表实现的特性可以总结如下：

• 双端：链表节点带有prev和next指针，获取某个节点的前置节点和后置节点的复杂度都为O(1)
• 无环：表头节点的prev指针和表尾节点的next指针都指向NULL，对链表的访问以NULL为终点
• 带表头指针和表尾指针：通过list结构的head指针和tail指针，程序获取链表的表头节点和表尾节点的时间复杂度为O(1)
• 带链表长度计数器：程序使用list结构的len属性来对list持有的链表节点进行计数，程序获取链表长度的时间复杂度为O(1)
• 多态：链表节点使用void*指针来保存节点值，并且可以通过list结构的dup、free、match三个属性为节点值设置类型特定函数，所以链表可以用于保存各个不同类型的值

链表和链表节点的API

表1-1列出了所有用于操作链表和链表节点的API

表1-1   链表和链表节点API

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