redis-plus-plus 库
C++ 操作 Redis 的库有很多,这里使用 redis-plus-plus 库。
在 C++ 中使用 redis-plus-plus 库连接和操作 Redis 的方法。内容包括安装依赖 hiredis 和 redis-plus-plus,配置编译环境,以及通过 sw::redis::Redis 对象执行 Ping 测试。详细演示了通用命令(set, get, del, exists 等)、字符串操作(mset/mget, incr/decr)、Hash 结构(hset/hget)、List 结构(lpush/lpop)、Set 结构(sadd/smembers)及有序集合(zadd/zrange)的具体 API 用法与代码示例。

C++ 操作 Redis 的库有很多,这里使用 redis-plus-plus 库。
安装 hiredis
redis-plus-plus 是基于 hiredis 实现的(hiredis 是一个 C 语言实现的 redis 客户端)
apt install libhiredis-dev # Ubuntu
yum install hiredis-devel.x86_64 # Centos
下载 redis-plus-plus 源码
git clone https://github.com/sewenew/redis-plus-plus.git
编译安装 redis-plus-plus
Ubuntu
cd redis-plus-plus # 进入 redis-plus-plus 目录
make build
cd build
cmake ..
make
make install
这里使用 cmake 编译,安装 cmake
sudo apt install cmake
构建完成后,在 /usr/local/include/ 中会存在 sw 目录,内部包含 redis-plus-plus 的一些列头文件;
在 /usr/local/lib/ 中存在一系列 libredis 库文件
使用 redis-plus-plus 库
在使用 g++ 编译或者编写 makefile 时,要使用 redis-plus-plus 库,g++ 就要带上库文件的路径(redis-plus-plus、hiredis)
test:test.cc
g++ -o $@ $^ /usr/local/lib/libredis++.a /usr/lib/x86_64-linux-gnu/libhiredis.a
测试:ping 命令
使用 redis-plus-plus 操作 redis 数据库:创建 sw::redis::Redis 对象,调用成员函数
以 ping 命令为例,测试 redis 服务器的连通性
#include <iostream>
#include <string>
#include <sw/redis++/redis++.h>
int main() {
sw::redis::Redis redis("tcp://127.0.0.1:6379"); // 创建 Redis 对象
std::string result = redis.ping();
std::cout << result << std::endl;
return 0;
}
Redis 构造函数:参数是一个字符串,表示 url(协议名://IP 地址:端口号)
redis 客户端与服务器端,通信使用的是 tcp 协议,默认端口号为 6379(配置文件中可修改)
redis-plus-plus 库使用起来还是非常简单的,创建
sw::redis::Redis,调用其成员函数即可。
bool set(const StringView &key, const StringView &val, bool keepttl, UpdateType type = UpdateType::ALWAYS);
bool set(const StringView &key, const StringView &val, const std::chrono::milliseconds &ttl = std::chrono::milliseconds(0), UpdateType type = UpdateType::ALWAYS);
参数 key-val:要设置的 key-val 键值对 keepttl:在更新一个已存在的 key 的值时,对于原本设置的过期时间,是否保留 type:表示更新策略,ALWAYS(总是更新)、IF_EXISTS(键存在时更新,相当于 XX 选项)、IF_NOT_EXISTS(键不存在时更新,相当于 NX 选项)、NEVER(从不更新) ttl:在设置 k-v 键值对时,设置过期时间
StringView:只读字符串
sw::redis::OptionalString sw::redis::Redis::get(const sw::redis::StringView &key);
参数:要获取的 key
返回值:sw::redis::OptionalString
在 redis 中执行 get 命令,当 key 不存在时,返回
nil;这里 redis-plus-plus 进行了封装,当结果为 nil 时,就无法从 OptionalString 中获取值(通过调用成员方法 value,获取其中的字符串);
OptionalString 还重载了
operator bool,可以向 bool 值那样被使用(当结果为 nil 时,OptionalString 就为false)
long long exists(const sw::redis::StringView &key);
long long exists<T>(std::initializer_list<T> il); // 初始化列表
long long exists<Input>(Input first, Input last); // 迭代器区间
参数:
exists 可以删除一个 key,同时也可以删除多个 key;
在传递参数 时,可以只传递一个 key,也可以使用初始化列表,还可以使用一段 迭代器区间
返回值:存在的 key 的个数
long long del(const sw::redis::StringView &key);
long long del<T>(std::initializer_list<T> il);
long long del<Input>(Input first, Input last);
参数:和 exists 一样,可以传递一个 key,初始化列表,迭代器区间
返回值:删除的 key 的个数
使用实例:
void test1(Redis &redis) {
redis.flushall(); // 清空 redis 数据
redis.set("key1", "111");
redis.set("key2", "222");
redis.set("key3", "333");
std::string key1 = "key1";
auto result1 = redis.get(key1);
if (result1) std::cout << "get " << key1 << " - " << result1.value() << std::endl;
else std::cout << key1 << " 不存在" << std::endl;
std::string key2 = "key4";
auto result2 = redis.get(key2);
if (result2) std::cout << "get " << key2 << " - " << result2.value() << std::endl;
else std::cout << key2 << " 不存在" << std::endl;
auto exist1 = redis.exists("key2");
std::cout << "exists1 : " << exist1 << std::endl;
auto exist2 = redis.exists({"key1", "key2", "key3", "key4", "key5"});
std::cout << "exists2 : " << exist2 << std::endl;
std::vector<std::string> keys = {"key1", "key2", "key3", "key4", "key5"};
auto exist3 = redis.exists(keys.begin(), keys.end());
std::cout << "exists3 : " << exist3 << std::endl;
}
bool expire(const sw::redis::StringView &key, const std::chrono::seconds &timeout);
bool expire(const sw::redis::StringView &key, long long timeout);
参数:给一个 key 设置过期时间,可以直接传递一个整数(单位:秒);也可以使用 C++ 标准库中的时间间隔类型
返回值:表示是否设置成功
long long ttl(const sw::redis::StringView &key)
返回值:返回对应 key 的剩余过期时间
void keys<Output>(const sw::redis::StringView &pattern, Output output)
参数
pattern:通配表达式,
*表示匹配任意多个字符、?表示匹配任意一个字符 …output:插入迭代器,keys 获取的结果都插入到指定位置
在使用的过程中,通过辅助函数构造迭代器即可。(std::back_inserter、std::insert_iterator)
std::string sw::redis::Redis::type(const sw::redis::StringView &key)
获取 key 对应 value 的数据类型
使用实例:
void test2(Redis &redis) {
redis.flushall();
redis.set("key1", "111");
redis.set("key2", "222");
redis.set("key3", "333");
// redis.expire("key1", 3);
redis.expire("key1", std::chrono::seconds(3));
auto ttl1 = redis.ttl("key1");
std::cout << ttl1 << std::endl;
std::vector<std::string> out;
redis.keys("*", std::back_inserter(out));
for (auto &e : out) std::cout << e << std::endl;
auto type = redis.type("key1");
std::cout << type << std::endl;
}
bool set(const StringView &key, const StringView &val, bool keepttl, UpdateType type = UpdateType::ALWAYS);
bool set(const StringView &key, const StringView &val, const std::chrono::milliseconds &ttl = std::chrono::milliseconds(0), UpdateType type = UpdateType::ALWAYS);
sw::redis::OptionalString sw::redis::Redis::get(const sw::redis::StringView &key);
void mset<T>(std::initializer_list<T> il);
void mset<Input>(Input first, Input last);
mset 支持一次设置多个 key-value 键值对;
参数:可以是一个初始化列表(每一个元素都是一个 std::pair 类型),也可以是一段迭代器区间。
void mget<T, Output>(std::initializer_list<T> il, Output output);
void mget<Input, Output>(Input first, Input last, Output output);
mget 获取多个 key 对应的 value 值;
参数:
void test1(Redis &redis) {
redis.flushall();
// redis.mset({std::make_pair("k1", "v1"), std::make_pair("k2", "v2"), std::make_pair("k3", "v3")});
std::vector<std::pair<std::string, std::string>> vct = {
std::make_pair("k1", "v1"),
std::make_pair("k2", "v2"),
std::make_pair("k3", "v3")
};
redis.mset(vct.begin(), vct.end());
std::vector<sw::redis::OptionalString> result;
redis.mget({"k1", "k2", "k3", "k4"}, std::back_inserter(result));
for (auto &e : result) {
if (e) std::cout << e.value() << std::endl;
else std::cout << "nil" << std::endl;
}
}
mget 的返回值中可能存在 nil,这里使用 sw::redis::OptionalString 来存储结果
std::string getrange(const sw::redis::StringView &key, long long start, long long end);
long long setrange(const sw::redis::StringView &key, long long offset, const sw::redis::StringView &val);
getrange 获得 key 对应 value(string 类型)字符串中,区间 [start, end] 的子串
setrange 设置(替换)key 对应 value 字符串中,offset 位置后的子串(长度根据 val 长度而定)
void test2(Redis &redis) {
redis.flushall();
redis.set("key", "hello world!!!");
std::string result = redis.getrange("key", 5, 10);
std::cout << result << std::endl;
redis.setrange("key1", 6, "redis");
result = redis.getrange("key1", 0, -1);
std::cout << result << std::endl;
redis.set("key2", "100");
redis.incr("key2"); // +1
redis.incrby("key2", 100); // +100
auto a = redis.get("key2");
if (a) std::cout << a.value() << std::endl;
}
例如 decr/decrby/incrbyfloat 相关的 API,这里就不一一展示的,redis-plus-plus 在函数命名上都与命令保持一致,使用起来非常方便。
hset
long long hset(const sw::redis::StringView &key, const std::pair<sw::redis::StringView, sw::redis::StringView>&item);
long long hset<T>(const sw::redis::StringView &key, std::initializer_list<T> il);
long long hset(const sw::redis::StringView &key, const sw::redis::StringView &field, const sw::redis::StringView &val);
std::enable_if<!std::is_convertible<Input, sw::redis::StringView>::value, long long>::type hset<Input>(const sw::redis::StringView &key, Input first, Input last);
参数:
返回值:返回设置成功的键值对个数
这里 hset 可以设置多个 field-value 键值对,在初始化列表和迭代器区间中就可以是一个个的 std::pair 键值对。
hmset
void hmset<T>(const sw::redis::StringView &key, std::initializer_list<T> il);
void hmset<Input>(const sw::redis::StringView &key, Input first, Input last);
hget
sw::redis::OptionalString hget(const sw::redis::StringView &key, const sw::redis::StringView &field)
根据 key、field 获取对应的 value 值
返回值:sw::redis::OptionalString 类型(返回值可能为 nil)
hmget
void hmget<T, Output>(const sw::redis::StringView &key, std::initializer_list<T> il, Output output);
void hmget<Input, Output>(const sw::redis::StringView &key, Input first, Input last, Output output);
hmget,获取多个 field 对应的 value 值(获取的 value 值可能为 nil)
void test(Redis &redis) {
redis.flushall();
// hset hget
redis.hset("key", std::make_pair("f1", "v1"));
// redis.hset("key", {"f2", "v2"});
redis.hset("key", {std::make_pair("f2", "v2"), std::make_pair("f3", "v3")});
redis.hset("key", "f4", "v4");
auto value = redis.hget("key", "f1");
if (value) std::cout << value.value() << std::endl;
// hmset、hmget
// redis.hmset("key", {std::make_pair("aaa", "111"), std::make_pair("bbb", "222"), std::make_pair("ccc", "333")});
std::vector<std::pair<std::string, std::string>> fileds = {
std::make_pair("aaa", "111"),
std::make_pair("bbb", "222"),
std::make_pair("ccc", "333")
};
redis.hmset("key", fileds.begin(), fileds.end());
std::vector<sw::redis::OptionalString> result;
redis.hmget("key", {"aaa", "bbb", "ccc", "ddd", "eee"}, std::back_inserter(result));
for (auto &e : result)
if (e) std::cout << e.value() << std::endl;
}
hkeys:获取 key 对应的 hash 表中,所有的 filed
void hkeys<Output>(const sw::redis::StringView &key, Output output);
hvals:获取 key 对应的 hash 表中所有的 value
void hvals<Output>(const sw::redis::StringView &key, Output output)
hgetall:获取 key 对应 hash 表中的所有 key-value 键值对
void hgetall<Output>(const sw::redis::StringView &key, Output output)
void test2(Redis &redis) {
redis.flushall();
redis.hset("key", {std::make_pair("aaa", "111"), std::make_pair("bbb", "222"), std::make_pair("ccc", "333")});
std::vector<std::string> keys;
redis.hkeys("key", std::back_inserter(keys));
std::cout << "hkeys : " << std::endl;
for (auto &e : keys) std::cout << e << std::endl;
std::vector<std::string> vals;
redis.hvals("key", std::back_inserter(vals));
std::cout << "hvals : " << std::endl;
for (auto &e : vals) std::cout << e << std::endl;
std::vector<std::pair<std::string, std::string>> all;
redis.hgetall("key", std::back_inserter(all));
std::cout << "hgetall : " << std::endl;
for (auto &e : all) std::cout << e.first << " : " << e.second << std::endl;
}
lpush
long long lpush(const sw::redis::StringView &key, const sw::redis::StringView &val);
long long lpush<T>(const sw::redis::StringView &key, std::initializer_list<T> il);
long long lpush<Input>(const sw::redis::StringView &key, Input first, Input last);
lpush 从 list 左侧插入数据,可以依次插入多个数据。
lpop
sw::redis::OptionalString lpop(const sw::redis::StringView &key);
lpop 从 list 左侧删除一个数据。
rpush/rpop
long long rpush(const sw::redis::StringView &key, const sw::redis::StringView &val);
long long rpush<T>(const sw::redis::StringView &key, std::initializer_list<T> il);
long long rpush<Input>(const sw::redis::StringView &key, Input first, Input last);
sw::redis::OptionalString rpop(const sw::redis::StringView &key);
void lrange<Output>(const sw::redis::StringView &key, long long start, long long stop, Output output);
获取 list 指定区间的元素。(索引支持负数)
使用实例
void test1(Redis &redis) {
redis.flushall();
redis.lpush("key", {"111", "222", "333", "444", "555"});
redis.lpop("key");
std::vector<std::string> result;
redis.lrange("key", 0, -1, std::back_inserter(result));
for (auto &e : result) std::cout << e << std::endl;
}
lindex 根据索引获取 list 中对应元素
sw::redis::OptionalString lindex(const sw::redis::StringView &key, long long index);
llen 获取 list 的长度(元素个数)
long long llen(const sw::redis::StringView &key);
linsert:在值 pivot 之前或者之后,插入值 val
long long linsert(const sw::redis::StringView &key, sw::redis::InsertPosition position, const sw::redis::StringView &pivot, const sw::redis::StringView &val);
lrem:删除 list 中的元素 val(支持删除多个)
long long lrem(const sw::redis::StringView &key, long long count, const sw::redis::StringView &val);
count:
>0:从左到右,依次删除 |count| 个元素 val=0:删除所有的元素 val<0:从右到左,依次删除 |count| 个元素 val
使用实例
void test2(Redis &redis) {
redis.flushall();
redis.lpush("key", {"111", "222", "222", "333", "111"});
// 获取索引 2 对应的元素
auto index = redis.lindex("key", 2);
if (index) std::cout << index.value() << std::endl;
// 获取 list 中的元素个数
int len = redis.llen("key");
// 在元素 111 之后插入元素 999
redis.linsert("key", sw::redis::InsertPosition::AFTER, "111", "999");
// 从左往右,删除一个元素 111
redis.lrem("key", 1, "111");
// 删除所有的 222
redis.lrem("key", 0, "222");
std::vector<std::string> members;
redis.lrange("key", 0, -1, std::back_inserter(members));
std::cout << "list members : ";
for (auto &e : members) std::cout << e << " ";
std::cout << std::endl;
}
阻塞版本的 lpop/rpop
sw::redis::OptionalStringPair blpop(const sw::redis::StringView &key, const std::chrono::seconds &timeout = std::chrono::seconds{0});
sw::redis::OptionalStringPair blpop(const sw::redis::StringView &key, long long timeout);
sw::redis::OptionalStringPair blpop<T>(std::initializer_list<T> il, const std::chrono::seconds &timeout = std::chrono::seconds{0});
sw::redis::OptionalStringPair blpop<T>(std::initializer_list<T> il, long long timeout);
sw::redis::OptionalStringPair blpop<Input>(Input first, Input last, const std::chrono::seconds &timeout = std::chrono::seconds{0});
sw::redis::OptionalStringPair blpop<Input>(Input first, Input last, long long timeout);
blpop 可以阻塞等待多个 key,也可以设置 timeout(阻塞时间)
brpop 和 blpop 方法使用一样,只是删除的位置不同。
long long sw::redis::Redis::sadd(const sw::redis::StringView &key, const sw::redis::StringView &member);
inlinelong long sw::redis::Redis::sadd<const char*>(const sw::redis::StringView &key, std::initializer_list<const char*> il);
long long sw::redis::Redis::sadd<std::vector<std::string>::iterator>(const sw::redis::StringView &key, std::vector<std::string>::iterator first, std::vector<std::string>::iterator last);
sadd 向 set 中添加一个或者多个元素(member)
void sw::redis::Redis::smembers<std::back_insert_iterator<std::vector<std::string>>>(const sw::redis::StringView &key, std::back_insert_iterator<std::vector<std::string>> output);
smembers 获取 set 当中的所有元素
spop 随机删除 set 中的一个元素并返回
srandmember 随机返回 set 中的一个元素
sw::redis::OptionalString sw::redis::Redis::spop(const sw::redis::StringView &key);
sw::redis::OptionalString sw::redis::Redis::srandmember(const sw::redis::StringView &key);
使用实例:
void test1(Redis &redis) {
redis.flushall();
redis.sadd("key", "111");
redis.sadd("key", {"111", "222", "333"});
std::vector<std::string> members = {"aaa", "bbb", "ccc"};
redis.sadd("key", members.begin(), members.end());
std::vector<std::string> out;
redis.smembers("key", std::back_inserter(out));
for (auto &e : out) std::cout << e << std::endl;
auto randMember = redis.srandmember("key");
if (randMember) std::cout << "randMenber : " << randMember.value() << std::endl;
auto popMember = redis.spop("key");
if (popMember) std::cout << "spop : " << popMember.value() << std::endl;
}
对 set 求 交、并、差集
void sinter<T, Output>(std::initializer_list<T> il, Output output);
void sinter<Input, Output>(Input first, Input last, Output output);
void sunion<T, Output>(std::initializer_list<T> il, Output output);
void sunion<Input, Output>(Input first, Input last, Output output);
void sdiff<T, Output>(std::initializer_list<T> il, Output output);
void sdiff<Input, Output>(Input first, Input last, Output output);
使用实例
void test2(Redis &redis) {
redis.flushall();
redis.sadd("k1", {"111", "222", "333"});
redis.sadd("k2", {"222", "555", "888"});
std::vector<std::string> sinter;
redis.sinter({"k1", "k2"}, std::back_inserter(sinter));
std::cout << "sinter : ";
for (auto &e : sinter) std::cout << e << " ";
std::cout << std::endl;
std::vector<std::string> sunion;
redis.sunion({"k1", "k2"}, std::back_inserter(sunion));
std::cout << "sunion : ";
for (auto &e : sunion) std::cout << e << " ";
std::cout << std::endl;
std::vector<std::string> sdiff;
redis.sdiff({"k1", "k2"}, std::back_inserter(sdiff));
std::cout << "sdiff : ";
for (auto &e : sdiff) std::cout << e << " ";
std::cout << std::endl;
}
此外例如 sinterstore、sunionstore、sdiffstore,将结果存储到指定 key 中,相比于 sinter/sunion/sdiff 参数多了一个 key(表示结果要存储的 key)
long long zadd<T>(const sw::redis::StringView &key, std::initializer_list<T> il, sw::redis::UpdateType type = sw::redis::UpdateType::ALWAYS, bool changed = false);
long long zadd(const sw::redis::StringView &key, const sw::redis::StringView &member, double score, sw::redis::UpdateType type = sw::redis::UpdateType::ALWAYS, bool changed = false);
long long zadd<Input>(const sw::redis::StringView &key, Input first, Input last, sw::redis::UpdateType type = sw::redis::UpdateType::ALWAYS, bool changed = false);
zadd 向 zset 中添加元素(member 和 score),可以添加多个元素(初始化列表、迭代器区间)
此外还可以设置更新策略(ALWAYS、IF_EXISTS、IF_NOT_EXISTS、NEVER),这里更新是对于 score 的更新。
void zrange<Output>(const sw::redis::StringView &key, long long start, long long stop, Output output);
zrange 获取 zset 中指定区间 [start, stop] 的元素;
注意:这里 插入迭代器 output,指向 string 就是获取 member;指向 std::pair<string,string> 类型就是获取 member 和 score。
使用实例
void test1(Redis &redis) {
redis.flushall();
redis.zadd("key", {std::make_pair("王者荣耀", "80"), std::make_pair("穿越火线", "95"), std::make_pair("和平精英", "90")});
// vector<string> out;
std::vector<std::string> members;
redis.zrange("key", 0, -1, std::back_inserter(members));
for (auto &e : members) std::cout << e << " ";
std::cout << std::endl;
std::vector<std::pair<std::string, std::string>> items;
redis.zrange("key", 0, -1, std::back_inserter(items));
for (auto &e : items) std::cout << e.first << " : " << e.second << std::endl;
}
zcard 获取 zset 中的元素个数
long long zcard(const sw::redis::StringView &key);
zrem 根据 member 删除 zset 中元素
long long zrem(const sw::redis::StringView &key, const sw::redis::StringView &member);
此外,还可以删除 zset 中 score 在指定区间的元素(zremrangebyscore);根据索引删除 zset 中的元素(zremrangebyrank)
zscore:获取 zset 中指定 member 对应的 score
sw::redis::OptionalDouble zscore(const sw::redis::StringView &key, const sw::redis::StringView &member);
zrank:获取 zset 中元素 member 的索引
sw::redis::OptionalLongLong zrank(const sw::redis::StringView &key, const sw::redis::StringView &member);
这里就不一一演示这些方法了,总体使用起来还是比较简单的;详细内容可以参考 redis 官网

微信公众号「极客日志」,在微信中扫描左侧二维码关注。展示文案:极客日志 zeeklog
将字符串编码和解码为其 Base64 格式表示形式即可。 在线工具,Base64 字符串编码/解码在线工具,online
将字符串、文件或图像转换为其 Base64 表示形式。 在线工具,Base64 文件转换器在线工具,online
将 Markdown(GFM)转为 HTML 片段,浏览器内 marked 解析;与 HTML 转 Markdown 互为补充。 在线工具,Markdown 转 HTML在线工具,online
将 HTML 片段转为 GitHub Flavored Markdown,支持标题、列表、链接、代码块与表格等;浏览器内处理,可链接预填。 在线工具,HTML 转 Markdown在线工具,online
通过删除不必要的空白来缩小和压缩JSON。 在线工具,JSON 压缩在线工具,online
将JSON字符串修饰为友好的可读格式。 在线工具,JSON美化和格式化在线工具,online