hiredis接口分析1：同步调用

最新推荐文章于 2024-05-13 05:16:19 发布
最新推荐文章于 2024-05-13 05:16:19 发布
阅读量808 收藏 4
点赞数 1
分类专栏： redis高速缓存数据库
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/fangfanglovezhou/article/details/104967124
版权

　hiredis是redis官方推荐的C/C++客户端代码库，使用hiredis库可以方便地进行redis数据库相关操作，大多数情况下采用同步调用的方式，下面通过一个简单例子对其工作流程进行介绍并对相关源码进行分析：

#include <stdio.h>
#include <string.h>
#include "hiredis.h"
int main()
{
redisContext *c = redisConnect("192.168.0.18", 9688);
if (c->err) {    /* Error flags, 0 when there is no error */
        printf("connect error.%s", c->errstr);
        return 0;
}
else
{
        printf("connected\n");
}

redisReply *reply = (redisReply *)redisCommand(c, "AUTH %s", "123456");
if (reply->type == REDIS_REPLY_ERROR) {
printf("Redis log in fail!\n");
}
else
{
printf("Redis log in success!\n");
}
freeReplyObject(reply);
char *value="It's a test";
redisReply *reply1 = redisCommand(c, "set key %s", value);
freeReplyObject(reply1);
redisReply *reply2 = redisCommand(c, "get key");
printf("key:1 value:%s\n", reply2->str);
freeReplyObject(reply2);
redisFree(c);
return 0;
}

首先调用redisConnect连接redis数据库，redisConnect基于tcp协议连接服务端，其中redisContext的定义如下：

typedef struct redisContext {
    int err; /* Error flags, 0 when there is no error */
    char errstr[128]; /* String representation of error when applicable */
    int fd;
    int flags;
    char *obuf; /* Write buffer */
    redisReader *reader; /* Protocol reader */

    enum redisConnectionType connection_type;
    struct timeval *timeout;

    struct {
        char *host;
        char *source_addr;
        int port;
    } tcp;

    struct {
        char *path;
    } unix_sock;

} redisContext;

redisContext为表示一个连接的上下文结构体，包括ip、端口号、socket id和写缓存等信息，redisConnect代码如下：

redisContext *redisConnect(const char *ip, int port) {
    redisContext *c;

    c = redisContextInit();
    if (c == NULL)
        return NULL;

    c->flags |= REDIS_BLOCK;
    redisContextConnectTcp(c,ip,port,NULL);
    return c;
}

可以看到首先调用 redisContextInit()初始化上下文、分配内存，之后调用redisContextConnectTcp(c,ip,port,NULL)通过tcp连接服务端。连接成功后通过redisCommand执行redis指令，代码如下：

void *redisCommand(redisContext *c, const char *format, ...) {
    va_list ap;
    va_start(ap,format);
    void *reply = redisvCommand(c,format,ap);
    va_end(ap);
    return reply;
}

实际调用的是redisvCommand：

void *redisvCommand(redisContext *c, const char *format, va_list ap) {
    if (redisvAppendCommand(c,format,ap) != REDIS_OK)
        return NULL;
    return __redisBlockForReply(c);
}

有两个函数调用，其中redisvAppendCommand负责解析指令并将指令转化为待发送的字节流存储到redisContext *c中的obuf中，随后__redisBlockForReply(c)负责通过tcp协议将命令字节流发送给服务端并接收服务端的回复，实际调用了函数redisGetReply：

int redisGetReply(redisContext *c, void **reply) {
    int wdone = 0;
    void *aux = NULL;

    /* Try to read pending replies */
    if (redisGetReplyFromReader(c,&aux) == REDIS_ERR)
        return REDIS_ERR;

    /* For the blocking context, flush output buffer and read reply */
    if (aux == NULL && c->flags & REDIS_BLOCK) {
        /* Write until done */
        do {
            if (redisBufferWrite(c,&wdone) == REDIS_ERR)
                return REDIS_ERR;
        } while (!wdone);

        /* Read until there is a reply */
        do {
            if (redisBufferRead(c) == REDIS_ERR)
                return REDIS_ERR;
            if (redisGetReplyFromReader(c,&aux) == REDIS_ERR)
                return REDIS_ERR;
        } while (aux == NULL);
    }

    /* Set reply object */
    if (reply != NULL) *reply = aux;
    return REDIS_OK;
}

发送指令是通过调用redisBufferWrite(c,&wdone)完成的，其源代码为：

