前言

redis（Remote Dictionary Server）是一個使用ANSI C編寫的開源、支援網路、基於記憶體、可選永續性的鍵值對儲存資料庫–來自維基百科。由於其讀寫效能高、資料結構豐富、支援主從複製、支援持久化等其他特性，使得redis成為當前最流行的key-value型資料庫。本文將簡單介紹c語言中如何操作redis資料庫。

準備工作

hiredis安裝

hiredis是redis官方推薦的基於C介面的客戶端元件，它提供介面，供c語言呼叫以操作資料庫。我們需要將hiredis安裝到我們的系統中，在redis的原始碼包的deps/hiredis下就有它的原始碼,也可以另行下載hiredis

make
make install
ldconfig   #使動態庫在系統中更新生效

介面介紹

• 函式原型：redisContext *redisConnect(const char *ip, int port);
  說明：該函式用來連線redis資料庫，引數為資料庫的ip地址和埠，通常預設埠為6379。該函式返回一個redisContext物件。

• 函式原型：void *redisCommand(redisContext *c, const char *format, …);
  說明：該函式執行redis命令，當然也包括由lua指令碼組成的命令，返回redisReply物件。

• 函式原型void freeReplyObject(void *reply);
  說明：釋放redisCommand執行後返回的redisReply所佔用的記憶體。

• 函式原型：void redisFree(redisContext *c);
  說明：釋放redisConnect()所產生的連線。

後面的示例操作基本都是基於以上函式。

• redis reply物件:

 /* This is the reply object returned by redisCommand() */
 typedef struct redisReply {
     int type; /* 返回結果型別* */
 

     long long integer; /* 返回型別為整型的時候的返回值 */
     size_t len; /* 字串長度 */
     char *str; /* 返回錯誤型別或者字元型別的字串 */
     size_t elements; /* 返回陣列型別時，元素的數量*/
     struct redisReply **element; /* 元素結果集合，redisReply物件 */
 } redisReply;

其中，返回型別有以下幾種：

REDIS_REPLY_STRING 1 //字串
REDIS_REPLY_ARRAY 2    //陣列，多個reply，通過element陣列以及elements陣列大小訪問
REDIS_REPLY_INTEGER 3    //整型
REDIS_REPLY_NIL 4    //空，沒有資料
REDIS_REPLY_STATUS 5    //狀態，str字串以及len
REDIS_REPLY_ERROR 6    //錯誤，同STATUS

其他的我們暫時不過多介紹，下面通過一個簡單的例項來看看這些介面的基本使用。

例項

例項通過redis資料庫的hash表儲存以下學生資訊：

c語言描述如下：

#define SID_MAX_LENGHT 16
#define NAME_MAX_LENGHT 16
#define MAJOR_MAX_LENGHT 64
typedef struct Stu_Info_Struct
{
	char sid[SID_MAX_LENGHT];
	char name[NAME_MAX_LENGHT];
	int gender;//0 male,1 female
	char major[MAJOR_MAX_LENGHT];
}Stu_Info_Struct;

程式清單stu_manager.c如下：

/***************************************************************
*   Copyright (C) 2017 All rights reserved.
*
*   檔名稱：stu_manager.c
*   創 建 者：hyb
*   建立日期：2017年10月07日
*   描    述：
*
***************************************************************/
#include<stdio.h>
#include<string.h>
#include<stdlib.h>
#include<hiredis/hiredis.h>

/*巨集定義*/
#define SID_MAX_LENGHT 16
#define NAME_MAX_LENGHT 16
#define MAJOR_MAX_LENGHT 64
#define CMD_MAX_LENGHT  256
#define REDIS_SERVER_IP "127.0.0.1"
#define REDIS_SERVER_PORT 6379
/*結構體定義*/
typedef struct Stu_Info_Struct
{
	char sid[SID_MAX_LENGHT];
	char name[NAME_MAX_LENGHT];
	int gender;//0 male,1 female
	char major[MAJOR_MAX_LENGHT];
}Stu_Info_Struct;

typedef enum STU_RESULT
{
    SUCCESS=0,
    FAILURE=1
}STU_RESULT;

