咱们知道,数据结构中,链表的最大好处就是能高效的实现动态增、删、改,缺点就是遍历访问比较慢,所以,在Redis中,不少功能的底层实现都是基于链表的,由于Redis是基于C语言来写的,因此只能本身实现本身的链表结构。对于一个常规的双向链表节点,咱们一般使用下面的方式来定义: java
typedef struct Node{ void *value; struct Node *prev; struct Node *next; }Node;
Redis中,在adlist.h中也是这样子定义的 node
typedef struct listNode { // 前置节点 struct listNode *prev; // 后置节点 struct listNode *next; // 节点的值 void *value; } listNode;
上面的node定义就是链表的每一个元素了。在Redis中,同时定义了一个双向链表,并给这个链表定义了三个操做函数(方法): 数据结构
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;
同时,也定义了一个双向链表的迭代器 函数
typedef struct listIter { // 当前迭代到的节点 listNode *next; // 迭代的方向,有从头至尾,也有从尾到头的方向 int direction; } listIter;
看到了上面的双向节点,咱们可能会问在Redis中,他是采用有环的链表呢仍是无环链表?咱们之后的功能来看,由于要实现有环的链表只须要使用list的head的prev不为NULL、tail的next不为NULL便可实现。 spa
在adlist.h中,同时定义了一堆宏,用来实现简单的函数功能 指针
// 返回给定链表所包含的节点数量 #define listLength(l) ((l)->len) // 返回给定链表的表头节点 #define listFirst(l) ((l)->head) // 返回给定链表的表尾节点 #define listLast(l) ((l)->tail) // 返回给定节点的前置节点 #define listPrevNode(n) ((n)->prev) // 返回给定节点的后置节点 #define listNextNode(n) ((n)->next) // 返回给定节点的值 #define listNodeValue(n) ((n)->value) // 将链表 l 的值复制函数设置为 m #define listSetDupMethod(l,m) ((l)->dup = (m)) // 将链表 l 的值释放函数设置为 m #define listSetFreeMethod(l,m) ((l)->free = (m)) // 将链表的对比函数设置为 m #define listSetMatchMethod(l,m) ((l)->match = (m)) // 返回给定链表的值复制函数 #define listGetDupMethod(l) ((l)->dup) // 返回给定链表的值释放函数 #define listGetFree(l) ((l)->free) // 返回给定链表的值对比函数 #define listGetMatchMethod(l) ((l)->match)
上面定义了基本的获取一个链表的常规属性的函数(宏),根据咱们对一个数据结构的经常使用操做方式,下面就应该是定义建立、初始化、增长、删除等的方法(函数)了。 code
//建立一个新列表 list *listCreate(void) { struct list *list; // 分配内存 if ((list = zmalloc(sizeof(*list))) == NULL) return NULL; // 初始化属性 list->head = list->tail = NULL; list->len = 0; list->dup = NULL; list->free = NULL; list->match = NULL; return list; }//释放整个链表以及链表里面的节点 void listRelease(list *list) { unsigned long len; listNode *current, *next; // 指向头指针,我对于这里的写法,总会以为有问题,加入list==NULL呢? current = list->head; // 遍历整个链表 len = list->len; while(len--) { next = current->next; // 若是有设置值释放函数,那么调用它 if (list->free) list->free(current->value); // 释放节点结构 zfree(current); current = next; } // 释放链表结构 zfree(list); }
//用一个指定的value值建立一个node加入到list的头部 list *listAddNodeHead(list *list, void *value) { listNode *node; // 为节点分配内存 if ((node = zmalloc(sizeof(*node))) == NULL) return NULL; // 保存值指针 node->value = value; // 添加节点到空链表 if (list->len == 0) { list->head = list->tail = node; node->prev = node->next = NULL; // 添加节点到非空链表 } else { node->prev = NULL; node->next = list->head; list->head->prev = node; list->head = node; } // 更新链表节点数 list->len++; return list; }
//用一个指定的value来建立node,并加到list的末尾 list *listAddNodeTail(list *list, void *value) { listNode *node; // 为新节点分配内存 if ((node = zmalloc(sizeof(*node))) == NULL) return NULL; // 保存值指针 node->value = value; // 目标链表为空 if (list->len == 0) { list->head = list->tail = node; node->prev = node->next = NULL; // 目标链表非空 } else { node->prev = list->tail; node->next = NULL; list->tail->next = node; list->tail = node; } // 更新链表节点数 list->len++; return list; }
//用指定的value来建立一个node,并根据传入的after参数来判断是要添加到指定的节点以前仍是以后 list *listInsertNode(list *list, listNode *old_node, void *value, int after) { listNode *node; // 建立新节点 if ((node = zmalloc(sizeof(*node))) == NULL) return NULL; // 保存值 node->value = value; // 将新节点添加到给定节点以后 if (after) { node->prev = old_node; node->next = old_node->next; // 给定节点是原表尾节点 if (list->tail == old_node) { list->tail = node; } // 将新节点添加到给定节点以前 } else { node->next = old_node; node->prev = old_node->prev; // 给定节点是原表头节点 if (list->head == old_node) { list->head = node; } } // 更新新节点的前置指针 if (node->prev != NULL) { node->prev->next = node; } // 更新新节点的后置指针 if (node->next != NULL) { node->next->prev = node; } // 更新链表节点数 list->len++; return list; }
//从list中删除指定的node void listDelNode(list *list, listNode *node) { // 调整前置节点的指针,我在用java来编写程序的时候,特别惧怕这种写法,由于遇到空指针的时候,这里必定会报错,因此,下面的node是否应该先要判断是否为空 if (node->prev) node->prev->next = node->next; else list->head = node->next; // 调整后置节点的指针 if (node->next) node->next->prev = node->prev; else list->tail = node->prev; // 释放值 if (list->free) list->free(node->value); // 释放节点 zfree(node); // 链表数减一 list->len--; }
//为特定的list建立迭代器 listIter *listGetIterator(list *list, int direction) { // 为迭代器分配内存 listIter *iter; if ((iter = zmalloc(sizeof(*iter))) == NULL) return NULL; // 根据迭代方向,设置迭代器的起始节点 if (direction == AL_START_HEAD)//这里的AL_START_HEAD==0 iter->next = list->head; else iter->next = list->tail; // 记录迭代方向 iter->direction = direction; return iter; }
//得到迭代器当前的节点,由于返回的都是指针,因此,是能够改变的 listNode *listNext(listIter *iter) { listNode *current = iter->next; if (current != NULL) { // 根据方向选择下一个节点 if (iter->direction == AL_START_HEAD) // 保存下一个节点,防止当前节点被删除而形成指针丢失 iter->next = current->next; else // 保存下一个节点,防止当前节点被删除而形成指针丢失 iter->next = current->prev; } return current; }
//释放迭代器 void listReleaseIterator(listIter *iter) { zfree(iter); }
//复制整个list,须要注意的是,若是原始的list的dup属性为空,那么,先后两个list会共享节点的指针,所以,要特别当心 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; }
//在列表中寻找第一次出现指定key的节点,须要注意的是,若是在list中的节点的match函数为空,那么就直接比较value的指针,找到了第一个就返回,找不到就返回为NULL listNode *listSearchKey(list *list, void *key) { listIter *iter; listNode *node; // 迭代整个链表 iter = listGetIterator(list, AL_START_HEAD); while((node = listNext(iter)) != NULL) { // 对比 if (list->match) { if (list->match(node->value, key)) { listReleaseIterator(iter); // 找到 return node; } } else { if (key == node->value) { listReleaseIterator(iter); // 找到 return node; } } } listReleaseIterator(iter); // 未找到 return NULL; }//查找list中指定索引的节点,节点能够为正数,也能够是负数,当为负数的时候,-1表明list的tail,依次类推,若是不为负数,那么,索引就是从0开始的 listNode *listIndex(list *list, long index) { listNode *n; // 若是索引为负数,从表尾开始查找 if (index < 0) { index = (-index)-1; n = list->tail; while(index-- && n) n = n->prev; // 若是索引为正数,从表头开始查找 } else { n = list->head; while(index-- && n) n = n->next; } return n; }
索引
内存
接下来的两个函数,根据名字就能够看出来,倒回,什么意思呢?就是讲list的迭代器的
//设置为head->tail void listRewind(list *list, listIter *li) { li->next = list->head; li->direction = AL_START_HEAD; }
//设置为tail->head void listRewindTail(list *list, listIter *li) { li->next = list->tail; li->direction = AL_START_TAIL; }
接下来的这个函数,总以为名字和他实现的内容不匹配,这个函数要实现的是将链表的tail挪成list的head。 it
void listRotate(list *list) { listNode *tail = list->tail; if (listLength(list) <= 1) return; /* Detach current tail */ // 取出表尾节点 list->tail = tail->prev; list->tail->next = NULL; /* Move it as head */ // 插入到表头 list->head->prev = tail; tail->prev = NULL; tail->next = list->head; list->head = tail; }好了,Redis的List基本就是这样子啦