作者 / 以码为梯

排版 / 以码为梯

文章字数 / 3297

阅读时长 / 10分钟

希望大家可以从本文有所收获

在每天五分钟学习REDIS之字符串相关命令这篇文章中，主要介绍了Redis中字符串类型相关的命令。这篇文章主要从插入元素、删除元素、修改元素、查询列表、列表间元素移动这五个方面来介绍Redis中列表（Lists）相关的命令及其用法。

需要注意的是命令中对于索引（index）的指定可以是正数也可以是负数。

当指定的索引为大于等于0时，0表示第一个元素，1表示第二个元素，以此类推。

当指定的索引为负数时，-1表示最后一个元素，-2表示倒数第二个元素，以此类推。

另外一个需要注意的是，如果列表中的元素都被删除变成了一个空数组，那么对应的键也就不存在了，也就是说列表为空跟键不存在是一个意思。

插入元素

插入元素分为将元素插入列表头部位置、将元素插入列表尾部位置、在指定元素前/后插入新元素。

• 将元素插入列表头部位置

命令LPUSH、LPUSHX用于将元素插入列表头部位置，其中的L可以理解为left（左）（即将元素插入列表最左侧（列表头）），X可以理解为EXIST（即键存在时才能成功插入）。

两个命令在执行成功之后都会返回成功插入元素之后列表的长度。

两个命令都可以同时插入多个元素（元素之间通过空格隔开）。因为每次插入都是插入头部位置，所以后插入的元素在前面（即执行LPUSH newlist 1 2 3时，查询得出结果为[3,2,1]）。

两个命令的区别在于在键不存在时LPUSH可以成功插入元素而LPUSHX则不会成功。

• 将元素插入列表尾部位置

命令RPUSH、RPUSHX用于将元素插入列表尾部位置，其中的R可以理解为right（右）（即将元素插入列表最右侧（列表尾部）），X可以理解为EXIST（即键存在时才能成功插入）。

两个命令在执行成功之后都会返回成功插入元素之后列表的长度。

两个命令都可以同时插入多个元素（元素之间通过空格隔开）。因为每次插入都是插入尾部位置，所以参数的顺序跟插入完成之后列表中顺序是一样的（即执行LPUSH newlist 1 2 3时，查询得出结果为[1,2,3]）。

• 在指定元素前/后插入指定元素

命令LINSERT用于在指定元素前/后插入新元素。命令的格式如下：

LINSERT key BEFORE|AFTER pivot element

命令的意思是在键（key）对应列表中找到值为指定值（pivot）的元素，并在其前（BEFORE）或后（AFTER)插入新元素（element）。

需要注意的是，如果列表中存在多个跟指定值相同的元素，该命令只会在第一个符合条件的元素后面插入新元素。

在键不存在时，该命令不会进行任何操作；在命令执行成功之后返回插入新值后列表的长度；如果键对应的值不是列表类型，命令返回错误。

删除元素

删除元素分为从列表头/尾删除元素、从列表头/尾删除元素的阻塞版本、删除列表中指定的元素、截取指定索引内的元素（可以理解为删除去除索引范围之外的元素）

• 从列表头/尾删除元素

在Redis中通过LPOP命令从列表头删除元素、通过RPOP命令从列表尾删除元素，其中L可以理解为left，R可以理解为right。命令的语法为：

LPOP/RPOP key [count]

默认情况下这两个命令只会删除处于列表头或列表尾的一个元素，在指定选项count（大于等于0的正整数）的情况下，该命令就会删除从首位/末尾开始的count个元素。

在不加选项count时，命令执行成功返回被删除的元素；

在加上选项count后，命令执行成功以数组的形式返回被删除的元素，且返回结果中的元素按照被删除的先后顺序排序。

• 从列表头/尾删除元素的阻塞版本

REDIS中通过BLPOP、BRPOP来实现从列表头/尾删除元素的阻塞版本。阻塞的意思是在键不存在（也可以说列表为空）时，命令会被阻塞住，直到列表中有新元素加入或者阻塞时间到达设定的时间才会结束阻塞。这里的B是block的意思。命令的语法如下：

BLPOP/BRPOP key [key …] timeout

从语法上可以看出来，在使用BLPOP/BRPOP时可以指定多个键，并且需要指定阻塞时间（timeout为0时表示无限期阻塞）。只有在指定的所有键都不存在时，执行命令时才会被阻塞，只要任何一个键对应的列表中存在值命令就不会被阻塞，并返回参数中从左往右数第一个列表不为空的键和对应的被删除的值。

对于可阻塞的删除操作有下面两点点需要注意的：

