Hiredis的基本使用

两片空白

已于 2023-05-24 17:14:04 修改

阅读量3.9k

点赞数 3

分类专栏： Redis 文章标签： hiredis

于 2023-05-24 16:36:49 首次发布

本文链接：https://blog.csdn.net/weixin_57023347/article/details/130733711

版权

Redis 专栏收录该内容

30 篇文章 0 订阅

订阅专栏

2.1.3 非阻塞，不管连接与否，立即返回。

前言

Hiredis是一个redis的C客户端库函数，该库带有多个API、有同步API，异步API和应带解析API。使用该库中的API可以实现C语言代码连接并操作Redis数据库。下面介绍经常使用的一些API。

一.hiredis的安装

hiredis源码地址：GitHub - redis/hiredis: Minimalistic C client for Redis >= 1.2

可以使用代码管理工具git克隆下来，或者将压缩包下载下来。使用tar -xzf 压缩包解压。

进入hiredis目录先使用make命令，再使用make install命令

在代码中引用hiredis库时，需要注意：

在使用gcc/g++编译时，需要指明库名-lhiredis。
需要在LD_LIBRARY_PATH环境变量里加上hiredis库路径，否则动态连接时会找不到hiredis库。进程动态链接库会在该环境变量的路径下中找。hiredis默认安装在/usr/local/lib目录下。

二.同步API

2.1.连接Redis数据库

2.1.1 无超时时间，阻塞等待连接

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

参数说明：

ip：为redis数据库的ip地址，可以是远程ip，也可以是本地ip 127.0.0.1。

port：为redis数据库监听的端口号。默认是6379。

返回值：

返回值是一个指向redisContext对象，是该库的上下文环境。可以不知道这个对象的具体组成，但是需要知道怎么使用。

如果连接错误，返回的redisContext对象的err会被设置成1，错误信息保存在errstr中。

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;

2.1.2 设置超时时间，阻塞等待连接。

redisContext *redisConnectWithTimeout(const char *ip, int port, const struct timeval tv);

2.1.3 非阻塞，不管连接与否，立即返回。

redisContext *redisConnectNonBlock(const char *ip, int port);

2.2.执行命令

2.2.1 返回执行上下文

void *redisCommand(redisContext* c, char *format, ...);

参数说明：

c是一个redisContext对象，redisConnect函数返回值。

后面这个参数是一个不定参数。可以按照format格式给出对应参数。和printf函数类似。

返回值:

返回值是一个void类型的指针，实际为指向一个redisReply类型的指针。

redisReply类型的定义：

/* This is the reply object returned by redisCommand() */
typedef struct redisReply {
    /*命令执行结果的返回类型*/
    int type; /* REDIS_REPLY_* */
    /*存储执行结果返回为整数*/
    long long integer; /* The integer when type is REDIS_REPLY_INTEGER */
    /*字符串值的长度*/
    size_t len; /* Length of string */
    /*存储命令执行结果返回是字符串*/
    char *str; /* Used for both REDIS_REPLY_ERROR and REDIS_REPLY_STRING */
    /*返回结果是数组的大小*/
    size_t elements; /* number of elements, for REDIS_REPLY_ARRAY */
    /*存储执行结果返回是数组*/
    struct redisReply **element; /* elements vector for REDIS_REPLY_ARRAY */
} redisReply;

返回值结果的类型reply->type，reply为redisReply*类型。

REDIS_REPLY_STRING == 1:返回值是字符串，字符串保存在redis->str中。字符串长度为redis->len。
REDIS_REPLY_ARRAY == 2:返回值是一个数组，数组大小存在reply->elements中，数组值保存在redis->element[i]里面。数组里面存储的是指向redisReply对象的指针。
REDIS_REPLY_INTEGER == 3:返回值为整数long long。
REDIS_REPLY_NIL == 4:返回值结果为空表示执行结果为空。
REDIS_REPLY_STATUS == 5:返回命令执行的状态，比如：set foo bar返回状态为"OK"，存储在str中reply->str == "OK"。
REDIS_REPLY_ERROR == 6:命令执行错误，错误信息保存在reply->str中。

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