int redisBufferWrite(redisContext *c, int *done) {
    int nwritten;

    /* Return early when the context has seen an error. */
    if (c->err)
        return REDIS_ERR;

    if (sdslen(c->obuf) > 0) {
        nwritten = write(c->fd,c->obuf,sdslen(c->obuf));
        if (nwritten == -1) {
            if ((errno == EAGAIN && !(c->flags & REDIS_BLOCK)) || (errno == EINTR)) {
                /* Try again later */
            } else {
                __redisSetError(c,REDIS_ERR_IO,NULL);
                return REDIS_ERR;
            }
        } else if (nwritten > 0) {
            if (nwritten == (signed)sdslen(c->obuf)) {
                sdsfree(c->obuf);
                c->obuf = sdsempty();
            } else {
                sdsrange(c->obuf,nwritten,-1);
            }
        }
    }
    if (done != NULL) *done = (sdslen(c->obuf) == 0);
    return REDIS_OK;
}

可以看到最底层其实就是调用write函数对redisContext *c 的tcp socket fd进行连续的写操作来实现发送直到成员obuf的数据发送完成，同样通过redisBufferRead来接收服务端响应：

int redisBufferRead(redisContext *c) {
    char buf[1024*16];
    int nread;

    /* Return early when the context has seen an error. */
    if (c->err)
        return REDIS_ERR;

    nread = read(c->fd,buf,sizeof(buf));
    if (nread == -1) {
        if ((errno == EAGAIN && !(c->flags & REDIS_BLOCK)) || (errno == EINTR)) {
            /* Try again later */
        } else {
            __redisSetError(c,REDIS_ERR_IO,NULL);
            return REDIS_ERR;
        }
    } else if (nread == 0) {
        __redisSetError(c,REDIS_ERR_EOF,"Server closed the connection");
        return REDIS_ERR;
    } else {
        if (redisReaderFeed(c->reader,buf,nread) != REDIS_OK) {
            __redisSetError(c,c->reader->err,c->reader->errstr);
            return REDIS_ERR;
        }
    }
    return REDIS_OK;
}

首先调用 read(c->fd,buf,sizeof(buf))将服务端发送的数据接收到buff中，随后调用redisReaderFeed(c->reader,buf,nread)将接收到的nread字节拷贝到c->reader的buffer缓存区，注意这里所有缓存操作都是通过简单动态字符串SDS数据结构实现的。redisGetReplyFromReader(c,&aux)实现对服务器返回消息的解析，并最终得到解析到的回复消息的结构体redisReply，并返回其指针。

经过分析可以看到，hiredis同步模式是典型单线程处理模式，单个线程首先发送命令，然后接受命令并进行解析。

这里需要注意在tcp连接建立中,默认客户端socket设定为c->flags |= REDIS_BLOCK;，即为阻塞的。

对于服务端数据的接收，在redisGetReply执行redisBufferRead和redisGetReplyFromReader两个函数的交替循环：

        do {
            if (redisBufferRead(c) == REDIS_ERR)
                return REDIS_ERR;
            if (redisGetReplyFromReader(c,&aux) == REDIS_ERR)
                return REDIS_ERR;
        } while (aux == NULL);

redisBufferRead函数中执行如下读操作：

int redisBufferRead(redisContext *c) {
    char buf[1024*16];
    int nread;

    /* Return early when the context has seen an error. */
    if (c->err)
        return REDIS_ERR;

    nread = read(c->fd,buf,sizeof(buf));
    if (nread == -1) {
        if ((errno == EAGAIN && !(c->flags & REDIS_BLOCK)) || (errno == EINTR)) {
            /* Try again later */
        } else {
            __redisSetError(c,REDIS_ERR_IO,NULL);
            return REDIS_ERR;
        }
    } else if (nread == 0) {
        __redisSetError(c,REDIS_ERR_EOF,"Server closed the connection");
        return REDIS_ERR;
    } else {
        if (redisReaderFeed(c->reader,buf,nread) != REDIS_OK) {
            __redisSetError(c,c->reader->err,c->reader->errstr);
            return REDIS_ERR;
        }
    }
    return REDIS_OK;
}

如果读返回为-1的话，若非阻塞且返回错误为EAGAIN，则表示连续做read操作而没有数据可读，此时程序不会阻塞起来等待数据准备就绪返回，read函数会返回一个错误EAGAIN，提示你的应用程序现在没有数据可读请稍后再试。或者返回错误为EINTR，即进程在一个慢系统调用(slow system call)中阻塞系统调用被中断。这两种错误均不做处理，直接返回，其他错误则返回错误。当然这里由于默认是阻塞的，不会出现这两种情况。redisGetReplyFromReader负责解析指令，主要通过redisGetReply函数进行解析：

