3、List操作

一、概述：

在Redis中，List類型是按照插入順序排序的字符串鏈表。和數據結構中的普通鏈表一樣，我們可以在其頭部(left)和尾部(right)添加新的元素。在插入時，如果該鍵並不存在，Redis將爲該鍵創建一個新的鏈表。與此相反，如果鏈表中所有的元素均被移除，那麼該鍵也將會被從數據庫中刪除。List中可以包含的最大元素數量是4294967295。
從元素插入和刪除的效率視角來看，如果我們是在鏈表的兩頭插入或刪除元素，這將會是非常高效的操作，即使鏈表中已經存儲了百萬條記錄，該操作也可以在常量時間內完成。然而需要說明的是，如果元素插入或刪除操作是作用於鏈表中間，那將會是非常低效的。相信對於有良好數據結構基礎的開發者而言，這一點並不難理解。

二、相關命令列表：

命令原型 時間複雜度 命令描述 返回值
LPUSH key value [value …] O(1) 在指定Key所關聯的List Value的頭部插入參數中給出的所有Values。如果該Key不存在，該命令將在插入之前創建一個與該Key關聯的空鏈表，之後再將數據從鏈表的頭部插入。如果該鍵的Value不是鏈表類型，該命令將返回相關的錯誤信息。 插入後鏈表中元素的數量。
LPUSHX key value O(1) 僅有當參數中指定的Key存在時，該命令纔會在其所關聯的List Value的頭部插入參數中給出的Value，否則將不會有任何操作發生。 插入後鏈表中元素的數量。
LRANGE key start stop O(S+N) 時間複雜度中的S爲start參數表示的偏移量，N表示元素的數量。該命令的參數start和end都是0-based。即0表示鏈表頭部(leftmost)的第一個元素。其中start的值也可以爲負值，-1將表示鏈表中的最後一個元素，即尾部元素，-2表示倒數第二個並以此類推。該命令在獲取元素時，start和end位置上的元素也會被取出。如果start的值大於鏈表中元素的數量，空鏈表將會被返回。如果end的值大於元素的數量，該命令則獲取從start(包括start)開始，鏈表中剩餘的所有元素。 返回指定範圍內元素的列表。
LPOP key O(1) 返回並彈出指定Key關聯的鏈表中的第一個元素，即頭部元素，。如果該Key不存，返回nil。 鏈表頭部的元素。
LLEN key O(1) 返回指定Key關聯的鏈表中元素的數量，如果該Key不存在，則返回0。如果與該Key關聯的Value的類型不是鏈表，則返回相關的錯誤信息。 鏈表中元素的數量。
LREM key count value O(N) 時間複雜度中N表示鏈表中元素的數量。在指定Key關聯的鏈表中，刪除前count個值等於value的元素。如果count大於0，從頭向尾遍歷並刪除，如果count小於0，則從尾向頭遍歷並刪除。如果count等於0，則刪除鏈表中所有等於value的元素。如果指定的Key不存在，則直接返回0。 返回被刪除的元素數量。
LSET key index value O(N) 時間複雜度中N表示鏈表中元素的數量。但是設定頭部或尾部的元素時，其時間複雜度爲O(1)。設定鏈表中指定位置的值爲新值，其中0表示第一個元素，即頭部元素，-1表示尾部元素。如果索引值Index超出了鏈表中元素的數量範圍，該命令將返回相關的錯誤信息。
LINDEX key index O(N) 時間複雜度中N表示在找到該元素時需要遍歷的元素數量。對於頭部或尾部元素，其時間複雜度爲O(1)。該命令將返回鏈表中指定位置(index)的元素，index是0-based，表示頭部元素，如果index爲-1，表示尾部元素。如果與該Key關聯的不是鏈表，該命令將返回相關的錯誤信息。 返回請求的元素，如果index超出範圍，則返回nil。
LTRIM key start stop O(N) N表示被刪除的元素數量。該命令將僅保留指定範圍內的元素，從而保證鏈接中的元素數量相對恆定。start和stop參數都是0-based，0表示頭部元素。和其他命令一樣，start和stop也可以爲負值，-1表示尾部元素。如果start大於鏈表的尾部，或start大於stop，該命令不錯報錯，而是返回一個空的鏈表，與此同時該Key也將被刪除。如果stop大於元素的數量，則保留從start開始剩餘的所有元素。
LINSERT key BEFORE|AFTER pivot value O(N) 時間複雜度中N表示在找到該元素pivot之前需要遍歷的元素數量。這樣意味着如果pivot位於鏈表的頭部或尾部時，該命令的時間複雜度爲O(1)。該命令的功能是在pivot元素的前面或後面插入參數中的元素value。如果Key不存在，該命令將不執行任何操作。如果與Key關聯的Value類型不是鏈表，相關的錯誤信息將被返回。 成功插入後鏈表中元素的數量，如果沒有找到pivot，返回-1，如果key不存在，返回0。
RPUSH key value [value …] O(1) 在指定Key所關聯的List Value的尾部插入參數中給出的所有Values。如果該Key不存在，該命令將在插入之前創建一個與該Key關聯的空鏈表，之後再將數據從鏈表的尾部插入。如果該鍵的Value不是鏈表類型，該命令將返回相關的錯誤信息。 插入後鏈表中元素的數量。
RPUSHX key value O(1) 僅有當參數中指定的Key存在時，該命令纔會在其所關聯的List Value的尾部插入參數中給出的Value，否則將不會有任何操作發生。 插入後鏈表中元素的數量。
RPOP key O(1) 返回並彈出指定Key關聯的鏈表中的最後一個元素，即尾部元素，。如果該Key不存，返回nil。 鏈表尾部的元素。
RPOPLPUSH source destination O(1) 原子性的從與source鍵關聯的鏈表尾部彈出一個元素，同時再將彈出的元素插入到與destination鍵關聯的鏈表的頭部。如果source鍵不存在，該命令將返回nil，同時不再做任何其它的操作了。如果source和destination是同一個鍵，則相當於原子性的將其關聯鏈表中的尾部元素移到該鏈表的頭部。 返回彈出和插入的元素。
三、命令示例：

