Redis学习（二）——链表

一、链表的结构

typedef struct listNode { //链表节点

    // 前置节点
    struct listNode *prev;

    // 后置节点
    struct listNode *next;

    // 节点的值
    void *value;

} listNode;


typedef struct listIter { //链表迭代器

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

    // 迭代的方向
    int direction;

} listIter;

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;

在redis里的链表底层结构就是上面的代码，resdis这么设计大概有如下的优点或特点

• 双端链表，可双向迭代
• 带有表头指针和表尾指针，可快速的获取表头表尾指针
• 有Len记录长度，可以快速获得链表长度
• 多态，链表节点使用void* value 保存节点值，并且可以通过list结构的dup，free ,match三个属性为节点值设置特定函数，所以链表可以用于保存不同类型的值。

二、链表的API

第一部分是用宏实现的一些函数。一部分原因是自己也确实好长时间没写过C了，另一部分原因可能是自己写Java写魔怔了。这部分看了有一会儿没看懂。

#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) // 返回给定节点的值
#define listSetDupMethod(l,m) ((l)->dup = (m)) // 将链表 l 的值复制函数设置为 m
#define listSetFreeMethod(l,m) ((l)->free = (m))  // 将链表 l 的值释放函数设置为 m
#define listSetMatchMethod(l,m) ((l)->match = (m))  // 将链表的对比函数设置为 m
#define listGetDupMethod(l) ((l)->dup)    // 返回给定链表的值复制函数
#define listGetFree(l) ((l)->free)  // 返回给定链表的值释放函数
#define listGetMatchMethod(l) ((l)->match)  // 返回给定链表的值对比函数

宏就是将前面的内容替换为后面的内容 所以我们写一个listLength(l)的时候它就是 l->len，当然前提是你的这个l就是一个listnode节点。这样我们就得到了它的长度。这其实感觉它的功能就是Java里的getter一样， 不过更简洁一点

下面的一些就是上面可能会调用的函数

list *listCreate(void);                                 //创建一个表头
void listRelease(list *list);                           //释放list表头和链表
list *listAddNodeHead(list *list, void *value);         //将value添加到list链表的头部
list *listAddNodeTail(list *list, void *value);         //将value添加到list链表的尾部
list *listInsertNode(list *list, listNode *old_node, void *value, int after);//在list中，根据after在old_node节点前后插入值为value的节点
void listDelNode(list *list, listNode *node);           //从list删除node节点
listIter *listGetIterator(list *list, int direction);   //为list创建一个迭代器iterator
listNode *listNext(listIter *iter);                     //返回迭代器iter指向的当前节点并更新iter       
void listReleaseIterator(listIter *iter);               //释放iter迭代器
list *listDup(list *orig);                              //拷贝表头为orig的链表并返回
listNode *listSearchKey(list *list, void *key);         //在list中查找value为key的节点并返回
listNode *listIndex(list *list, long index);            //返回下标为index的节点地址
void listRewind(list *list, listIter *li);              //将迭代器li重置为list的头结点并且设置为正向迭代
void listRewindTail(list *list, listIter *li);          //将迭代器li重置为list的尾结点并且设置为反向迭代
void listRotate(list *list);                            //将尾节点插到头结点

三、链表api源码

1.listCreate

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;
}

2.listRelease

void listRelease(list *list)
{//释放这个链表
    unsigned long len;
    listNode *current, *next;

    // 指向头指针
    current = list->head;
    // 遍历整个链表
    len = list->len;
    while(len--) {
        next = current->next;

        // 如果有设置值释放函数，那么调用它
        if (list->free) list->free(current->value);

        // 释放节点结构
        zfree(current);

        current = next;
    }

    // 释放链表结构
    zfree(list);
}

3.listAddNodeHead

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;
}

4.listAddNodeTail

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;
}

5.listInsertNode

*
 * 创建一个包含值 value 的新节点，并将它插入到 old_node 的之前或之后
 *
 * 如果 after 为 0 ，将新节点插入到 old_node 之前。
 * 如果 after 为 1 ，将新节点插入到 old_node 之后。
 *
 */
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;
}

6.listDelNode

void listDelNode(list *list, listNode *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--;
}

7.listGetIterator

listIter *listGetIterator(list *list, int direction)
{  //为list创建一个迭代器
    // 为迭代器分配内存
    listIter *iter;
    if ((iter = zmalloc(sizeof(*iter))) == NULL) return NULL;

    // 根据迭代方向，设置迭代器的起始节点
    if (direction == AL_START_HEAD)
        iter->next = list->head;
    else
        iter->next = list->tail;

    // 记录迭代方向
    iter->direction = direction;

    return iter;
}

8.listReleaseItertor

void listReleaseIterator(listIter *iter) {  //释放迭代器的内存
    zfree(iter);
}

9.listRewind

/*
 * 将迭代器的方向设置为 AL_START_HEAD ，
 * 并将迭代指针重新指向表头节点。
 */
void listRewind(list *list, listIter *li) {
    li->next = list->head;
    li->direction = AL_START_HEAD;
}

10.listRewindTail

/*
 * 将迭代器的方向设置为 AL_START_TAIL ，
 * 并将迭代指针重新指向表尾节点。
 *
 * T = O(1)
 */
void listRewindTail(list *list, listIter *li) {
    li->next = list->tail;
    li->direction = AL_START_TAIL;
}

11.listNext

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;
}

12.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;
}

13.listSearchKey

listNode *listSearchKey(list *list, void *key)
{  //寻找第一个值为key的listnode，没有返回NULL
    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;
}

14.listIndex

listNode *listIndex(list *list, long index) { //寻找索引为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;
}

15.listRotate

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;
}