/*函式*/
STU_RESULT addStu(Stu_Info_Struct *stu);/*新增資訊*/
/*執行命令*/
STU_RESULT exeRedisIntCmd(char *cmd);
STU_RESULT quryStuBySid(char *sid);
STU_RESULT exeRedisStrCmd(char *cmd);
/**************************************
函式名:addStu
函式功能:新增學生資訊
輸入引數:stu 學生資訊結構指標
輸出引數:
返回值:STU_RESULT  成功或失敗
************************************/
STU_RESULT addStu(Stu_Info_Struct *stu)
{
    char cmd[CMD_MAX_LENGHT] = {0};
    /*檢查入參*/
    if(NULL == stu)
    {
        printf("NULL pointer");
        return FAILURE;
    }
    /*組裝redis命令*/
    snprintf(cmd,CMD_MAX_LENGHT,"hset stu:%s name %s gender %d major %s",
            stu->sid,stu->name,stu->gender,stu->major);

    /*執行redis命令*/
    if(FAILURE == exeRedisIntCmd(cmd))
    {
        printf("add student %s,%s,%d,%s failure\n",stu->sid,stu->name,stu->gender,stu->major);
        return FAILURE;
    }
    printf("add student %s,%s,%d,%s success\n",stu->sid,stu->name,stu->gender,stu->major);
    return SUCCESS;
}
/**************************************
函式名:exeRedisIntCmd
函式功能:執行redis 返回值為int型別命令
輸入引數:cmd  redis命令
輸出引數:redis 返回結構
返回值:STU_RESULT
*************************************/
STU_RESULT exeRedisIntCmd(char *cmd)
{
    /*檢查入參*/
    if(NULL == cmd)
    {
        printf("NULL pointer");
        return FAILURE;
    }
    /*連線redis*/
    redisContext *context = redisConnect(REDIS_SERVER_IP,REDIS_SERVER_PORT);
    if(context->err)
    {
        redisFree(context);
        printf("%d connect redis server failure:%s\n",__LINE__, context->errstr);
        return FAILURE;
    }
    printf("connect redis server success\n");

    /*執行redis命令*/
    redisReply *reply = (redisReply *)redisCommand(context, cmd);
    if(NULL == reply)
    {
        printf("%d execute command:%s failure\n",__LINE__,cmd);
        redisFree(context);
        return FAILURE;
     }
    //返回執行結果為整型的命令,只有狀態為REDIS_REPLY_INTEGER,並且INTEGER是大於0時,才表示這種型別的命令執行成功
    if(!(reply->type == REDIS_REPLY_INTEGER && reply->integer > 0))
    {
        printf("%d execute command:%s failure\n",__LINE__, cmd);
        freeReplyObject(reply);
        redisFree(context);
        return FAILURE;
    }

    freeReplyObject(reply);
    redisFree(context);
    printf("%d execute command:%s success\n",__LINE__,cmd);
    return SUCCESS;

}
/**************************************
函式名:quryStuBySid
函式功能:通過sid查詢學生資訊
輸入引數:cmd  redis命令
輸出引數:redis 返回結構
返回值:STU_RESULT
*************************************/
STU_RESULT queryStuBySid(char *sid)
{
    char cmd[CMD_MAX_LENGHT] = {0};
    /*入參檢查*/
    if(NULL == sid)
    {
        printf("%d NULL pointer\n",__LINE__);
        return FAILURE;
    }
    /*組裝執行命令*/
    snprintf(cmd,CMD_MAX_LENGHT,"HGETALL stu:%s",sid);
    if(FAILURE == exeRedisStrCmd(cmd))
    {
        printf("%d query stu failue",__LINE__);
        return FAILURE;
    }
    return SUCCESS;
}
STU_RESULT exeRedisStrCmd(char *cmd)
{

    /*檢查入參*/
    if(NULL == cmd)
    {
        printf("NULL pointer");
        return FAILURE;
    }

    /*連線redis*/
    redisContext *context = redisConnect(REDIS_SERVER_IP,REDIS_SERVER_PORT);
    if(context->err)
    {
        redisFree(context);
        printf("%d connect redis server failure:%s\n",__LINE__, context->errstr);
        return FAILURE;
    }
    printf("connect redis server success\n");

    /*執行redis命令*/
    redisReply *reply = (redisReply *)redisCommand(context, cmd);
    if(NULL == reply)
    {
        printf("%d execute command:%s failure\n",__LINE__,cmd);
        redisFree(context);
        return FAILURE;
     }
    //返回執行結果為整型的命令,只有狀態為REDIS_REPLY_INTEGER,並且INTEGER是大於0時,才表示這種型別的命令執行成功
    if(!(reply->type == REDIS_REPLY_ARRAY && reply->elements > 0))
    {
        printf("%d execute command:%s failure\n",__LINE__, cmd);
        freeReplyObject(reply);
        redisFree(context);
        return FAILURE;

    }

    printf("%d,%lu\n",reply->type,reply->elements);
    int i = 0;
    for(i=0;i < reply->elements;i++)
    {
        if(i%2 ==0)
        {
            printf("%s:",reply->element[i]->str);
        }
        else
        {

            printf("%s\n",reply->element[i]->str);
        }
    }
    freeReplyObject(reply);
    redisFree(context);
    return SUCCESS;
}
int main(int argc,char *argv[])
{
    Stu_Info_Struct stu =
    {
     "01",
     "hu",
    1,
    "CS"
    };

    addStu(&stu);
    queryStuBySid("01");
    return 0;
}

編譯程式碼

gcc -g stu_manager.c -o stu -lhiredis

可能遇到問題:

libhiredis.so.0.10: cannot open shared object file: No such file or directory

/usr/lib/hiredis目錄下沒有hiredis庫,將編譯連結好的hiredis庫拷貝到/usr/lib/hiredis目錄下，並且執行命令重新載入配置:

ldconfig

啟動redis伺服器

redis-server

執行

./stu

執行結果：

[email protected]:redis# ./stu
connect redis server success
116 execute command:hset stu:01 name hu gender 1 major CS success
add student 01,hu,1,CS success
connect redis server success
2,6
name:hu
gender:1
major:CS

程式首先將學生資訊新增到資料庫中，然後通過id將其結果查詢出來。

總結

本文對hiredis的介面進行了簡單的介紹，並通過一個小例項說明了這些介面在c中的使用。

微信公眾號：程式設計珠璣