点击上方“Java大讲堂”蓝字关注我们
Redis 支持的数据结构包括 字符串(strings), 散列(hashes), 列表(lists), 集合(sets), 有序集合(sorted sets) 与范围查询, bitmaps, hyperloglogs和 地理空间(geospatial) 索引半径查询。
本文主要针对其中列表(lists)相关的命令进行讲解。
很多童鞋可能对lists(列表)不是很了解,在这里我简单的介绍一下这种结构。
其实Java中的ArrayList就是列表的一种实现,我们可以把列表想象成为平时买东西排的队,一般新来的人需要排到对尾,当然牛逼的人也可以直接排在对头,也可以在任意位置插队。现实中我们可以这么做,当然队列也可以这么做了,注意列表的元素是允许重复的哦。
Redis中的队列大概就是这样,一个key关联一个队列
Redis中列表相关的命令都是以L开头的
01
—
LPUSH
作用: 将一个或多个值 value
插入到列表 key
的表头
如果有多个 value
值,那么各个 value
值按从左到右的顺序依次插入到表头:比如说,对空列表 mylist
执行命令 LPUSH mylist a b c
,列表的值将是 c b a
,这等同于原子性地执行 LPUSH mylist a
、 LPUSH mylist b
和 LPUSH mylist c
三个命令。
如果 key
不存在,一个空列表会被创建并执行 LPUSH 操作。
当 key
存在但不是列表类型时,返回一个错误。
格式: LPUSH key value [value …]
返回值:执行 LPUSH 命令后,列表的长度。
# 加入单个元素redis> LPUSH languages python(integer) 1# 加入重复元素redis> LPUSH languages python(integer) 2redis> LRANGE languages 0 -1 # 列表允许重复元素1) "python"2) "python"# 加入多个元素redis> LPUSH mylist a b c(integer) 3redis> LRANGE mylist 0 -11) "c"2) "b"3) "a"
02
—
LPUSHX
作用: 将值 value
插入到列表 key
的表头,当且仅当 key
存在并且是一个列表。
和 LPUSH key value [value …] 命令相反,当 key
不存在时, LPUSHX 命令什么也不做。
格式: LPUSHX key value
返回值:LPUSHX 命令执行之后,表的长度。
# 对空列表执行 LPUSHXredis> LLEN greet # greet 是一个空列表(integer) 0redis> LPUSHX greet "hello" # 尝试 LPUSHX,失败,因为列表为空(integer) 0# 对非空列表执行 LPUSHXredis> LPUSH greet "hello" # 先用 LPUSH 创建一个有一个元素的列表(integer) 1redis> LPUSHX greet "good morning" # 这次 LPUSHX 执行成功(integer) 2redis> LRANGE greet 0 -11) "good morning"2) "hello"
03
—
RPUSH
作用: 将一个或多个值 value
插入到列表 key
的表尾(最右边)。
如果有多个 value
值,那么各个 value
值按从左到右的顺序依次插入到表尾:比如对一个空列表 mylist
执行 RPUSH mylist a b c
,得出的结果列表为 a b c
,等同于执行命令 RPUSH mylist a
、 RPUSH mylist b
、 RPUSH mylist c
。
如果 key
不存在,一个空列表会被创建并执行 RPUSH 操作。
当 key
存在但不是列表类型时,返回一个错误。
格式: RPUSH key value [value …]
返回值: 执行 RPUSH 操作后,表的长度。
# 添加单个元素redis> RPUSH languages c(integer) 1# 添加重复元素redis> RPUSH languages c(integer) 2redis> LRANGE languages 0 -1 # 列表允许重复元素1) "c"2) "c"# 添加多个元素redis> RPUSH mylist a b c(integer) 3redis> LRANGE mylist 0 -11) "a"2) "b"3) "c"
04
—
RPUSHX
作用:
将值 value
插入到列表 key
的表尾,当且仅当 key
存在并且是一个列表。
和 RPUSH key value [value …] 命令相反,当 key
不存在时, RPUSHX 命令什么也不做。
格式: RPUSHX key value
返回值:RPUSHX 命令执行之后,表的长度。
# key不存在redis> LLEN greet(integer) 0redis> RPUSHX greet "hello" # 对不存在的 key 进行 RPUSHX,PUSH 失败。(integer) 0# key 存在且是一个非空列表redis> RPUSH greet "hi" # 先用 RPUSH 插入一个元素(integer) 1redis> RPUSHX greet "hello" # greet 现在是一个列表类型,RPUSHX 操作成功。(integer) 2redis> LRANGE greet 0 -11) "hi"2) "hello"
05
—
LPOP
作用: 移除并返回列表 key
的头元素。
格式: LPOP key
返回值:列表的头元素。当 key
不存在时,返回 nil
。
redis> LLEN course(integer) 0redis> RPUSH course algorithm001(integer) 1redis> RPUSH course c++101(integer) 2redis> LPOP course # 移除头元素"algorithm001"
06
—
RPOP
作用: 移除并返回列表 key
的尾元素。
格式: RPOP key
返回值:列表的尾元素。 当 key
不存在时,返回 nil
。
redis> RPUSH mylist "one"(integer) 1redis> RPUSH mylist "two"(integer) 2redis> RPUSH mylist "three"(integer) 3redis> RPOP mylist # 返回被弹出的元素"three"redis> LRANGE mylist 0 -1 # 列表剩下的元素1) "one"2) "two"
07
—
RPOPLPUSH
作用:
命令 RPOPLPUSH 在一个原子时间内,执行以下两个动作:
将列表
source
中的最后一个元素(尾元素)弹出,并返回给客户端。将
source
弹出的元素插入到列表destination
,作为destination
列表的的头元素。
举个例子,你有两个列表 source
和 destination
, source
列表有元素 a, b, c
, destination
列表有元素 x, y, z
,执行 RPOPLPUSH source destination
之后, source
列表包含元素 a, b
, destination
列表包含元素 c, x, y, z
,并且元素 c
会被返回给客户端。
如果 source
不存在,值 nil
被返回,并且不执行其他动作。
如果 source
和 destination
相同,则列表中的表尾元素被移动到表头,并返回该元素,可以把这种特殊情况视作列表的旋转(rotation)操作。
格式: RPOPLPUSH source destination
返回值:被弹出的元素。
# source 和 destination 不同redis> LRANGE alpha 0 -1 # 查看所有元素1) "a"2) "b"3) "c"4) "d"redis> RPOPLPUSH alpha reciver # 执行一次 RPOPLPUSH 看看"d"redis> LRANGE alpha 0 -11) "a"2) "b"3) "c"redis> LRANGE reciver 0 -11) "d"redis> RPOPLPUSH alpha reciver # 再执行一次,证实 RPOP 和 LPUSH 的位置正确"c"redis> LRANGE alpha 0 -11) "a"2) "b"redis> LRANGE reciver 0 -11) "c"2) "d"# source 和 destination 相同redis> LRANGE number 0 -11) "1"2) "2"3) "3"4) "4"redis> RPOPLPUSH number number"4"redis> LRANGE number 0 -1 # 4 被旋转到了表头1) "4"2) "1"3) "2"4) "3"redis> RPOPLPUSH number number"3"redis> LRANGE number 0 -1 # 这次是 3 被旋转到了表头1) "3"2) "4"3) "1"4) "2"
08
—
LREM
作用: 根据参数 count
的值,移除列表中与参数 value
相等的元素。
count
的值可以是以下几种:
count > 0
: 从表头开始向表尾搜索,移除与value
相等的元素,数量为count
。count < 0
: 从表尾开始向表头搜索,移除与value
相等的元素,数量为count
的绝对值。count = 0
: 移除表中所有与value
相等的值。
格式: LREM key count value
返回值: 被移除元素的数量。因为不存在的 key
被视作空表(empty list),所以当 key
不存在时, LREM命令总是返回 0
。
# 先创建一个表,内容排列是# morning hello morning helllo morningredis> LPUSH greet "morning"(integer) 1redis> LPUSH greet "hello"(integer) 2redis> LPUSH greet "morning"(integer) 3redis> LPUSH greet "hello"(integer) 4redis> LPUSH greet "morning"(integer) 5redis> LRANGE greet 0 4 # 查看所有元素1) "morning"2) "hello"3) "morning"4) "hello"5) "morning"redis> LREM greet 2 morning # 移除从表头到表尾,最先发现的两个 morning(integer) 2 # 两个元素被移除redis> LLEN greet # 还剩 3 个元素(integer) 3redis> LRANGE greet 0 21) "hello"2) "hello"3) "morning"redis> LREM greet -1 morning # 移除从表尾到表头,第一个 morning(integer) 1redis> LLEN greet # 剩下两个元素(integer) 2redis> LRANGE greet 0 11) "hello"2) "hello"redis> LREM greet 0 hello # 移除表中所有 hello(integer) 2 # 两个 hello 被移除redis> LLEN greet(integer) 0
09
—
LLEN
作用: 返回列表 key
的长度。
如果 key
不存在,则 key
被解释为一个空列表,返回 0
.
如果 key
不是列表类型,返回一个错误。
格式: LLEN key
返回值:列表 key
的长度。
# 空列表redis> LLEN job(integer) 0# 非空列表redis> LPUSH job "cook food"(integer) 1redis> LPUSH job "have lunch"(integer) 2redis> LLEN job(integer) 2
10
—
LINDEX
作用: 返回列表 key
中,下标为 index
的元素。
下标(index)参数 start
和 stop
都以 0
为底,也就是说,以 0
表示列表的第一个元素,以 1
表示列表的第二个元素,以此类推。
你也可以使用负数下标,以 -1
表示列表的最后一个元素, -2
表示列表的倒数第二个元素,以此类推。
如果 key
不是列表类型,返回一个错误。
格式: LINDEX key index
返回值:列表中下标为 index
的元素。如果 index
参数的值不在列表的区间范围内(out of range),返回 nil
。
redis> LPUSH mylist "World"(integer) 1redis> LPUSH mylist "Hello"(integer) 2redis> LINDEX mylist 0"Hello"redis> LINDEX mylist -1"World"redis> LINDEX mylist 3 # index不在 mylist 的区间范围内(nil)
11
—
LINSERT
作用: 将值 value
插入到列表 key
当中,位于值 pivot
之前或之后。
当 pivot
不存在于列表 key
时,不执行任何操作。
当 key
不存在时, key
被视为空列表,不执行任何操作。
如果 key
不是列表类型,返回一个错误。
格式: LINSERT key BEFORE|AFTER pivot value
返回值:如果命令执行成功,返回插入操作完成之后,列表的长度。如果没有找到 pivot
,返回 -1
。如果 key
不存在或为空列表,返回 0
。
redis> RPUSH mylist "Hello"(integer) 1redis> RPUSH mylist "World"(integer) 2redis> LINSERT mylist BEFORE "World" "There"(integer) 3redis> LRANGE mylist 0 -11) "Hello"2) "There"3) "World"# 对一个非空列表插入,查找一个不存在的 pivotredis> LINSERT mylist BEFORE "go" "let's"(integer) -1 # 失败# 对一个空列表执行 LINSERT 命令redis> EXISTS fake_list(integer) 0redis> LINSERT fake_list BEFORE "nono" "gogogog"(integer) 0 # 失败
12
—
LSET
作用: 将列表 key
下标为 index
的元素的值设置为 value
。
当 index
参数超出范围,或对一个空列表( key
不存在)进行 LSET 时,返回一个错误。
格式: LSET key index value
返回值:操作成功返回 ok
,否则返回错误信息。
# 对空列表(key 不存在)进行 LSETredis> EXISTS list(integer) 0redis> LSET list 0 item(error) ERR no such key# 对非空列表进行 LSETredis> LPUSH job "cook food"(integer) 1redis> LRANGE job 0 01) "cook food"redis> LSET job 0 "play game"OKredis> LRANGE job 0 01) "play game"# index 超出范围redis> LLEN list # 列表长度为 1(integer) 1redis> LSET list 3 'out of range'(error) ERR index out of range
13
—
LRANGE
作用: 返回列表 key
中指定区间内的元素,区间以偏移量 start
和 stop
指定。
下标(index)参数 start
和 stop
都以 0
为底,也就是说,以 0
表示列表的第一个元素,以 1
表示列表的第二个元素,以此类推。
你也可以使用负数下标,以 -1
表示列表的最后一个元素, -2
表示列表的倒数第二个元素,以此类推。
假如你有一个包含一百个元素的列表,对该列表执行 LRANGE list 0 10
,结果是一个包含11个元素的列表,这表明 stop
下标也在 LRANGE 命令的取值范围之内(闭区间),这和某些语言的区间函数可能不一致,比如Ruby的 Range.new
、 Array#slice
和Python的 range()
函数。
超出范围的下标值不会引起错误。
如果 start
下标比列表的最大下标 end
( LLEN list
减去 1
)还要大,那么 LRANGE 返回一个空列表。
如果 stop
下标比 end
下标还要大,Redis将 stop
的值设置为 end
。
格式: LRANGE key start stop
返回值:一个列表,包含指定区间内的元素。
redis> RPUSH fp-language lisp(integer) 1redis> LRANGE fp-language 0 01) "lisp"redis> RPUSH fp-language scheme(integer) 2redis> LRANGE fp-language 0 11) "lisp"2) "scheme"
14
—
LTRIM
作用: 对一个列表进行修剪(trim),就是说,让列表只保留指定区间内的元素,不在指定区间之内的元素都将被删除。
举个例子,执行命令 LTRIM list 0 2
,表示只保留列表 list
的前三个元素,其余元素全部删除。
下标(index)参数 start
和 stop
都以 0
为底,也就是说,以 0
表示列表的第一个元素,以 1
表示列表的第二个元素,以此类推。
你也可以使用负数下标,以 -1
表示列表的最后一个元素, -2
表示列表的倒数第二个元素,以此类推。
当 key
不是列表类型时,返回一个错误。
超出范围的下标值不会引起错误。
如果 start
下标比列表的最大下标 end
( LLEN list
减去 1
)还要大,或者 start > stop
, LTRIM 返回一个空列表(因为 LTRIM 已经将整个列表清空)。
如果 stop
下标比 end
下标还要大,Redis将 stop
的值设置为 end
。
格式: LTRIM key start stop
返回值:命令执行成功时,返回 ok
。
# 情况 1:常见情况, start 和 stop 都在列表的索引范围之内redis> LRANGE alpha 0 -1 # alpha 是一个包含 5 个字符串的列表1) "h"2) "e"3) "l"4) "l"5) "o"redis> LTRIM alpha 1 -1 # 删除 alpha 列表索引为 0 的元素OKredis> LRANGE alpha 0 -1 # "h" 被删除了1) "e"2) "l"3) "l"4) "o"# 情况 2:stop 比列表的最大下标还要大redis> LTRIM alpha 1 10086 # 保留 alpha 列表索引 1 至索引 10086 上的元素OKredis> LRANGE alpha 0 -1 # 只有索引 0 上的元素 "e" 被删除了,其他元素还在1) "l"2) "l"3) "o"# 情况 3:start 和 stop 都比列表的最大下标要大,并且 start < stopredis> LTRIM alpha 10086 123321OKredis> LRANGE alpha 0 -1 # 列表被清空(empty list or set)# 情况 4:start 和 stop 都比列表的最大下标要大,并且 start > stopredis> RPUSH new-alpha "h" "e" "l" "l" "o" # 重新建立一个新列表(integer) 5redis> LRANGE new-alpha 0 -11) "h"2) "e"3) "l"4) "l"5) "o"redis> LTRIM new-alpha 123321 10086 # 执行 LTRIMOKredis> LRANGE new-alpha 0 -1 # 同样被清空(empty list or set)
15
—
BLPOP
作用: BLPOP 是列表的阻塞式(blocking)弹出原语。
它是 LPOP key 命令的阻塞版本,当给定列表内没有任何元素可供弹出的时候,连接将被 BLPOP命令阻塞,直到等待超时或发现可弹出元素为止。
当给定多个 key
参数时,按参数 key
的先后顺序依次检查各个列表,弹出第一个非空列表的头元素。
格式: BLPOP key [key …] timeout
返回值:如果列表为空,返回一个 nil
。否则,返回一个含有两个元素的列表,第一个元素是被弹出元素所属的 key
,第二个元素是被弹出元素的值。
非阻塞行为
当 BLPOP 被调用时,如果给定 key
内至少有一个非空列表,那么弹出遇到的第一个非空列表的头元素,并和被弹出元素所属的列表的名字一起,组成结果返回给调用者。
当存在多个给定 key
时, BLPOP 按给定 key
参数排列的先后顺序,依次检查各个列表。
假设现在有 job
、 command
和 request
三个列表,其中 job
不存在, command
和 request
都持有非空列表。考虑以下命令:
BLPOP job command request 0
BLPOP 保证返回的元素来自 command
,因为它是按”查找 job
-> 查找 command
-> 查找 request
“这样的顺序,第一个找到的非空列表。
redis> DEL job command request # 确保key都被删除(integer) 0redis> LPUSH command "update system..." # 为command列表增加一个值(integer) 1redis> LPUSH request "visit page" # 为request列表增加一个值(integer) 1redis> BLPOP job command request 0 # job 列表为空,被跳过,紧接着 command 列表的第一个元素被弹出。1) "command" # 弹出元素所属的列表2) "update system..." # 弹出元素所属的值
阻塞行为
如果所有给定 key
都不存在或包含空列表,那么 BLPOP 命令将阻塞连接,直到等待超时,或有另一个客户端对给定 key
的任意一个执行 LPUSH key value [value …] 或 RPUSH key value [value …] 命令为止。
超时参数 timeout
接受一个以秒为单位的数字作为值。超时参数设为 0
表示阻塞时间可以无限期延长(block indefinitely) 。
redis> EXISTS job # 确保两个 key 都不存在(integer) 0redis> EXISTS command(integer) 0redis> BLPOP job command 300 # 因为key一开始不存在,所以操作会被阻塞,直到另一客户端对 job 或者 command 列表进行 PUSH 操作。1) "job" # 这里被 push 的是 job2) "do my home work" # 被弹出的值(26.26s) # 等待的秒数redis> BLPOP job command 5 # 等待超时的情况(nil)(5.66s) # 等待的秒数
相同的key被多个客户端同时阻塞
相同的 key
可以被多个客户端同时阻塞。
不同的客户端被放进一个队列中,按『先阻塞先服务』(first-BLPOP,first-served)的顺序为 key
执行 BLPOP 命令。
在MULTI/EXEC事务中的BLPOP
BLPOP 可以用于流水线(pipline,批量地发送多个命令并读入多个回复),但把它用在 MULTI / EXEC块当中没有意义。因为这要求整个服务器被阻塞以保证块执行时的原子性,该行为阻止了其他客户端执行 LPUSH key value [value …] 或 RPUSH key value [value …] 命令。
因此,一个被包裹在 MULTI / EXEC 块内的 BLPOP 命令,行为表现得就像 LPOP key 一样,对空列表返回 nil
,对非空列表弹出列表元素,不进行任何阻塞操作。
# 对非空列表进行操作redis> RPUSH job programming(integer) 1redis> MULTIOKredis> BLPOP job 30QUEUEDredis> EXEC # 不阻塞,立即返回1) 1) "job" 2) "programming"# 对空列表进行操作redis> LLEN job # 空列表(integer) 0redis> MULTIOKredis> BLPOP job 30QUEUEDredis> EXEC # 不阻塞,立即返回1) (nil)
16
—
BRPOP
作用: BRPOP 是列表的阻塞式(blocking)弹出原语。
它是 RPOP key 命令的阻塞版本,当给定列表内没有任何元素可供弹出的时候,连接将被 BRPOP命令阻塞,直到等待超时或发现可弹出元素为止。
当给定多个 key
参数时,按参数 key
的先后顺序依次检查各个列表,弹出第一个非空列表的尾部元素。
格式: BRPOP key [key …] timeout
返回值:假如在指定时间内没有任何元素被弹出,则返回一个 nil
和等待时长。 反之,返回一个含有两个元素的列表,第一个元素是被弹出元素所属的 key
,第二个元素是被弹出元素的值。
redis> LLEN course(integer) 0redis> RPUSH course algorithm001(integer) 1redis> RPUSH course c++101(integer) 2redis> BRPOP course 301) "course" # 被弹出元素所属的列表键2) "c++101" # 被弹出的元素
17
—
BRPOPLPUSH
作用:
BRPOPLPUSH 是 RPOPLPUSH source destination 的阻塞版本,当给定列表 source
不为空时, BRPOPLPUSH 的表现和 RPOPLPUSH source destination 一样。
当列表 source
为空时, BRPOPLPUSH 命令将阻塞连接,直到等待超时,或有另一个客户端对 source
执行 LPUSH key value [value …] 或 RPUSH key value [value …] 命令为止。
超时参数 timeout
接受一个以秒为单位的数字作为值。超时参数设为 0
表示阻塞时间可以无限期延长(block indefinitely) 。
格式: BRPOPLPUSH source destination timeout
返回值:假如在指定时间内没有任何元素被弹出,则返回一个 nil
和等待时长。 反之,返回一个含有两个元素的列表,第一个元素是被弹出元素的值,第二个元素是等待时长。
# 非空列表redis> BRPOPLPUSH msg reciver 500"hello moto" # 弹出元素的值(3.38s) # 等待时长redis> LLEN reciver(integer) 1redis> LRANGE reciver 0 01) "hello moto"# 空列表redis> BRPOPLPUSH msg reciver 1(nil)(1.34s)
请关注本公众号,下一期我们将解锁Redis 集合(Set)的各种姿势。
---------------END----------------
欢迎关注"Java大讲堂",我们将为您分享最专业的Java干货,指引您学习的方向,帮您解答工作中遇到的问题,我们一起努力创造美好的未来。
点赞+在看 对我们很重要哦