Redis C语言客户端库hiredis使用方法

最新推荐文章于 2024-02-25 17:24:52 发布
最新推荐文章于 2024-02-25 17:24:52 发布
阅读量5.4k 收藏 10
点赞数 1
分类专栏： 数据库/redis

本文偏重于应用，需要起码的redis基础知识。

第一部分

第1讲  Hiredis介绍

Hiredis是redis数据库一个轻量的C语言客户端库。

之所以轻量，是由于它只是简单的提供了对redis操作语句支持的接口，并没有实现具体的操作语句的功能。但正是由于这种设计，使得我们只要熟悉了通用的redis操作语句，就可以很容易的使用该库和redis数据库进行交互。

除了支持发送命令和接收应答/应答数据，它提供了对应答数据的解析操作。而且这个基于I/O层的数据流解析操作设计考虑到了复用性，可以对应答数据进行通用的解析操作。

Hirides仅仅支持二进制安全的redis协议，所以你只能针对版本号大于等于1.2.0的redis服务端使用。

Redis C语言客户端库hiredis包含多种API，包括同步命令操作API、异步命令操作API和对应答数据进行解析的API。

关于升级：  版本0.9.0是hiredis很多特性一次大的更新，但是对现有代码进行升级应该不会造成大的问题。升级时，要记住的关键一点是大于等于0.9.0的版本是使用redisContext*来保持连接状态，之前的版本只是使用了无状态的文件描述符。

第二部分 同步API

常用的同步API主要有：

redisContext *redisConnect(const char *ip, int port);
void *redisCommand(redisContext *c, const char *format, ...);
void freeReplyObject(void *reply);

第1讲 连接redis数据库

函数redisConnect被用来创建一个 redisContext。这个context是hiredis持有的连接状态。redisConnect结构体有一个整型的err变量来标识连接错误码，如果连接错误则为非零值。变量errstr标识连接结果的文字描述。更多这方面的信息会在以下Errors章节说明。当你使用 redisConnect 来创建连接时应该检查err变量来判断是否连接正常建立。

redisContext *c = redisConnect("127.0.0.1", 6379);
if (c != NULL && c->err) {
printf("Error: %s\n", c->errstr); // handle error }

第2讲 发送命令到redis

有多种方法可以发送命令到redis。

首先介绍redisCommand。此函数类似于printf的使用方式，如

reply = redisCommand(context, "SET foo bar");

类似于printf的s%格式化方式，如

reply = redisCommand(context, "SET foo %s", value);

当你需要发送二进制安全的命令时，可以采用%b的格式化方式，同时需要一个字符串指针和size_t类型的字符串长度参数,如下

reply = redisCommand(context, "SET foo %b", value, (size_t) valuelen);

在API内部，Hiredis根据不同的参数分割命令，将其转化为“操作redis数据库的标准命令”，你可以格式化多个参数来构造redis的命令，如下

reply = redisCommand(context, "SET key:%s %s", myid, value);

第3讲  处理redis应答

当命令被成功执行后，redisCommand会有相应的返回值。如果有错误发生，返回值为NULL或者redisReply结构体中的err变量将会被设置成相应的值（请参照Errors章节）。一旦有错误发生，context不能被重用，并且你需要建立一个新的连接。

redisCommand执行后返回值类型为redisReply。通过redisReply结构体中的type变量，可以确定命令执行的情况。

  • REDIS_REPLY_STATUS：

    • 返回执行结果为状态的命令。比如set命令的返回值的类型是REDIS_REPLY_STATUS，然后只有当返回信息是"OK"时，才表示该命令执行成功。可以通过reply->str得到文字信息，通过reply->len得到信息长度。

  • REDIS_REPLY_ERROR：

    • 返回错误。错误信息可以通过reply->str得到文字信息，通过reply->len得到信息长度。

  • REDIS_REPLY_INTEGER：

    • 返回整型标识。可以通过reply->integer变量得到类型为long long的值。

  • REDIS_REPLY_NIL:

    • 返回nil对象，说明不存在要访问的数据。

  • REDIS_REPLY_STRING:

    • 返回字符串标识。可以通过reply->str得到具体值，通过reply->len得到信息长度。

  • REDIS_REPLY_ARRAY:

    • 返回数据集标识。数据集中元素的数目可以通过reply->elements获得，每个元素是个redisReply对象，元素值可以通过reply->element[..index..].*形式获得，用在获取多个数据结果的操作。

注意1：  执行完命令调用后，应该通过freeReplyObject()释放redisReply。对于嵌套对象（比如数组）要注意，并不需要嵌套进行释放，若进行嵌套释放，会造成内存破坏。

注意2:  hiredis当前版本(0.10.0)在使用异步API时，会自己释放replies对象。这意味着，你使用异步API时并不需要主动调用freeReplyObject，relpy对象在回调返回时将会被自动释放。但是这种行为也许会在将来的版本中改变，所以升级时请密切关注升级日志。

第4讲  清理连接资源

断开连接并且释放context使用以下函数

void redisFree(redisContext *c);

此函数立马关闭socket并且释放创建context时分配的资源。

第5讲  发送多个命令参数

和redisCommand函数相似，redisCommandArgv函数可以用于传输多个命令参数。函数原型为

void *redisCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen);

