在构建高性能应用的世界里,Redis 闪电般的内存数据结构与 C++ 的原生性能相结合,无疑是一剂成功的良方。Redis,常被称为"数据结构服务器",提供了多种功能强大的工具,其中最基础也最核心的之一便是列表(List)。这种有序的字符串集合是实现队列、栈、活动流、消息推送等众多功能的基石。
为了在 C++ 和 Redis 之间架起一座坚实的桥梁,一个健壮的客户端库至关重要。在这方面,redis-plus-plus
以其现代、类型安全和直观的设计脱颖而出。作为一个现代 C++11/14/17 客户端,它将 Redis 命令与开发者熟悉的 C++ 范式(如迭代器、optional
和 chrono
字面量)无缝集成。
本篇深度指南将引导您逐步探索 Redis 列表的核心命令,并通过由 redis-plus-plus
驱动的实用 C++ 代码示例进行实践。我们将详细剖析每一个操作,理解其行为,并领略该库所倡导的优雅设计模式。
第一章:填充列表 ------ "推入"的艺术
向 Redis 列表中添加元素的主要方式是通过"推入"(push)操作。你可以选择将元素添加到列表的头部(左侧)或尾部(右侧),这种设计直接赋予了列表实现栈(后进先出,LIFO)和队列(先进先出,FIFO)的能力。
lpush
:向列表头部(左侧)推入
LPUSH
命令用于将一个或多个元素添加到列表的起始位置。如果列表键不存在,Redis 会在执行操作前自动创建一个空列表。这个过程可以想象成堆叠盘子:每一个新盘子总是放在最上面。
让我们通过一段代码来分析 redis-plus-plus
是如何以多种方式调用 lpush
的。

cpp
#include <iostream>
#include <vector>
#include <string>
#include <iterator> // 使用 std::back_inserter 需要的头文件
#include <sw/redis++/redis++.h>
// 辅助函数,用于打印容器内容
void PrintContainer(const std::vector<std::string>& container) {
for (const auto& item : container) {
std::cout << item << " ";
}
std::cout << std::endl;
}
void test1(sw::redis::Redis& redis)
{
std::cout << "--- 测试 lpush 和 lrange ---" << std::endl;
// 清空当前数据库,确保测试环境干净
redis.flushall();
// 1. 推入单个元素
redis.lpush("key", "111");
// 2. 基于初始化列表,推入一组元素
redis.lpush("key", {"222", "333", "444"});
// 3. 基于迭代器,从一个 vector 推入一组元素
std::vector<string> values = {"555", "666", "777"};
redis.lpush("key", values.begin(), values.end());
// 使用 lrange 获取列表中的所有元素进行验证
std::vector<string> results;
// 构造一个插入迭代器,lrange 的结果会通过它直接填入 results
auto it = std::back_inserter(results);
redis.lrange("key", 0, -1, it);
std::cout << "最终列表内容: ";
PrintContainer(results);
}
代码详解:
redis.flushall()
: 这是一个威力巨大但同时也很危险的命令,它会清空整个 Redis 实例 当前数据库中的所有键。在测试代码中使用它可以确保我们的测试从一个已知的、干净的状态开始。请勿在生产环境中使用此命令,除非你真的打算清除所有数据。redis.lpush("key", "111")
: 我们向名为 "key" 的列表头部推入第一个元素 "111"。- 此时列表状态为:
["111"]
- 此时列表状态为:
redis.lpush("key", {"222", "333", "444"})
: 这是redis-plus-plus
提供的一个非常便利的特性。它重载了lpush
方法,使其可以接受std::initializer_list
(初始化列表)作为参数,让我们可以简洁地一次性推入多个元素。库会按照从左到右的顺序逐个执行lpush
。- 推入 "222" 后,列表变为:
["222", "111"]
- 推入 "333" 后,列表变为:
["333", "222", "111"]
- 推入 "444" 后,列表变为:
["444", "333", "222", "111"]
- 推入 "222" 后,列表变为:
redis.lpush("key", values.begin(), values.end())
: 这是另一种极其灵活的批量操作方式。redis-plus-plus
遵循 C++ 标准库的设计哲学,提供了接受一对迭代器的重载。这意味着你可以从任何兼容的容器(如std::vector
,std::list
,std::deque
)中推入一个范围的元素。其执行顺序与初始化列表类似。- 推入 "555" 后:
["555", "444", "333", "222", "111"]
- 推入 "666" 后:
["666", "555", "444", "333", "222", "111"]
- 推入 "777" 后:
["777", "666", "555", "444", "333", "222", "111"]
- 推入 "555" 后:
redis.lrange("key", 0, -1, it)
:lrange
命令用于获取列表指定范围内的元素。索引0
代表第一个元素,-1
代表最后一个元素,因此0
到-1
表示获取列表中的所有元素。redis-plus-plus
在这里的设计非常巧妙,它没有返回一个自定义的集合类型,而是接受一个输出迭代器 。我们通过std::back_inserter(results)
创建了一个插入迭代器,它会将lrange
获取到的每一个元素通过results.push_back()
添加到results
这个vector
的末尾。
最终结果预测:
由于 lpush
是"头插法",越晚插入的元素越靠前。因此,PrintContainer
函数最终打印到控制台的内容将是:
777 666 555 444 333 222 111
rpush
:向列表尾部(右侧)推入
与 lpush
相对,RPUSH
命令将一个或多个元素添加到列表的末尾。这个行为完全符合队列的"先进先出"(FIFO)原则,就像人们排队一样,新来的人总是排在队尾。

