Redis `LPUSHX` 与 `RPUSHX`：仅当 Key 存在时才进行列表操作

大家好，欢迎来到今天的Redis奇妙之旅！今天我们要聊的是Redis列表操作中的两个小可爱，它们的名字有点长，分别是LPUSHX和RPUSHX。它们俩有个共同的特点：它们都是“有条件”的插入操作，只有当指定的Key（也就是列表的名字）存在时，它们才会往列表里添加元素。如果Key不存在？哼，它们会傲娇地拒绝，啥也不干。

为什么要用LPUSHX和RPUSHX？

你可能会问，直接用LPUSH和RPUSH不香吗？为啥还要搞这么两个“条件怪”？想象一下这样的场景：

并发控制：多个客户端同时尝试初始化一个列表。你只想让第一个客户端成功，后面的客户端如果发现列表已经存在，就啥也不做。LPUSHX/RPUSHX可以帮你实现这种原子性的“创建即初始化”操作。
避免意外覆盖：你有一个非常重要的列表，里面存着宝贵的数据。你只想在确保这个列表已经存在的情况下，才允许向它添加新元素，防止因为Key不存在而意外创建一个空列表，导致数据丢失。

简单来说，LPUSHX和RPUSHX就像两个小心谨慎的门卫，只有确认大门（Key）已经存在时，才允许新人（元素）进入。

LPUSHX：左侧插入，存在才行

LPUSHX key element [element ...]

LPUSHX 的作用是，只有当key对应的列表存在时，才将指定的element（可以是一个或多个）插入到列表的左侧（头部）。如果key不存在，LPUSHX啥也不做，直接返回0。如果key存在，则返回更新后的列表的长度。

让我们用代码来演示一下：

import redis

# 连接Redis
r = redis.Redis(host='localhost', port=6379, db=0)

# 先删除可能存在的my_list，方便演示
r.delete('my_list')

# 尝试使用LPUSHX向不存在的列表插入元素
result = r.lpushx('my_list', 'value1')
print(f"LPUSHX to non-existent list: {result}")  # 输出: 0

# 创建一个列表
r.lpush('my_list', 'initial_value')

# 再次使用LPUSHX向已存在的列表插入元素
result = r.lpushx('my_list', 'value2')
print(f"LPUSHX to existing list: {result}")  # 输出: 2

# 查看列表内容
list_content = r.lrange('my_list', 0, -1)
print(f"List content: {list_content}")  # 输出: [b'value2', b'initial_value']

在上面的例子中，我们首先尝试向一个不存在的列表my_list插入元素，LPUSHX返回0，表示插入失败。然后，我们使用LPUSH创建了my_list，并插入了一个初始值。接着，我们再次使用LPUSHX向my_list插入元素，这次LPUSHX成功了，返回2，表示列表的长度变成了2。最后，我们查看列表的内容，确认value2被插入到了列表的头部。

RPUSHX：右侧插入，存在才行

RPUSHX key element [element ...]

RPUSHX 和 LPUSHX 类似，只不过它是往列表的右侧（尾部）插入元素。同样，只有当key对应的列表存在时，RPUSHX才会将指定的element插入到列表的尾部。如果key不存在，RPUSHX啥也不做，返回0。如果key存在，则返回更新后的列表长度。

让我们也用代码来演示一下：

import redis

# 连接Redis
r = redis.Redis(host='localhost', port=6379, db=0)

# 先删除可能存在的my_list，方便演示
r.delete('my_list')

# 尝试使用RPUSHX向不存在的列表插入元素
result = r.rpushx('my_list', 'value1')
print(f"RPUSHX to non-existent list: {result}")  # 输出: 0

# 创建一个列表
r.lpush('my_list', 'initial_value') # 这里用lpush创建，顺序不会影响RPUSHX的结果

# 再次使用RPUSHX向已存在的列表插入元素
result = r.rpushx('my_list', 'value2')
print(f"RPUSHX to existing list: {result}")  # 输出: 2

# 查看列表内容
list_content = r.lrange('my_list', 0, -1)
print(f"List content: {list_content}")  # 输出: [b'initial_value', b'value2']

这个例子和LPUSHX的例子非常相似，唯一的区别是这次我们使用了RPUSHX，所以value2被插入到了列表的尾部。

LPUSHX vs RPUSHX：对比一下

为了更清晰地了解LPUSHX和RPUSHX，我们用一个表格来对比一下：

特性	`LPUSHX`	`RPUSHX`
插入位置	列表头部（左侧）	列表尾部（右侧）
前提条件	Key必须存在	Key必须存在
返回值	列表更新后的长度 (存在)	列表更新后的长度 (存在)
返回值	0 (不存在)	0 (不存在)

实际应用场景

除了前面提到的并发控制和避免意外覆盖，LPUSHX和RPUSHX还有一些其他的应用场景：

消息队列：你可以使用一个列表作为消息队列，生产者使用RPUSH向队列尾部添加消息，消费者使用LPOP从队列头部取出消息。为了防止消费者在队列不存在时尝试消费，你可以使用RPUSHX来确保只有在队列已经存在的情况下，生产者才能向队列中添加消息。
任务调度：你可以使用一个列表来存储待执行的任务，调度器使用LPUSH向列表头部添加任务，工作者使用RPOP从列表尾部取出任务。同样，为了防止调度器在任务列表不存在时尝试添加任务，你可以使用LPUSHX来确保只有在任务列表已经存在的情况下，调度器才能向列表中添加任务。
数据校验：在某些场景下，你可能需要先验证某个Key是否存在，然后再根据Key是否存在来决定是否执行某个操作。LPUSHX和RPUSHX可以帮你简化这个过程，因为它们本身就包含了Key存在性的检查。