类似于 lpush， del key1 key2..., zadd key score1 member1 score2 member2...这类命令， 其中 argc是传递参数的个数， argv主要用于传递的string的value, 而argvlen 是每个string的size。

此函数返回值与redisCommand相似。参考https://gist.github.com/dspezia/1455082

第6讲 管道(PipeLine)

为了搞清楚Hiredis在阻塞连接下的管线操作，需要理解其内部执行过程。(context的输出缓冲区中是命令，其输入缓冲区中是reply)。

当任何类似于redisCommand的函数被调用，Hiredis首先将命令格式化为redis支持的命令协议。被格式化后的命令被放入context的输出缓冲区，这个缓冲区是动态的，所以它可以容纳任意数量的命令。在命令进入输出缓冲区后，redisGetReply 函数被调用，这个函数有以下两种执行方式：

  1. 输入缓冲区非空：

    • 从输入缓冲区中尝试解析单独的reply对象并且返回reply

    • 如果没有reply能被解析，执行步骤2

  2. 输入缓冲区为空：

    • 将整个输出缓冲区写入socket

    • 从socket中读取数据直到有一个reply能被解析

Hiredis为了有效利用socket还提供了redisGetReply的接口。对于管线命令，需要完成的唯一事情就是填充输出缓冲区。有两个函数被用于执行此操作，这两个函数基本与redisCommand函数功能类似，但是他们不返回reply，

void redisAppendCommand(redisContext *c, const char *format, ...);
void redisAppendCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen);

当这两个函数被一次或多次调用时，通过redisGetReply依次返回replies。redisGetReply的返回值要么是REDISOK或是REDISERR，REDIS_ERR意味着获得reply发生了错误，想要得到具体的错误原因可以通过err变量来获取。

以下通过一个简单例子说明管线的使用：

redisReply *reply;
redisAppendCommand(context,"SET foo bar");
redisAppendCommand(context,"GET foo");
redisGetReply(context,&reply); // reply for SET
freeReplyObject(reply);
redisGetReply(context,&reply); // reply for GET
freeReplyObject(reply);

redisGetReply这个API也可以被用来实现阻塞的订阅模式

reply = redisCommand(context,"SUBSCRIBE foo");
freeReplyObject(reply);
while(redisGetReply(context,&reply) == REDIS_OK) 
{
// consume message
freeReplyObject(reply);
}

第7讲 redis常见操作的errors

第7.1 节