cpp
void test2(sw::redis::Redis& redis)
{
std::cout << "--- 测试 rpush ---" << std::endl;
redis.flushall();
// 1. 推入单个元素
redis.rpush("key", "111");
// 2. 基于初始化列表推入一组元素
redis.rpush("key", {"222", "333", "444"});
// 3. 基于迭代器推入一组元素
std::vector<string> values = {"555", "666", "777"};
redis.rpush("key", values.begin(), values.end());
// 获取并打印结果
std::vector<string> results;
redis.lrange("key", 0, -1, std::back_inserter(results));
std::cout << "最终列表内容: ";
PrintContainer(results);
}
代码详解与 test1
的关键区别:
test2
的结构与 test1
几乎完全相同,唯一的区别就是将所有的 lpush
调用换成了 rpush
。然而,这个小小的改动导致了截然不同的结果。
redis.rpush("key", "111")
: 列表状态:["111"]
redis.rpush("key", {"222", "333", "444"})
:- 推入 "222" 后:
["111", "222"]
- 推入 "333" 后:
["111", "222", "333"]
- 推入 "444" 后:
["111", "222", "333", "444"]
- 推入 "222" 后:
redis.rpush("key", values.begin(), values.end())
:- 推入 "555" 后:
["111", "222", "333", "444", "555"]
- 推入 "666" 后:
["111", "222", "333", "444", "555", "666"]
- 推入 "777" 后:
["111", "222", "333", "444", "555", "666", "777"]
- 推入 "555" 后:
最终结果预测:
rpush
是"尾插法",它严格保持了元素的插入顺序。因此,lrange
获取到的元素顺序与我们添加它们的顺序完全一致。控制台将打印:
111 222 333 444 555 666 777
第二章:消费列表 ------ "弹出"的艺术
有了填充列表的能力,我们还需要从中取出元素进行处理。"弹出"(pop)操作就是为此设计的,它是一个原子性的操作,既能获取元素,又能同时将其从列表中移除。
lpop
& rpop
:从两端弹出元素
LPOP
: 从列表的左侧(头部)移除并返回一个元素。RPOP
: 从列表的右侧(尾部)移除并返回一个元素。
这两个命令是构建可靠工作队列的基础。一个或多个生产者进程通过 LPUSH
或 RPUSH
将任务推入列表,一个或多个消费者进程通过 LPOP
或 RPOP
获取并处理任务。