1. LPUSH/LPUSHX/LRANGE:
   /> redis-cli #在Shell提示符下啓動redis客戶端工具。
   redis 127.0.0.1:6379> del mykey
   (integer) 1
   mykey鍵並不存在，該命令會創建該鍵及與其關聯的List，之後在將參數中的values從左到右依次插入。
   redis 127.0.0.1:6379> lpush mykey a b c d
   (integer) 4
   取從位置0開始到位置2結束的3個元素。
   redis 127.0.0.1:6379> lrange mykey 0 2
   1) “d”
   2) “c”
   3) “b”
   取鏈表中的全部元素，其中0表示第一個元素，-1表示最後一個元素。
   redis 127.0.0.1:6379> lrange mykey 0 -1
   1) “d”
   2) “c”
   3) “b”
   4) “a”
   mykey2鍵此時並不存在，因此該命令將不會進行任何操作，其返回值爲0。
   redis 127.0.0.1:6379> lpushx mykey2 e
   (integer) 0
   可以看到mykey2沒有關聯任何List Value。
   redis 127.0.0.1:6379> lrange mykey2 0 -1
   (empty list or set)
   mykey鍵此時已經存在，所以該命令插入成功，並返回鏈表中當前元素的數量。
   redis 127.0.0.1:6379> lpushx mykey e
   (integer) 5
   獲取該鍵的List Value的頭部元素。
   redis 127.0.0.1:6379> lrange mykey 0 0
   1) “e”

2. LPOP/LLEN:
   redis 127.0.0.1:6379> lpush mykey a b c d
   (integer) 4
   redis 127.0.0.1:6379> lpop mykey
   “d”
   redis 127.0.0.1:6379> lpop mykey
   “c”
   在執行lpop命令兩次後，鏈表頭部的兩個元素已經被彈出，此時鏈表中元素的數量是2
   redis 127.0.0.1:6379> llen mykey
   (integer) 2

   1. LREM/LSET/LINDEX/LTRIM:
      爲後面的示例準備測試數據。
      redis 127.0.0.1:6379> lpush mykey a b c d a c
      (integer) 6
      從頭部(left)向尾部(right)變量鏈表，刪除2個值等於a的元素，返回值爲實際刪除的數量。
      redis 127.0.0.1:6379> lrem mykey 2 a
      (integer) 2
      看出刪除後鏈表中的全部元素。
      redis 127.0.0.1:6379> lrange mykey 0 -1
      1) “c”
      2) “d”
      3) “c”
      4) “b”
      獲取索引值爲1(頭部的第二個元素)的元素值。
      redis 127.0.0.1:6379> lindex mykey 1
      “d”
      將索引值爲1(頭部的第二個元素)的元素值設置爲新值e。
      redis 127.0.0.1:6379> lset mykey 1 e
      OK
      查看是否設置成功。
      redis 127.0.0.1:6379> lindex mykey 1
      “e”
      索引值6超過了鏈表中元素的數量，該命令返回nil。
      redis 127.0.0.1:6379> lindex mykey 6
      (nil)
      設置的索引值6超過了鏈表中元素的數量，設置失敗，該命令返回錯誤信息。
      redis 127.0.0.1:6379> lset mykey 6 hh
      (error) ERR index out of range
      僅保留索引值0到2之間的3個元素，注意第0個和第2個元素均被保留。
      redis 127.0.0.1:6379> ltrim mykey 0 2
      OK
      查看trim後的結果。
      redis 127.0.0.1:6379> lrange mykey 0 -1
      1) “c”
      2) “e”
      3) “c”