如果redisConnect调用不成功，函数返回值为NULL或者REDIS_ERR，此时context结构体中的err成员为非零值，可能为以下几种常量：

  • REDIS_ERR_IO:当创建连接时（试着写socket或者读socket）发生的I/O错误。如果你在代码中包含了errno.h头文件，你便能得到准确的错误码。

  • REDIS_ERR_EOF:redis服务端已经关闭了此连接。

  • REDIS_ERR_PROTOCOL:服务端解析协议时发生了错误。

  • REDIS_ERR_OTHER:其他错误。目前仅仅表示无法解析目标主机名的错误。

在错误情况下，可以通过context结构体中的errstr成员得到错误的确切描述。

第7.2节

如果redisCommand调用不成功，详情参考第4讲。

第三部分 异步API

Hiredis自带的异步API很容易和一些基于事件的库结合使用，比如和libev、ibevent的结合使用。

第1讲 建立hiredis异步连接

函数redisAsyncConnect被用来和redis建立非阻塞连接。它返回redisAsyncContext的结构体，结构体的err成员用来检查在创建连接的过程中是否发生了错误。因为创建的是非阻塞的连接，内核并不能立马返回一个连接指定主机的结果。

redisAsyncContext *c = redisAsyncConnect("127.0.0.1", 6379);
if (c->err) 
{
printf("Error: %s\n", c->errstr);
// handle error
}

异步Context可设置一个响应断开连接事件的回调函数，当连接断开时会相应执行。回调函数的原型为

void(const redisAsyncContext *c, int status);

在断开连接的情况下，若连接是由用户自己断开的，则status参数为REDISOK；若出现了其他错误，则status参数为REDISERR，通过err成员可以得到准确的错误码。当回调执行完毕后，context对象会自己释放资源。此事件的回调函数为你创建一个新连接提供了便利。

一个context对象仅能设置一次断开连接的回调，如果再进行下一次设置，将会返回REDIS_ERR。设置断开连接回调函数的原型为：

int redisAsyncSetDisconnectCallback(redisAsyncContext *ac, redisDisconnectCallback *fn);

第2讲 异步发送操作命令并且响应回调事件 

在异步的情况下，redis的操作指令将会被自动加入事件循环队列。由于发送命令执行的过程是异步的，当命令执行完毕后，将会调用相应的回调函数。回调函数的原型为

void(redisAsyncContext *c, void *reply, void *privdata);

privdata参数是由调用者自己定义的数据类型。

以下是进行异步命令操作的函数：

 int redisAsyncCommand(redisAsyncContext *ac, redisCallbackFn *fn, void *privdata,const char *format, ...);    int redisAsyncCommandArgv( redisAsyncContext *ac, redisCallbackFn *fn, void *privdata, int argc, const char **argv, const size_t *argvlen);

命令的使用方式和上面所讲的同步接口类似。执行成功返回REDIS_OK，否则返回REDIS_ERR。比如连接已经关闭的情况下再使用redisAsyncCommand向此连接执行命令，就会返回REDIS_ERR。

回调执行完毕后，如果reply不为空，将自动对reply的资源进行回收。当context发生错误时，回调得到的reply将为空。

第3讲 断开异步连接 

一个异步的连接可以通过下面这个函数终止

void redisAsyncDisconnect(redisAsyncContext *ac);

当这个函数被调用时，连接并不会被立即关闭，而是等待所有这个连接的异步命令操作执行完毕，并且回调事件已经执行完毕后，才关闭此连接，这时在响应关闭连接事件的回调函数中得到的状态为REDIS_OK，此连接的资源也将会被自动回收。

第4讲  将其挂接到事件库X

在context对象被创建后，进行很少的几步操作，就可以进行挂接。参看目录adapters/下是如何挂接到libev 和 libevent下的。

第5讲  应答解析API

Hiredis自带的答复解析API ，可以很容易与更高层次的语言进行绑定。

原文网址为：http://yaocoder.blog.51cto.com/2668309/1297031，欢迎探讨和学习