cpp
void test3(sw::redis::Redis& redis)
{
std::cout << "--- 测试 lpop 和 rpop ---" << std::endl;
redis.flushall();
// 首先,构造一个包含多个元素的列表
redis.rpush("key", {"111", "222", "333", "444", "555", "666", "777"});
// 当前列表: ["111", "222", "333", "444", "555", "666", "777"]
// 从左侧弹出一个元素
auto result_lpop = redis.lpop("key");
if (result_lpop)
{
std::cout << "lpop result: " << result_lpop.value() << std::endl;
}
// 列表变为: ["222", "333", "444", "555", "666", "777"]
// 从右侧弹出一个元素
auto result_rpop = redis.rpop("key");
if (result_rpop)
{
std::cout << "rpop result: " << result_rpop.value() << std::endl;
}
// 列表最终变为: ["222", "333", "444", "555", "666"]
}
代码详解与 sw::redis::Optional
:
redis.lpop("key")
: 此调用尝试从 "key" 列表的头部移除元素 "111"。- 返回值类型
sw::redis::Optional<std::string>
: 这是redis-plus-plus
中一个至关重要的设计。如果对一个空列表 执行lpop
或rpop
,Redis 会返回一个空值(nil)。在 C++ 中处理这种情况可能会很棘手(例如返回空指针或特殊字符串)。redis-plus-plus
采用了现代 C++ 的std::optional
风格来优雅地解决这个问题。Optional
对象可以被直接用在if
语句中。if (result_lpop)
会检查Optional
对象内部是否真实地包含一个值。- 如果包含值,可以通过
.value()
方法来安全地获取它。
redis.rpop("key")
: 在lpop
执行之后,此调用作用于修改后的列表,从其尾部移除了元素 "777"。
最终结果预测:
程序将首先弹出最左边的 "111",然后弹出最右边的 "777"。控制台输出将是:
--- 测试 lpop 和 rpop ---
lpop result: 111
rpop result: 777
第三章:阻塞操作 ------ 耐心地等待数据
在构建消息队列或任务分发系统时,消费者通常需要在一个循环中不断地从列表中获取任务。如果列表为空,让消费者进程在一个紧密的循环中不停地查询(轮询)会极大地浪费 CPU 资源。为了解决这个问题,Redis 提供了阻塞式的列表弹出命令。
blpop
:阻塞式左侧弹出
BLPOP
是 LPOP
的阻塞版本。当 BLPOP
尝试从一个或多个空列表中弹出元素时,它不会立即返回,而是会阻塞当前连接,直到以下任一情况发生:
- 有另一个客户端向被监视的列表中推入了元素。
- 达到了设定的超时时间。
这个机制极大地提高了效率,使得消费者可以"睡眠",直到真正有工作可做时才被唤醒。

cpp
#include <chrono> // 使用时间字面量需要的头文件
void test4(sw::redis::Redis& redis)
{
// C++14 的一个语法糖,允许我们方便地写出时间单位,比如 10s
using namespace std::chrono_literals;
std::cout << "--- 测试 blpop ---" << std::endl;
redis.flushall();
// 注释掉的例子:如果执行这行代码,程序会永久阻塞,
// 直到有另一个客户端向 "key" 列表 lpush 一个值。
// auto result = redis.blpop("key");
// 核心操作:同时监视三个列表,并设置 10 秒的超时时间
auto result = redis.blpop({"key", "key2", "key3"}, 10s);
// 返回值类型分析:sw::redis::Optional<std::pair<std::string, std::string>>
// - Optional: 因为调用可能因超时而未返回任何数据。
// - std::pair: 如果成功,返回一个键值对。
// - pair.first: 表明元素是从哪个 key (列表) 中弹出的。
// - pair.second: 是被弹出的元素本身的值。
if (result)
{
// 成功获取到元素
std::cout << "Popped from key: " << result->first << std::endl;
std::cout << "Element value: " << result->second << std::endl;
}
else
{
// 超时,未获取到任何元素
std::cout << "Timeout: no data received in 10 seconds." << std::endl;
}
}
一个小细节:对于 Optional
类型,可以直接使用 ->
箭头操作符来访问其内部包含的对象的成员,这让代码更加简洁。result->first
等价于 result.value().first
。
代码详解:
using namespace std::chrono_literals;
: 这行代码启用了 C++14 的时间字面量功能,让我们可以直观地写出10s
(10秒),100ms
(100毫秒) 等。redis.blpop({"key", "key2", "key3"}, 10s)
: 这是blpop
的强大之处。- 监视多个列表: 它可以按照给定的顺序("key", "key2", "key3")检查这些列表。一旦发现第一个非空列表,就从中弹出一个元素并立即返回。
- 设置超时 : 第二个参数
10s
告诉 Redis,如果所有被监视的列表在 10 秒内一直为空,就放弃等待,解除阻塞并返回一个空值。如果超时时间设为 0,则表示无限期阻塞。
- 返回值类型 :
blpop
的返回值比lpop
更复杂。因为它可能从多个列表中的任何一个获取到数据,所以成功时的返回值是一个std::pair
,其中pair.first
是列表的键名,pair.second
是弹出的元素值。整个pair
又被Optional
包装,以处理超时的情况。
两种执行场景预测:
由于此代码的行为依赖于外部事件,它的输出会有两种可能:
-
场景一:10秒内没有数据插入
你运行程序,
blpop
开始阻塞。在 10 秒钟内,没有任何其他 Redis 客户端向 "key", "key2" 或 "key3" 推入数据。10 秒后,blpop
超时,if(result)
判断为false
。
控制台输出:--- 测试 blpop --- Timeout: no data received in 10 seconds.
-
场景二:10秒内有数据插入
你运行程序,
blpop
开始阻塞。在 10 秒内,你打开另一个 Redis 客户端(如redis-cli
)并执行命令LPUSH key2 "hello from another client"
。程序中的blpop
会立刻被唤醒,if(result)
判断为true
。
控制台输出:--- 测试 blpop --- Popped from key: key2 Element value: hello from another client
第四章:实用工具 ------ 检查你的列表
除了增删元素,我们有时还需要获取列表的元数据,例如它的长度。
llen
:获取列表长度
LLEN
是一个简单直接的命令,用于返回指定列表的长度(即其中元素的数量)。如果键不存在,它被视为空列表,返回 0。