如果多个客户端被同一个key堵塞，那么在key中插入新元素时，阻塞时间长的客户端优先从阻塞状态中释放出来。

如果一个客户端被多个键阻塞，这些键对应的列表又因为事务或者Lua脚本的原因同时拥有了新的元素，那么客户端会因为第一个接收到PUSH命令的键解锁。

• 删除列表中指定的元素

REDIS中通过LREM命令来删除值为指定值的元素。其语法如下：

LREM key count element

count选项的不同命令的执行效果也不同：

count>0时，从前往后匹配，删除值为element的count个元素

count<0时，从后往前匹配，删除值为element的count的绝对值个元素

count=0时，删除所有值为element的元素

• 截取指定索引范围内的元素

REDIS中通过LTRIM命令截取列表指定范围内的元素，命令的语法如下：

LTRIM key start stop

其中start和stop为指定的索引（此处索引符合本文开头对索引的介绍）。

数组越界并不会产生错误，如果start大于列表长度或者start大于end，则返回空列表，并且会导致键被删除。如果end大于列表长度，redis将其视为最大长度处理。

修改元素

REDIS中提供了LSET命令来修改列表中指定索引的元素的值，命令行的语法如下：

LSET key index element

命令中的index符合本文开头对索引的描述。命令在索引超出列表长度时会报错。

查询列表

查询列表包含了获取列表长度、获取指定索引位置的元素、获取指定索引范围内的元素、获取指定元素的索引。

• 获取列表长度

REDIS中使用LLEN命令来获取键对应列表的长度，键不存在的情况命令返回0，键对应的值不是列表类型时返回错误。

• 根据索引查找内容

REDIS中使用LINDEX命令来获取指定索引位置的元素，命令的语法如下：

LINDEX key index

命令中的index符合在本文刚开始提到的索引的解释。

• 获取指定索引范围内的元素

REDIS中使用LRANGE命令来获取指定索引位置的元素，命令的语法如下：

LRANGE key start stop

命令中的start和stop都为索引，返回的结果包含start和stop位置的元素。

该命令的返回情况有以下几种可能：

指定的开始索引越界，命令不会报错并返回一个空列表。

指定的start大于stop，返回一个空的列表。

指定的stop大于列表长度，REDIS会将其视为最后一个元素，返回从start到最后一位之间的元素

• 获取指定元素的索引

REDIS中使用LPOS来获取指定元素在列表中的索引，命令的格式如下：

LPOS key element [RANK rank] [COUNT num-matches] [MAXLEN len]

该命令返回键对应的列表中第一次匹配element的元素的索引。下面介绍下每个参数的作用：

RANK

在参数（rank）的值大于0时，起到的作用是指定返回第rank个匹配的元素的索引，1代表返回第一个匹配到的元素的索引，2代表返回第二个匹配到的元素的索引，以此类推。

在参数（rank）的值小于0时，起到的作用是查找匹配元素的方向修改为从尾到头。

COUNT

指定COUNT选项之后，返回是匹配的COUNT个元素的索引的数组。指定了COUNT参数后，如果列表中没有找到匹配的元素则返回空数组。

在COUNT为0时命令将返回所有匹配的元素的索引。

MAXLEN

指定需要比较的列表的长度，当MAXLEN设置为0时，则表示需要比较所有元素。

列表间元素移动

Redis提供了LMOVE、BLMOVE、RPOPLPUSH、BRPOPLPUSH命令来实现在列表之间移动元素。

• LMOVE、BLMOVE

/**
* source代表源列表
* destination代表目标列表
* 第一个LEFT|RIGHT表示是取出源列表的头（LEFT）/尾（RIGHT）元素
* 第二个LEFT|RIGHT表示是将源列表中取出的元素插入到目标列表的头（LEFT）/尾（RIGHT）
*/
LMOVE source destination LEFT|RIGHT LEFT|RIGHT

BLMOVE是在source列表为空时会阻塞，直到source列表中插入新值或者到达设定的超时时间才解除阻塞。

• RPOPLPUSH、BRPOPLPUSH

RPOPLPUSH source destination

RPOPLPUSH从字面意思上就可以知道该命令的作用，RPOP代表将源列表的尾部元素取出，LPUSH代表插入目标列表的头部。可以发现该命令实现了LMOVE命令的部分功能（LMOVE source destination RIGHT LEFT）。

BRPOPLPUSH是RPOPLPUSH的阻塞版本，在源列表为空时命令执行会被阻塞，直到源列表中插入新元素或到达设定的超时时间才解除阻塞。

到这里REDIS中LIST相关的命令就已经介绍完了，很高兴大家能读到这里，希望本文对大家有所帮助。

你的点赞评论是我最大的动力