FROM: http://blog.csdn.net/chinawangfei/article/details/41644599

imxiangzi
关注
  • 1
    点赞
  • 踩
  • 10
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
在C++下借助hiredis使用redis数据库
lin3ux的博客
09-26 542
使用C++编程时操作redis
Redis C++ API(hiredis)的完整使用教程
quyan的博客
07-07 5777
文章目录Redis(Linux)1. redis的安装&运行1.1. 安装1.2. 命令行启动本地运行指定ip、端口号、登陆密码运行：关闭服务2. C++ API2.1. 安装hiredis2.2. C++调用示例代码： Redis(Linux) 1. redis的安装&运行 1.1. 安装 参考官方链接，下载编译最新版redis： $ wget http://download.r...
Hiredis的基本使用
weixin_57023347的博客
05-24 2736
Hiredis是一个redis的C客户端库函数，该库带有多个API、有同步API，异步API和应带解析API。使用该库中的API可以实现C语言代码连接并操作Redis数据库。下面介绍经常使用的一些API。
redis——客户端
最新发布
weixin_57023347的博客
02-25 1397
Redis是一个典型一对多服务器程序，一个服务器可以与多个客户端进行网络连接，每隔客户端可以向服务器发送命令请求，而服务器则接收并处理客户端发送的命令请求，并向客户端返回命令请求。通过是一个I/O多路复用技术实现的文件事件处理器，Redis服务器使用单线程单进程的方式处理命令请求，并与多个客户端进行网络通信。Redis服务器状态结构的clients属性是一个链表，这个链表保存了所有与服务器连接的客户端的状态结构，对客户端执行批量操作，或者查找某个指定的客户端，都可以通过表里clients链表来完成。
redis使用c++ API 的hiredis连接详解
10-18
此代码实现了redis使用hiredis c接口开发，具体实现了string和list类型的存取，具体信息请看 https://blog.csdn.net/bwangk/article/details/83060374
Redis的C客户端(hiredis库)使用
weixin_45715405的博客
10-09 1016
Hiredis是一个Redis的C客户端库函数，基本实现了Redis的协议的最小集。这里对hiredis的api作基本的介绍以及应用，主要参考hiredis的README文件以及相关源码。
redis 学习-hiredis库使用（二）
qq_20853741的博客
03-04 1195
Redis是一个非关系型（NoSQL）数据库，本文将实现一个用c++ API接口连接的例子，来实现对Redis数据库的写入和读出功能，具体将从Redis的安装，Redis的c++接口hiredis安装，代码演示三部分组成。 一、Redis的安装和配置 由于源中已有Redis的相关组件，这里就不进行源码编译而直接使用apt-get （ubuntu环境）下载和安装 1.redis的安装和配置 sudo apt-cache search redis //根据结果列表找到需要安装的软件...
【Redis】官方推荐的基于C接口hiredis
lsz20000813的博客
05-21 1704
hiredis hiredis是Redis官方推荐的基于C接口的客户端组件，它提供接口，供c语言调用以操作数据库。 //头文件 #include <hiredis/hiredis.h> //连接redis数据库，参数为ip地址和端口号，默认端口6379.该函数返回一个redisContext对象 redisContext *redisConnect(const char *ip, int port); //执行redis命令，返回redisReply对象 void *redisCommand
C++操作redis的客户端hiredis库
10-08
在Win10操作系统上，使用Qt5.14.2（gcc version 7.3.0）编译的最新版hiredis1.0.2库，经测试和使用能够成功连接redis数据库并对其进行一系列操作。
Redis的C客户端hiRedis.zip
07-16
hiRedis 是 Redis 官方指定的 C 语言客户端开发包，支持 Redis 完整的命令集、管线以及事件驱动编程。示例代码：redisContext *c = redisConnect("127.0.0.1", 6379); if (c->err) { printf("Error: %s\n", c->...
cpp-Hiredis用于Redis数据库的很简单的C客户端库
08-16
Hiredis： 用于Redis数据库的很简单的C客户端库
redis mac 客户端
09-09
redis mac 客户端，redis desktop manager for mac 0.9.3.39，用于管理redis数据库
redis客户端
03-29
RedisClient是Redis客户端的GUI工具，使用Java swt和jedis编写，可以方便开发者浏览Redis数据库。该软件支持简体中文，非常适合国内用户使用，不需要汉化就可以直接使用。RedisClient将redis数据以资源管理器的界面...
hiredis的使用
C/C++Linux、音视频、DPDK
08-03 3213
Hiredis是一个Redis的C客户端库函数，基本实现了Redis的协议的最小集。这里对hiredis的api作基本的介绍以及应用，主要参考hiredis的README文件以及相关源码。 1. hiredis的安装 官网：https://redislabs.com/lp/hiredis/ 发行版本：https://github.com/redis/hiredis/releases 目前最新的版本：https://codeload.github.com/redis/hiredis/tar.gz/v0.14.
hiredis使用简介
mao834099514的博客
04-25 4579
hiredis是Redis数据库的C接口，目前只能在Linux下使用，几个基本的函数就可以操作redis数据库了。一、API简介 1、redisContext* redisConnect(const char *ip, int port); 说明：该函数用来连接redis数据库，参数为数据库的ip地址和端口，一般redis数据库的端口为6379。 类似的提供了一个函数redisCo
redis学习（十二）——hiredis的使用
www_dong的博客
12-13 704
hiredis的使用
Hiredis安装使用及浅析和一个利用Hiredis实现的简单类
mfcbest的专栏
05-25 1474
Hiredis  GitHub地址:https://github.com/redis/hiredis 通过MAKEFILE编译安装,生成两个libhiredis.a libhiredis.so两个库文件,我们只要在我们的程序包含hiredis.h的头文件,在程序连接的时候连接-lhiredis就可以了。 hiredis的官方文档说明:http://blog.csdn.net/superinza
redis的C++客户端
09-03
Redis是一个开源的高性能键值存储系统，C语言是一种非常适合与Redis进行交互的语言。为了使用Redis的C客户端，你需要先安装Redis服务器，并确保你的C开发环境已经设置好。 在C语言中，你可以使用hiredis库来与Redis进行交互。hiredis是一个简单、轻量级且易于使用的Redis C客户端库，它提供了一组简洁的API来执行Redis命令和处理返回的数据。 你可以从hiredis的官方GitHub仓库(https://github.com/redis/hiredis)中获取最新版本的源代码和文档。为了使用hiredis，你需要将其源代码编译为静态库或动态库，并链接到你的C项目中。 以下是一个简单的示例，展示了如何使用hiredis库连接到Redis服务器并执行一些基本的操作： ```c #include <stdio.h> #include <hiredis.h> int main() { redisContext *ctx = redisConnect("localhost", 6379); // 连接到本地Redis服务器 if (ctx == NULL || ctx->err) { if (ctx) { printf("Error: %s\n", ctx->errstr); redisFree(ctx); } else { printf("Can't allocate redis context\n"); } return 1; } redisReply *reply = redisCommand(ctx, "SET mykey hello"); // 执行SET命令 if (reply == NULL) { printf("Failed to execute command\n"); } else { printf("SET: %s\n", reply->str); freeReplyObject(reply); } reply = redisCommand(ctx, "GET mykey"); // 执行GET命令 if (reply == NULL) { printf("Failed to execute command\n"); } else { printf("GET: %s\n", reply->str); freeReplyObject(reply); } redisFree(ctx); // 断开与Redis服务器的连接 return 0; } ``` 这只是一个简单的示例，实际上hiredis库提供了更多的API和功能，如事务、管道、订阅/发布等。你可以查阅hiredis的官方文档以了解更多详细信息和示例代码。希望对你有帮助！

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值