注意事项

原子性：LPUSHX和RPUSHX都是原子操作，这意味着它们在执行过程中不会被其他操作中断。这对于并发环境非常重要。
性能：LPUSHX和RPUSHX的性能与LPUSH和RPUSH相当，因为它们只是在LPUSH和RPUSH的基础上增加了一个Key存在性的检查。
返回值：记住LPUSHX和RPUSHX的返回值，0表示Key不存在，插入失败；其他值表示Key存在，插入成功，并且返回值是更新后的列表长度。

与其他命令的比较

我们再来看看LPUSHX/RPUSHX 和其他类似命令的一些区别：

LPUSH/RPUSH vs LPUSHX/RPUSHX: LPUSH 和 RPUSH 无条件地将元素插入到列表的头部或尾部。它们会创建列表如果该key不存在。 LPUSHX 和 RPUSHX 则只有在key存在时才执行插入操作。
SETNX + LPUSH/RPUSH: 你可以使用SETNX (Set If Not Exists) 来创建一个key，如果该key不存在。然后，你可以使用 LPUSH 或 RPUSH 来将元素插入到该列表中。但是，这需要两个命令，而不是一个原子命令。LPUSHX/RPUSHX 提供了一个原子操作。
EXISTS + LPUSH/RPUSH: 你可以先使用EXISTS 命令来检查key是否存在，然后再使用 LPUSH 或 RPUSH。这同样需要两个命令，并且不是原子性的。在并发环境中，可能存在竞态条件，导致问题。

命令组合	优点	缺点
`LPUSH` / `RPUSH`	简单直接，无条件插入	如果Key不存在，会创建新的列表，可能导致意外的数据插入
`SETNX` + `LPUSH` / `RPUSH`	可以保证Key只被创建一次	需要两个命令，非原子操作，在高并发场景下可能存在竞态条件
`EXISTS` + `LPUSH` / `RPUSH`	可以先检查Key是否存在，避免盲目插入	需要两个命令，非原子操作，在高并发场景下可能存在竞态条件，例如，在 `EXISTS` 返回true之后， `LPUSH`/`RPUSH` 之前，Key可能被删除，导致程序出错
`LPUSHX` / `RPUSHX`	原子性操作，保证Key存在才插入，避免竞态条件，简化代码逻辑	只能用于Key已经存在的情况，不能用于创建新的Key

进阶：Lua脚本的替代方案

虽然LPUSHX和RPUSHX提供了原子性的条件插入操作，但在某些复杂的场景下，你可能需要更灵活的控制。这时候，你可以使用Lua脚本来实现更复杂的逻辑。

例如，你可以使用Lua脚本来实现一个“如果列表不存在，则创建列表并初始化，否则向列表尾部添加元素”的操作：

-- KEYS[1]: 列表的Key
-- ARGV[1]: 要添加的元素

local key = KEYS[1]
local value = ARGV[1]

-- 检查Key是否存在
if redis.call('EXISTS', key) == 0 then
  -- Key不存在，创建列表并初始化
  redis.call('RPUSH', key, value)
  return 1 -- 表示创建并添加成功
else
  -- Key存在，向列表尾部添加元素
  return redis.call('RPUSH', key, value) -- 返回列表长度
end

你可以使用EVAL命令来执行这个Lua脚本：

import redis

r = redis.Redis(host='localhost', port=6379, db=0)

script = """
local key = KEYS[1]
local value = ARGV[1]

if redis.call('EXISTS', key) == 0 then
  redis.call('RPUSH', key, value)
  return 1
else
  return redis.call('RPUSH', key, value)
end
"""

# 创建一个Redis Lua脚本对象
r_script = r.register_script(script)

# 执行脚本，KEYS=['my_list'], ARGV=['my_value']
result = r_script(keys=['my_list'], args=['my_value'])
print(f"Lua script result: {result}")

# 查看列表内容
list_content = r.lrange('my_list', 0, -1)
print(f"List content: {list_content}")

Lua脚本的优点是它可以将多个Redis命令组合成一个原子操作，从而实现更复杂的逻辑。但缺点是学习成本较高，并且调试起来比较麻烦。因此，在选择使用LPUSHX/RPUSHX还是Lua脚本时，需要根据实际情况进行权衡。

总结

LPUSHX和RPUSHX是Redis列表中两个非常有用的命令，它们可以在Key存在的情况下，原子性地向列表的头部或尾部添加元素。它们可以用于并发控制、避免意外覆盖、消息队列、任务调度等场景。虽然Lua脚本可以实现更复杂的逻辑，但在简单的情况下，LPUSHX和RPUSHX是更简单、更高效的选择。

希望今天的讲解能够帮助你更好地理解和使用LPUSHX和RPUSHX。记住，熟练掌握这些小技巧，可以让你在Redis的世界里更加游刃有余！感谢大家的收听，下次再见！

发表回复 取消回复

发表回复取消回复