参数说明：

argc：存放命令参数的个数，下面这个例子是argc=3。

argv：存放每个命令参数的指针，argv={"set","foo","bar"}

argvlen：这个数组存放的是命令参数中每一个参数的长度，包含命令本身。比如上面的例子，argvlen={3,3,3}，如果argvlen为空，那么这个函数内部会自动调用strlen函数对每一个参数进行求长度。

为每一个命令参数指定长度，可以是二进制安全的函数。函数会按照长度来决定字符串的终止，而不是'\0'。

返回值：

返回值和redisCommand相同。

示例：

#include <iostream>                                                                                                                                                                      
#include "../hiredis/hiredis.h"

void hiredisTest()
{
  redisContext* c = redisConnect("127.0.0.1", 6379);
  if(!c)
  {
    std::cout << "error" << std::endl;
    return;
  }
  else if(c->err)
  {
    std::cout << c->errstr << std::endl;
    return;
  }
  std::cout << "success" << std::endl;

  //执行命令
  const char* s1 = "k1";
  const char* s2 = "v1";
  const char* s3 = "k2";
  const char* s4 = "v2";
  redisReply* replyPtr = (redisReply*)redisCommand(c, "mset %s %s %s %s", s1, s2, s3, s4);
  if(replyPtr || replyPtr->type == REDIS_REPLY_ERROR)
  {
    if(replyPtr)
    {
      std::cout << replyPtr->str << std::endl;
    }
    else
    { 
      std::cout << "redis command error" << std::endl;
    }
  }
  freeReplyObject(replyPtr);

  int argc = 3;
  const char *argv[] = {"mget", "k1", "k2"};
  size_t arglen[] = {4, 2, 2};
  redisReply* replyPtr1 = (redisReply*)redisCommandArgv(c, argc, argv, arglen);
  if(!replyPtr1 || replyPtr1->type == REDIS_REPLY_ERROR)
  {
    if(replyPtr1)
    {
      std::cout << replyPtr1->str << std::endl;
    }
    else
    { 
      std::cout << "redis command error" << std::endl;
    }
  }
  std::cout << replyPtr1->type << std::endl;
  for(size_t i = 0; i < replyPtr1->elements; ++i)
  {
    std::cout << replyPtr1->element[i]->str << "\t";
  }
  std::cout<< std::endl;

  freeReplyObject(replyPtr1);
  redisFree(c);
}

int main()
{

  hiredisTest();
  return 0;
 }

2.2.2 没有返回执行上下文

void redisAppendCommand(redisContext *c, const char *format, ...);

参数和redisCommand相同。

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

参数和redisCommandArgv相同。

 int redisGetReply(redisContext *c, void **reply);

作用：获取执行命令上下文。

参数说明：

c 为redisConnect返回值，库的上下文。

reply为redisReply指针的地址，是一个输出型参数，用来得到命令执行上下文。

返回值说明：

成功返回REDIS_OK，失败返回REDIS_ERR

2.3.释放资源

hiredis在连接和命令执行时都会产生上下文，开辟新空间，需要释放，否则会造成内存泄漏。

2.3.1 断开连接，并释放连接上下文

void redisFree(redisContext *c);

2.3.2 释放命令执行上下文

void freeReplyObject(void *reply);

两片空白

关注

3
点赞
踩
16

收藏

觉得还不错? 一键收藏
0
评论
Hiredis的基本使用

Hiredis是一个redis的C客户端库函数，该库带有多个API、有同步API，异步API和应带解析API。使用该库中的API可以实现C语言代码连接并操作Redis数据库。下面介绍经常使用的一些API。
复制链接

扫一扫

专栏目录