cpp
void test5(sw::redis::Redis& redis)
{
std::cout << "--- 测试 llen ---" << std::endl;
redis.flushall();
redis.lpush("key", {"111", "222", "333"});
long long len = redis.llen("key");
std::cout << "The length of the list is: " << len << std::endl;
}
代码详解:
这段代码非常直观。我们首先向 "key" 列表推入 3 个元素,然后调用 redis.llen("key")
。该函数返回一个 long long
类型的整数,代表列表的当前长度。
最终结果预测:
控制台将输出:
--- 测试 llen ---
The length of the list is: 3
总结:redis-plus-plus
的优雅设计哲学
通过以上几个核心命令的实践,我们可以清晰地看到 redis-plus-plus
在设计上体现出的几个一贯原则,这些原则使其成为一个优秀的现代 C++ Redis 客户端:
-
当函数需要传递多个值时,优先支持初始化列表和迭代器对。
无论是
lpush
还是rpush
,我们都看到了对std::initializer_list
和迭代器范围的重载。这种设计避免了开发者手动循环调用单元素版本的函数,使得代码更简洁、更高效,并且能够与 C++ 标准库容器无缝协作。 -
当函数返回值需要表示多个数据时,巧妙借助插入迭代器。
以
lrange
为例,它没有返回一个库自定义的特殊容器,而是接受一个输出迭代器。这给予了开发者极大的灵活性,可以将结果直接填充到std::vector
、std::list
或任何支持push_back
的容器中,完全融入了 C++ 的编程范式。 -
当某些场景涉及到可能无效的返回值时,全面拥抱
std::optional
。对于
lpop
、rpop
、blpop
等命令,返回值可能为空。redis-plus-plus
使用Optional
类型来包装结果,这是一种类型安全的方式,强制开发者在使用值之前必须检查其是否存在,从而从根本上避免了空指针解引用等运行时错误,使代码更加健壮和清晰。
结论
Redis 列表是一个功能极其丰富的数据结构,是构建复杂系统的有力工具。而 redis-plus-plus
库通过其现代化的 C++ 接口,极大地简化了与 Redis 的交互。它将 Redis 的命令自然地映射到 C++ 的语言特性和标准库组件上,让 C++ 开发者可以专注于业务逻辑,同时写出既安全又高效的代码。掌握了这些基本模式,你就已经踏上了使用 C++ 和 Redis 构建下一代高性能应用的坚实一步。