Redis的雙向鏈表一文全知道
本文轉載自微信公眾號「學習Java的小姐姐」，作者學習Java的小姐姐0618 。轉載本文請聯系學習Java的小姐姐公眾號。
前言
hello，又見面了。不要問為什么，問就是勤勞。馬上要開啟爆更模式啦。
在Redis中鏈表List的應用非常廣泛，但是Redis是采用C語言來寫，底層采用雙向鏈表實現(這邊提一嘴，如果是科班出身或者大學有學過數據結構的同學，可以劃走啦)。我們今天的重點就是雙向鏈表。
API使用
先來使用一下API。如果之前有用過的同學，可以直接跳到下一小節。
lpush左側插入數據
使用lpush命令往list的左側中插入a，b，c三個字符，這邊注意順序，查詢出來的是c，b，a。下面會說為什么，先挖個坑。
rpush右側插入數據
使用rpush命令往list中插入d，e兩個字符，查詢出來的順序是和我們想的一樣，最后兩位是d，e。
刪除某個數據
使用lrem命令刪除a字符，那么中間1代表什么意思呢?其為count，表示移除列表中與a相等的元素個數。即如果count>0，表示從表頭開始向表尾搜索，移除count個與a相等的元素。如果count<0，表示從表尾開始向表頭搜索，移除count個與a相等的元素。如果count=0，移除所有與a相等的元素，因為是移除所有，所以不管從表頭還是表尾，結果是一樣的。
修改某個數據
使用lset命令將mylist的下標為1的元素修改為dd，原來list為c ,b，d，e，修改后的結果為c，dd，d，e。
具體邏輯圖
這邊看不懂沒關系，下面會針對每個模塊詳細說明。
雙向鏈表的定義
節點ListNode
包括頭指針prev，尾指針next，當前的值value，如下圖所示。每個節點都有兩個指針，既能從表頭根據尾指針找到表尾，又能從表尾根據頭指針prev找到表頭，如果將他們連起來，就構成了雙向鏈表。
具體代碼如下：
- //定義鏈表節點的結構體
- typedef struct listNode {
- //前面一個節點的指針
- struct listNode *prev;
- //后面一個節點的指針
- struct listNode *next;
- //當前節點的值的指針 ，因為值的類型不確定
- void *value;
- } listNode;
整體架構
包括頭指針head，尾指針tail，整個鏈表長度len，一些函數(個人認為不重要，如果有知道的小伙伴歡迎評論)，如下圖所示。頭指針head指向整個鏈表的第一個節點，尾指針tail指向整個鏈表的最后一個節點。
具體代碼如下：
- //定義鏈表，對鏈表節點的再封裝
- 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表結構，首先需要判斷當前是否有可分配的空間來創建，使用zmalloc方法來分配空間，如果分配不了，則返回NULL，如果可以分配，則繼續。接著賦值list的頭節點head和尾節點tail為NULL，len為0，賦值相關函數為NULL。最后返回結果list。
- //創建一個表頭，返回值是鏈表結構的指針
- 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;
清空表
傳入list的指針，首先定義當前節點current，使其指向頭指針，定義len，使其等于list的長度。接著進行循環，每次len減一，定義新節點next，始終指向當前節點current的下一個節點，如果有值，則釋放該節點，當前節點current后移，next節點同樣后移。直到len為0，釋放完所有節點，退出循環。最后賦值list的頭節點head和尾節點tail為NULL，len為0。
注意：這邊和SDS一樣，清空并不是直接刪除list，而是刪除其數據，外層的list結構仍然存在。這其實上是惰性刪除。
- void listEmpty(list *list)
- {
- unsigned long len;
- //定義兩個節點指針current和next
- listNode *current, *next;
- //當前節點指針current指向list的頭節點位置，即list的第一個數據
- current = list->head;
- //len為list的長度
- len = list->len;
- //開始循環，每次len減1
- while(len--) {
- //先讓下一個指針指向下一個節點，因為底下直接釋放當前節點，如果不在此處復制，底下就獲取不到了
- next = current->next;
- //釋放當前節點的值
- if (list->free) list->free(current->value);
- //釋放當前節點
- zfree(current);
- //當前節點等于剛才的下一個節點next，即開始往后移，開始下一輪循環
- current = next;
- }
- //釋放完給頭指針head,尾指針tail賦值為NULL
- list->head = list->tail = NULL;
- //len賦值0
- list->len = 0;
- }
添加元素到表頭
添加元素到表頭，首先新建一個新節點node，判斷是否有內存分配，如果有，則繼續，如果沒有，則返回NULL，退出方法。這邊新節點是用來存在輸入參數中的value的，所以需要內存。接著將新節點node的value值賦值為輸入參數value。最后需要調整list的頭指針，尾指針，原來第一個節點的指針情況(這邊看下圖，描述起來有點混亂，圖片一目了然)。最最后，就是list的len加1，返回list。
舉個例子，如果要在list中插入節點f，首先將節點的頭指針賦值為空(對應步驟1)，然后將新節點的尾指針next指向第一個節點(對應步驟2)，將第一個節點的prev指向新節點(對應步驟3)，最后將list的頭指針head指向新節點(對應步驟4)。這邊需要注意的是，步驟2和步驟3需要在步驟4前面，不然會找到第一個節點。
具體代碼如下：
- //添加一個元素到表頭
- list *listAddNodeHead(list *list, void *value)
- {
- listNode *node;
- if ((node = zmalloc(sizeof(*node))) == NULL)
- return NULL;
- node->value = value;//為當前節點賦值
- //如果當前list為空
- if (list->len == 0) {
- list->head = list->tail = node;//頭尾指針都指向該節點
- node->prev = node->next = NULL;//當前節點的頭尾指針都為null
- } else {//如果當前list不為空
- node->prev = NULL;//新節點的頭指針為null
- node->next = list->head;//新節點的尾指針指向原來的尾指針
- list->head->prev = node;//原來的第一個節點的頭指針指向新節點
- list->head = node;//鏈表的頭指針指向新節點
- }
- list->len++;//list長度+1
- return list;
- }
添加元素到表尾
添加元素到表尾，首先新建一個新節點node，判斷是否有內存分配，如果有，則繼續，如果沒有，則返回NULL，退出方法。這邊新節點是用來存在輸入參數中的value的，所以需要內存。接著將新節點node的value值賦值為輸入參數value。最后需要調整list的頭指針，尾指針，原來最后一個節點的指針情況(這邊看下圖，描述起來有點混亂，圖片一目了然)。最最后，就是list的len加1，返回list。
舉個例子，如果要在list中插入節點f，首先將節點的尾指針賦值為空(對應步驟1)，然后將新節點的頭指針指向最后一個節點(對應步驟2)，將最后一個節點的next指向新節點(對應步驟3)，最后將list的尾指針tail指向新節點(對應步驟4)。
步驟如下：
- //添加元素到表尾
- list *listAddNodeTail(list *list, void *value)
- {
- //新建節點node
- listNode *node;
- //嘗試分配內存
- if ((node = zmalloc(sizeof(*node))) == NULL)
- return NULL;
- //為新節點node賦值
- 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;
- }
- //len加1
- list->len++;
- return list;
- }
插入
為list的某個節點old_node的after(大于0為前面新增，小于0為后面新增)新增新值value，首先新建一個新節點node，判斷是否有內存分配，如果有，則繼續，如果沒有，則返回NULL，退出方法。這邊新節點是用來存在輸入參數中的value的，所以需要內存。接著根據after的值確定是在節點old_node的前面新增數據，還是在節點old_node的后面新增數據，具體的是指針的調整。最后len加1，返回list。
- //在list的某個位置old_node的after(前后)插入value值
- 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) {//大于0
- node->prev = old_node;
- node->next = old_node->next;
- if (list->tail == old_node) {
- list->tail = node;
- }
- } else {//小于0
- 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，如果該節點的前面存在節點，使其前面一個節點的next指針指向node后面一個節點的地址，其實就是跳過了node節點，如果該節點的前面不存在節點，則將list的頭指針指向node的下一節點地址。同樣的，如果該節點的后面存在節點，邏輯一樣的。最后釋放要刪除的節點node內存，len減1。
- //從鏈表list中刪除某個節點node
- 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;
- //釋放當前節點node的值
- if (list->free) list->free(node->value);
- //釋放內存
- zfree(node);
- //len-1
- list->len--;
- }
總結
該篇主要講了Redis的list數據類型的底層實現雙向鏈表adlist，先從list的一些API使用，引出雙向鏈表數據結構，進而結合源碼對雙向鏈表進行描述，包括節點listNode和list的頭指針和尾指針，最后針對list的往表頭插入元素，往表尾插入元素，刪除，修改等方法進行源碼解析，使其對雙向鏈表有更清晰的認識。
如果覺得寫得還行，麻煩給個贊👍，您的認可才是我寫作的動力!