int redisGetReply(redisContext *c, void **reply) {
    int wdone = 0;
    void *aux = NULL;

    /* Try to read pending replies */
    if (redisGetReplyFromReader(c,&aux) == REDIS_ERR)
        return REDIS_ERR;

    /* For the blocking context, flush output buffer and read reply */
    if (aux == NULL && c->flags & REDIS_BLOCK) {
        /* Write until done */
        do {
            if (redisBufferWrite(c,&wdone) == REDIS_ERR)
                return REDIS_ERR;
        } while (!wdone);

        /* Read until there is a reply */
        do {
            if (redisBufferRead(c) == REDIS_ERR)
                return REDIS_ERR;
            if (redisGetReplyFromReader(c,&aux) == REDIS_ERR)
                return REDIS_ERR;
        } while (aux == NULL);
    }

    /* Set reply object */
    if (reply != NULL) *reply = aux;
    return REDIS_OK;
}

直到解析指令成功才会退出循环。

I_belong_to_jesus
关注
  • 1
    点赞
  • 踩
  • 4
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
hiredis库windows版本
11-14
2. **同步和异步接口**：hiredis提供了同步和异步两种API，同步接口适合简单、高响应性的应用，而异步接口则适用于需要处理大量并发请求的场景。 3. **协议解析**：hiredis能直接解析Redis协议，将接收到的服务器...
Redis常用命令及C C++调用Redis接口详解_redis c++，2024年最新360°深入了解Flutter
2401_84263282的博客
04-17 1335
说明：该函数执行命令，就如sql数据库中的SQL语句一样，只是执行的是redis数据库中的操作命令，第一个参数为连接数据库时返回的redisContext，剩下的参数为变参，就如C标准函数printf函数一样的变参。上面的这些命令在是Redis自身的命令，但是在我们的C/C++代码，我们不能直接执行这些命令，我们需要通过Redis提供的API来访问Redis。在API内部，Hiredis根据不同的参数分割命令转化为操作redis数据库的标准命令，你可以格式化多个参数来构造redis的命令，如下。
Redis中常用命令操作方式
caifengguo的博客
08-18 3401
初步接触Redis服务，下面是我在使用过程中自己总结出来的相关注意事项以及使用方法。如果不足之处，还希望 大家随时之处，后面将继续完善 1、调用方式      1）普通调用方式，即非pipleline模式（管道模式） redisCommand()      2）基于管线的调用方式，即pipleline模式          redisAppendCommand() 该命令只是将待发送
用redis的订阅/发布机制来做1）进程间通信、2）操作hiredis库、3）异步处理hiredis订阅
谢白羽
11-17 1874
文章目录一、往1这个通道发布一条信息abc，这里是开启通道二、订阅1这个通道的信息（这里别的窗口再输入了一次redis-cli publish 1 abc）三、一些细节1）一个订阅者可以订阅多个频道（这里订阅订阅了2和3通道）2）订阅者（收消息）：会一直阻塞等待新消息3）发布消息会发给所有订阅者四、hiredis库实现发布订阅1）初步的代码2）打印订阅的信息3）开启订阅，然后打印收到的发布的信息 一、往1这个通道发布一条信息abc，这里是开启通道 二、订阅1这个通道的信息（这里别的窗口再输入了一次redi
Hiredis
飞翔de刺猬
11-29 9915
简介本文翻译自Hiredis官方，README.md文件。Hiredis是Redis数据库的简约C客户端库。它是简约的，因为它只是增加了对协议的 最小支持，但是同时它使用了一个高级别的printf-like API，所以对于习 惯了printf风格的C编程用户来说，其非常容易使用，而且API中没有明确的绑定 每 个Redis命令。除了支持发送命令和接收回复之外，它还附带了一个与I / O层分离
Redis-C客户端-HiRedis-(二)
三少GG
01-22 6703
hiredis入门http://www.codingcool.com/2013/02/21/hiredis%E5%85%A5%E9%97%A8/ 前几篇介绍了redis以及phpredis，主要是因为我所在的项目组用的是php，而我接下来的一个小任务是用c++写一个处理存储在redis里的业务数据的小工具，在redis官方上看推荐的c++客户端，只有一个，而且还是2年前的一个临时项目，而
关于 redisCommand 以及 redisReply
看，未来的博客
12-22 3435
源码不长，五分钟就都能翻出来。 void* redisCommand(redisContext c,const char format,...); 返回值是一个void类型的指针，实际为指向一个redisReply类型的指针 redisReply结构体定义如下： /* This is the reply object returned by redisCommand() */ typedef struct redisReply { int type; /* REDIS_REPLY_* */
hiredis-master
01-04
例如，`hiredis.c`和`hiredis.h`分别包含了库的主要功能实现和接口定义。 2. **示例代码**：可能有一个`examples`目录，提供了一些简单的示例程序，帮助开发者了解如何在自己的项目中集成和使用hiredis。 3. **...
hiredis的安装包,C语言版本，解压后，切换到解压目录，执行：sudo make && make install
03-09
1. **hiredis简介**: hiredis是Redis官方推荐的C语言客户端库，它提供了简洁的API，支持同步和异步两种模式的连接。同步模式下，hiredis通过阻塞I/O处理Redis服务器的响应；异步模式则使用回调函数，实现非阻塞I/O，...
hiredis-0.14.0.tar.gz
02-14
3. 异步连接：hiredis提供异步接口，允许开发者在等待响应的同时处理其他任务，提高程序并发性。 4. 完善的错误处理：具有丰富的错误检测和报告机制，便于调试和问题定位。 三、hiredis核心组件 1. `redisContext...
hiredis-master.zip
08-01
hiredis是一个高效的Redis客户端库，它专注于提供简单、快速且低内存消耗的接口来与Redis服务器进行通信。这个资源包可能是开发者为了方便下载和编译hiredis库而提供的。 【描述】"hiredis-master.zip资源包下载" ...
Redis源码解析：18Hiredis同步API和回复解析API代码解析
weixin_30362801的博客
05-08 234
Redis的sentinel模式使用了Hiredis代码，Hiredis是redis数据库一个轻量级的C语言客户端库。它实现的向Redis发送命令的API函数redisCommand，使用方法类似于printf。因此只要熟悉redis命令，就可以很容易的使用该函数将redis命令字符串，转换成统一请求协议格式之后，发送给Redis服务器。 Hiredis库包...
Redis连接池C/C++设计
locahuang的博客
12-04 2175
一、概述 Redis的C/C++编程，可以借助Hiredis。我们可以借助Hiredis提供的接口 ，实现对redis的读写操作。 Hiredis是一个Redis的C客户端库函数，基本实现了Redis的协议的最小集。 二、hiredis的使用 1、hiredis安装 安装步骤： 1）解压：tar -zxvf hiredis-0.14.0.tar.gz 2）编译：make 3）安装：make install 2、同步API接口的说明 项目中我一般使用的hireds接口都是同步的API，所谓同步意思就是使用
Linux下C/C++ redis协议(RESP)解析
chen1415886044的博客
04-03 1265
Redis 基于 RESP （Redis Serialization Protocal）协议来完成客户端和服务端通讯的。RESP 本质是一种文本协议，实现简单、易于解析。底层采用的是TCP的连接方式，通过tcp进行数据传输，然后根据解析规则解析相应信息。
redis客户端连接到服务器的步骤
makesifriend的博客
05-20 5509
看了大约3天的redis-cli了，是进行总结的时候了。 和大多数客户端连接到服务器一样，redis-cli连接到服务器也主要分为两个阶段，请求连接阶段和数据传送阶段。具体来讲redis-cli做的事情有： 1、以socket方式建立连接； 2，选择相应的数据库； 3，对客户端发送的命令进行编码； 4，发送客户端编码的数据（write）； 5，接收服务器回应的数据（read）； 6，...
2024年C C++最新C语言--内存函数(3)，2024年最新这些面试官常问的开发面试题你都掌握好了吗
最新发布
2401_84978588的博客
05-13 432
和memcpy的差别就是memmove函数处理的源内存块和⽬标内存块是。是⽤来设置内存的，将内存中的值以字节为单位设置成想要的内容。95%以上C C++开发知识点，真正体系化！出现重叠，就得使⽤memmove函数处理。
Redis发布订阅模式
m0_46392035的博客
05-20 4692
1.redis环境安装和配置 sudo apt-get install redis-server # ubuntu命令安装redis服务 ps -ef | grep redis ubuntu通过上面命令安装完redis，会自动启动redis服务，通过ps命令确认，可以看到redis默认工作在本地主机的6379端口上。 2.Redis发布订阅 2.1.redis数据库的命令 1.订阅频道的命令是 subscribe redis的发布-订阅机制：发布-订阅模式包含了两种角色，分别是消息的发布.
C++ 实现 redis 发布订阅 --- 使用 hiredis 同步API（二）
12-20 627
下载hiredis库源码，我的编译环境为ubuntu14，解压hiredis源码后，终端下进入源码目录，然后输入make命令编译即可，编译后将分别得到静态及动态库文件：libhiredis.a / libhiredis.so，然后结合头文件就可以在工程中使用redis了。做服务端开发基本都会用到redis，java调用redis就简单了，教程很多，库也都是现成的，多数会选择jedis库吧，但是c++调用redis就麻烦一点，基本都要自己编译才行。虽然支持c++的redis库也很多，但是用哪个呢？
Redis 发布和订阅详细介绍
业精于勤，荒于嬉
06-14 3126
一句话：Redis 发布订阅(pub/sub) 是一种消息通信模式：发送者(pub) 发送消息，订阅者(sub) 接收消息Redis 客户端可以订阅任意数量的频道。
操作系统接口解析：系统调用与用户接口
学习Java时，理解系统调用和操作系统接口的概念很重要，因为Java作为一个跨平台的语言，其I/O操作、进程管理、线程同步等功能都依赖于底层操作系统提供的这些接口。通过学习这一部分，开发者可以更好地理解和利用...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值