欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

Redis教程(十五):C语言连接操作代码实例

程序员文章站 2022-06-17 20:49:28
在之前的博客中已经非常详细的介绍了redis的各种操作命令、运行机制和服务器初始化参数配置。本篇博客是该系列博客中的最后一篇,在这里将给出基于redis客户端组件访问并操作...

在之前的博客中已经非常详细的介绍了redis的各种操作命令、运行机制和服务器初始化参数配置。本篇博客是该系列博客中的最后一篇,在这里将给出基于redis客户端组件访问并操作redis服务器的代码示例。然而需要说明的是,由于redis官方并未提供基于c接口的windows平台客户端,因此下面的示例仅可运行于linux/unix平台。但是对于使用其它编程语言的开发者而言,如c#和java,redis则提供了针对这些语言的客户端组件,通过该方式,同样可以达到基于windows平台与redis服务器进行各种交互的目的。

该篇博客中使用的客户端来自于redis官方网站,是redis推荐的基于c接口的客户端组件,见如下链接:

在下面的代码示例中,将给出两种最为常用的redis命令操作方式,既普通调用方式和基于管线的调用方式。

注:在阅读代码时请留意注释。

#include <stdio.h>
#include <stdlib.h>
#include <stddef.h>
#include <stdarg.h>
#include <string.h>
#include <assert.h>
#include <hiredis.h>

