hiRedis基础教程

本文只总结常规会用到的hiRedis使用方法,一般顺序为先用 redisConnect 连接数据库,然后用 redisCommand 执行命令,执行完后用 freeReplyObject 来释放redisReply对象,最后用 redisFree 来释放整个连接。

hiredis直接去git上克隆,地址:https://github.com/redis/hiredis,然后make && make install

连接

函数原型

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

使用示例

//连接redis,若出错redisContext.err会设置为1,redisContext.errstr会包含描述错误信息
redisContext *redis_handle = redisConnect("192.163.122.1", 8889);
if (redis_handle == NULL || redis_handle->err) {
    if (redis_handle) {
        printf("Error:%s\n", redis_handle->errstr);
    } else {
        printf("can't allocate redis context\n");
    }
    return -1;
}
//do your work
redisFree(redis_handle);

执行Redis命令

函数原型

typedef struct redisReply {
    int type; /* REDIS_REPLY_* */
    long long integer; /* The integer when type is REDIS_REPLY_INTEGER */
    int 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;

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

redisReply结构的type定义如下

  • REDIS_REPLY_STATUS:
    表示返回了一个状态。状态字符串可以使用reply->str来访问。该字符串的长度可以使用reply->len来访问。例如set成功,会返回状态,str为"OK"
  • REDIS_REPLY_ERROR:
    表示执行错误。错误字符串可以使用reply->str来访问
  • REDIS_REPLY_INTEGER:
    表示返回一个整数。整数值可以使用long long类型的reply-> integer字段来访问
  • REDIS_REPLY_NIL:
    表示返回空数据
  • REDIS_REPLY_STRING:
    表示返回一个字符串。可以使用reply-> str来访问。该字符串的长度可以使用reply->len来访问。
  • REDIS_REPLY_ARRAY:
    表示返回一个数组。例如mget,元素数量存储在reply->elements元素中。每个元素也是一个redisReply对象,可以通过reply-> element [index]进行访问。

使用示例

//set
string set_ = "set China Beijing";
redisReply *reply = (redisReply *)redisCommand(redis_handle, set_.c_str());
if (reply!=NULL && reply->type==REDIS_REPLY_STATUS) {
    printf("%s\n", reply->str);
}
freeReplyObject(reply);

//mset
string mset_ = "set China Beijing Japan Tokyo";
redisReply *reply = (redisReply *)redisCommand(redis_handle, mset_.c_str());
if (reply!=NULL && reply->type==REDIS_REPLY_STATUS) {
    printf("%s\n", reply->str);
}
freeReplyObject(reply);

//get
string get_ = "get China";
redisReply *reply = (redisReply *)redisCommand(redis_handle, get_.c_str());
if (reply!=NULL && reply->type==REDIS_REPLY_STRING) {
    printf("%s\n", reply->str);
}
freeReplyObject(reply);  //使用reply以后必须要进行释放

//mget
string mget_ = "mget China Japan";
redisReply *reply = (redisReply *)redisCommand(redis_handle, mget_.c_str());
if (reply!=NULL && reply->type==REDIS_REPLY_ARRAY) {
    for (int i=0; i<reply->elements; ++i) {
        printf("%s\n", reply->element[i]->str);
    }
}
freeReplyObject(reply);

当命令执行发生错误时,reply为NULL,redis_handle中的err字段将被设置。一旦错误返回,redis_handle不能被重用,你应该建立一个新的连接。

redisReply *reply = (redisReply *)redisCommand(redis_handle, mget_str.c_str());
if (reply == NULL) {
    printf("Error:%s\n", redis_handle->errstr);
    redisReconnect(redis_handle);
}

进阶

由于hiRedis是非线程安全的,即一个redis_handle不能同时被多个线程使用,因此通过连接池解决并发访问redis的问题

#include <string>
#include <mutex>
#include "hiredis.h"

class redis_pool {

        public:
                redis_pool() {
                }

                ~redis_pool() {
                        for (int i=0; i<conn_num; ++i) {
                                if (conn_pool[i] != NULL) {
                                        redisFree(conn_pool[i]);
                                        conn_pool[i] = NULL;
                                }

                        }
                        delete [] conn_pool;

                        if (conn_flag != NULL) {
                                delete [] conn_flag;
                                conn_flag = NULL;
                        }
                }

                int init(std::string ip_, int port_, int conn_num_) {
                        ip = ip_;
                        port = port_;
                        conn_num = conn_num_;


                        conn_pool = new redisContext * [conn_num];
                        if (conn_pool == NULL) {
                                return 1;
                        }

                        conn_flag = new int[conn_num];
                        if (conn_flag == NULL) {
                                return 2;
                        }

                        for (int i=0; i<conn_num; ++i) {
                                conn_pool[i] = redisConnect(ip.c_str(), port);
                                if (conn_pool[i]==NULL || conn_pool[i]->err) {
                                        return 3;
                                }

                                conn_flag[i] = 0;
                        }

                        empty_num = conn_num;
                        current_conn = 0;

                        return 0;
                }

                redisContext *get_conn(int &id) {
                        if (empty_num == 0) {
                                return NULL;
                        }

                        mtx.lock();

                        while (conn_flag[current_conn] != 0) {current_conn = (current_conn+1) % conn_num;}

                        conn_flag[current_conn] = 1;
                        --empty_num;
                        id = current_conn;
                        current_conn = (current_conn+1) % conn_num;

                        mtx.unlock();

                        return conn_pool[id];
                }

                void put_conn(int id) {
                        if (id<conn_num && id>=0) {
                                mtx.lock();

                                conn_flag[id] = 0;
                                ++empty_num;

                                mtx.unlock();
                        }

                        return;
                }

        private:
                std::string ip;
                int port;
                int conn_num;

                redisContext **conn_pool;
                int *conn_flag;
                int empty_num;
                int current_conn;

                std::mutex mtx;

};

备注

  • redis对于空闲连接,会在一定时间内关闭,当hiRedis的连接被关闭时,通过redisCommand返回的reply为NULL,需要调用redisReconnect重连
  • 调用redisEnableKeepAlive并未达到保持连接的效果
  • 当key不存在时,redisCommand并不会返回失败,只是str成员会为NULL

参考

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 221,273评论 6 515
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 94,349评论 3 398
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 167,709评论 0 360
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 59,520评论 1 296
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 68,515评论 6 397
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 52,158评论 1 308
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 40,755评论 3 421
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 39,660评论 0 276
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 46,203评论 1 319
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 38,287评论 3 340
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 40,427评论 1 352
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 36,122评论 5 349
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 41,801评论 3 333
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 32,272评论 0 23
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 33,393评论 1 272
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 48,808评论 3 376
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 45,440评论 2 359

推荐阅读更多精彩内容