3. LINSERT:
   刪除該鍵便於後面的測試。
   redis 127.0.0.1:6379> del mykey
   (integer) 1
   爲後面的示例準備測試數據。
   redis 127.0.0.1:6379> lpush mykey a b c d e
   (integer) 5
   在a的前面插入新元素a1。
   redis 127.0.0.1:6379> linsert mykey before a a1
   (integer) 6
   查看是否插入成功，從結果看已經插入。注意lindex的index值是0-based。
   redis 127.0.0.1:6379> lindex mykey 0
   “e”
   在e的後面插入新元素e2，從返回結果看已經插入成功。
   redis 127.0.0.1:6379> linsert mykey after e e2
   (integer) 7
   再次查看是否插入成功。
   redis 127.0.0.1:6379> lindex mykey 1
   “e2”
   在不存在的元素之前或之後插入新元素，該命令操作失敗，並返回-1。
   redis 127.0.0.1:6379> linsert mykey after k a
   (integer) -1
   爲不存在的Key插入新元素，該命令操作失敗，返回0。
   redis 127.0.0.1:6379> linsert mykey1 after a a2
   (integer) 0

4. RPUSH/RPUSHX/RPOP/RPOPLPUSH:
   刪除該鍵，以便於後面的測試。
   redis 127.0.0.1:6379> del mykey
   (integer) 1
   從鏈表的尾部插入參數中給出的values，插入順序是從左到右依次插入。
   redis 127.0.0.1:6379> rpush mykey a b c d
   (integer) 4
   通過lrange的可以獲悉rpush在插入多值時的插入順序。
   redis 127.0.0.1:6379> lrange mykey 0 -1
   1) “a”
   2) “b”
   3) “c”
   4) “d”
   該鍵已經存在並且包含4個元素，rpushx命令將執行成功，並將元素e插入到鏈表的尾部。
   redis 127.0.0.1:6379> rpushx mykey e
   (integer) 5
   通過lindex命令可以看出之前的rpushx命令確實執行成功，因爲索引值爲4的元素已經是新元素了。
   redis 127.0.0.1:6379> lindex mykey 4
   “e”
   由於mykey2鍵並不存在，因此該命令不會插入數據，其返回值爲0。
   redis 127.0.0.1:6379> rpushx mykey2 e
   (integer) 0
   在執行rpoplpush命令前，先看一下mykey中鏈表的元素有哪些，注意他們的位置關係。
   redis 127.0.0.1:6379> lrange mykey 0 -1
   1) “a”
   2) “b”
   3) “c”
   4) “d”
   5) “e”
   將mykey的尾部元素e彈出，同時再插入到mykey2的頭部(原子性的完成這兩步操作)。
   redis 127.0.0.1:6379> rpoplpush mykey mykey2
   “e”
   通過lrange命令查看mykey在彈出尾部元素後的結果。
   redis 127.0.0.1:6379> lrange mykey 0 -1
   1) “a”
   2) “b”
   3) “c”
   4) “d”
   通過lrange命令查看mykey2在插入元素後的結果。
   redis 127.0.0.1:6379> lrange mykey2 0 -1
   1) “e”
   將source和destination設爲同一鍵，將mykey中的尾部元素移到其頭部。
   redis 127.0.0.1:6379> rpoplpush mykey mykey
   “d”
   查看移動結果。
   redis 127.0.0.1:6379> lrange mykey 0 -1
   1) “d”
   2) “a”
   3) “b”
   4) “c”

四、鏈表結構的小技巧：
針對鏈表結構的Value，Redis在其官方文檔中給出了一些實用技巧，如RPOPLPUSH命令，下面給出具體的解釋。
Redis鏈表經常會被用於消息隊列的服務，以完成多程序之間的消息交換。假設一個應用程序正在執行LPUSH操作向鏈表中添加新的元素，我們通常將這樣的程序稱之爲”生產者(Producer)”，而另外一個應用程序正在執行RPOP操作從鏈表中取出元素，我們稱這樣的程序爲”消費者(Consumer)”。如果此時，消費者程序在取出消息元素後立刻崩潰，由於該消息已經被取出且沒有被正常處理，那麼我們就可以認爲該消息已經丟失，由此可能會導致業務數據丟失，或業務狀態的不一致等現象的發生。然而通過使用RPOPLPUSH命令，消費者程序在從主消息隊列中取出消息之後再將其插入到備份隊列中，直到消費者程序完成正常的處理邏輯後再將該消息從備份隊列中刪除。同時我們還可以提供一個守護進程，當發現備份隊列中的消息過期時，可以重新將其再放回到主消息隊列中，以便其它的消費者程序繼續處理。