void dotest()
{
  int timeout = 10000;
  struct timeval tv;
  tv.tv_sec = timeout / 1000;
  tv.tv_usec = timeout * 1000;
  //以带有超时的方式链接redis服务器,同时获取与redis连接的上下文对象。
  //该对象将用于其后所有与redis操作的函数。
  rediscontext* c = redisconnectwithtimeout("192.168.149.137",6379,tv);
  if (c->err) {
    redisfree(c);
    return;
  }
  const char* command1 = "set stest1 value1";
  redisreply* r = (redisreply*)rediscommand(c,command1);
  //需要注意的是,如果返回的对象是null,则表示客户端和服务器之间出现严重错误,必须重新链接。
  //这里只是举例说明,简便起见,后面的命令就不再做这样的判断了。
  if (null == r) {
    redisfree(c);
    return;
  }
  //不同的redis命令返回的数据类型不同,在获取之前需要先判断它的实际类型。
  //至于各种命令的返回值信息,可以参考redis的官方文档,或者查看该系列博客的前几篇
  //有关redis各种数据类型的博客。:)
  //字符串类型的set命令的返回值的类型是redis_reply_status,然后只有当返回信息是"ok"
  //时,才表示该命令执行成功。后面的例子以此类推,就不再过多赘述了。
  if (!(r->type == redis_reply_status && strcasecmp(r->str,"ok") == 0)) {
    printf("failed to execute command[%s].\n",command1);
    freereplyobject(r);
    redisfree(c);
    return;
  }
  //由于后面重复使用该变量,所以需要提前释放,否则内存泄漏。
  freereplyobject(r);
  printf("succeed to execute command[%s].\n",command1);

  const char* command2 = "strlen stest1";
  r = (redisreply*)rediscommand(c,command2);
  if (r->type != redis_reply_integer) {
    printf("failed to execute command[%s].\n",command2);
    freereplyobject(r);
    redisfree(c);
    return;
  }
  int length = r->integer;
  freereplyobject(r);
  printf("the length of 'stest1' is %d.\n",length);
  printf("succeed to execute command[%s].\n",command2);

  const char* command3 = "get stest1";
  r = (redisreply*)rediscommand(c,command3);
  if (r->type != redis_reply_string) {
    printf("failed to execute command[%s].\n",command3);
    freereplyobject(r);
    redisfree(c);
    return;
  }
  printf("the value of 'stest1' is %s.\n",r->str);
  freereplyobject(r);
  printf("succeed to execute command[%s].\n",command3);

  const char* command4 = "get stest2";
  r = (redisreply*)rediscommand(c,command4);
  //这里需要先说明一下,由于stest2键并不存在,因此redis会返回空结果,这里只是为了演示。
  if (r->type != redis_reply_nil) {
    printf("failed to execute command[%s].\n",command4);
    freereplyobject(r);
    redisfree(c);
    return;
  }
  freereplyobject(r);
  printf("succeed to execute command[%s].\n",command4);

  const char* command5 = "mget stest1 stest2";
  r = (redisreply*)rediscommand(c,command5);
  //不论stest2存在与否,redis都会给出结果,只是第二个值为nil。
  //由于有多个值返回,因为返回应答的类型是数组类型。
  if (r->type != redis_reply_array) {
    printf("failed to execute command[%s].\n",command5);
    freereplyobject(r);
    redisfree(c);
    //r->elements表示子元素的数量,不管请求的key是否存在,该值都等于请求是键的数量。
    assert(2 == r->elements);
    return;
  }
  for (int i = 0; i < r->elements; ++i) {
    redisreply* childreply = r->element[i];
    //之前已经介绍过,get命令返回的数据类型是string。
    //对于不存在key的返回值,其类型为redis_reply_nil。
    if (childreply->type == redis_reply_string)
      printf("the value is %s.\n",childreply->str);
  }
  //对于每一个子应答,无需使用者单独释放,只需释放最外部的redisreply即可。
  freereplyobject(r);
  printf("succeed to execute command[%s].\n",command5);

  printf("begin to test pipeline.\n");
  //该命令只是将待发送的命令写入到上下文对象的输出缓冲区中,直到调用后面的
  //redisgetreply命令才会批量将缓冲区中的命令写出到redis服务器。这样可以
  //有效的减少客户端与服务器之间的同步等候时间,以及网络io引起的延迟。
  //至于管线的具体性能优势,可以考虑该系列博客中的管线主题。
  if (redis_ok != redisappendcommand(c,command1)
    || redis_ok != redisappendcommand(c,command2)
    || redis_ok != redisappendcommand(c,command3)
    || redis_ok != redisappendcommand(c,command4)
    || redis_ok != redisappendcommand(c,command5)) {
    redisfree(c);
    return;
  }

  redisreply* reply = null;
  //对pipeline返回结果的处理方式,和前面代码的处理方式完全一直,这里就不再重复给出了。
  if (redis_ok != redisgetreply(c,(void**)&reply)) {
    printf("failed to execute command[%s] with pipeline.\n",command1);
    freereplyobject(reply);
    redisfree(c);
  }
  freereplyobject(reply);
  printf("succeed to execute command[%s] with pipeline.\n",command1);

  if (redis_ok != redisgetreply(c,(void**)&reply)) {
    printf("failed to execute command[%s] with pipeline.\n",command2);
    freereplyobject(reply);
    redisfree(c);
  }
  freereplyobject(reply);
  printf("succeed to execute command[%s] with pipeline.\n",command2);

  if (redis_ok != redisgetreply(c,(void**)&reply)) {
    printf("failed to execute command[%s] with pipeline.\n",command3);
    freereplyobject(reply);
    redisfree(c);
  }
  freereplyobject(reply);
  printf("succeed to execute command[%s] with pipeline.\n",command3);

  if (redis_ok != redisgetreply(c,(void**)&reply)) {
    printf("failed to execute command[%s] with pipeline.\n",command4);
    freereplyobject(reply);
    redisfree(c);
  }
  freereplyobject(reply);
  printf("succeed to execute command[%s] with pipeline.\n",command4);

  if (redis_ok != redisgetreply(c,(void**)&reply)) {
    printf("failed to execute command[%s] with pipeline.\n",command5);
    freereplyobject(reply);
    redisfree(c);
  }
  freereplyobject(reply);
  printf("succeed to execute command[%s] with pipeline.\n",command5);
  //由于所有通过pipeline提交的命令结果均已为返回,如果此时继续调用redisgetreply,
  //将会导致该函数阻塞并挂起当前线程,直到有新的通过管线提交的命令结果返回。
  //最后不要忘记在退出前释放当前连接的上下文对象。
  redisfree(c);
  return;
}

int main() 
{
  dotest();
  return 0;
}

//输出结果如下:
//succeed to execute command[set stest1 value1].
//the length of 'stest1' is 6.
//succeed to execute command[strlen stest1].
//the value of 'stest1' is value1.
//succeed to execute command[get stest1].
//succeed to execute command[get stest2].
//the value is value1.
//succeed to execute command[mget stest1 stest2].
//begin to test pipeline.
//succeed to execute command[set stest1 value1] with pipeline.
//succeed to execute command[strlen stest1] with pipeline.
//succeed to execute command[get stest1] with pipeline.
//succeed to execute command[get stest2] with pipeline.
//succeed to execute command[mget stest1 stest2] with pipeline.