Redis及其C庫(kù)Hiredis的使用和封裝

首先,Redis是一個(gè)開(kāi)源的使用C語(yǔ)言編寫(xiě)、開(kāi)源、支持網(wǎng)絡(luò)、可基于內(nèi)存亦可持久化的日志型、高性能的Key-Value數(shù)據(jù)庫(kù),并提供多種語(yǔ)言的API。一般開(kāi)發(fā)者對(duì)Redis應(yīng)該都有所耳聞,而Hiredis是一個(gè)Redis的C客戶端庫(kù)函數(shù),基本實(shí)現(xiàn)了Redis的協(xié)議的最小集。在C/C++開(kāi)發(fā)中如果要使用Redis,則Hiredis是比較常用到的。

Redis的安裝這里不表,只說(shuō)常用的Redis操作。

Redis操作

Redis其實(shí)就是一種特殊的數(shù)據(jù)庫(kù),這種數(shù)據(jù)庫(kù)的存儲(chǔ)方式為鍵值對(duì)的存儲(chǔ)方式,能夠高效地進(jìn)行數(shù)據(jù)的存取。

要使用一種數(shù)據(jù)庫(kù),除了安裝外,操作上的第一部肯定是連接,redis的遠(yuǎn)程連接命令為:

redis-cli -h host -p port -a password

從命令中我們可以看到,連接redis和連接mysql差不多,都需要host、端口及密鑰。

連接上Redis庫(kù)后,就可以開(kāi)始操作我們的數(shù)據(jù),其支持五種數(shù)據(jù)類(lèi)型:string(字符串),hash(哈希),list(列表),set(集合)及zset(sorted set:有序集合)。

字符串可能是最常用的存儲(chǔ)類(lèi)型,這種數(shù)據(jù)的存取就是簡(jiǎn)單的對(duì)鍵進(jìn)行 set 和 get 操作:

$ set cloudox "boy"
OK
$ get cloudox
"boy"

這里的鍵是“cloudox”,我存儲(chǔ)的值是“boy”,很簡(jiǎn)單對(duì)吧。

hash哈希類(lèi)型用于存儲(chǔ)鍵值對(duì)集合,list列表用來(lái)存儲(chǔ)的也是集合,但支持一些范圍操作,比如:

$ lpush cloudox a
(interger)1
$ lpush cloudox b
(interger)2
$ lpush cloudox c
(interger)3

$ lrange cloudox 0 1
"c" "b"

這里的lpush命令時(shí)往列表的隊(duì)頭插入,所以實(shí)際上我們得到的列表為:"c" "b" "a"。lrange就根據(jù)兩個(gè)數(shù)字表示的閉區(qū)間范圍來(lái)獲取元素?cái)?shù)組。

set集合是通過(guò)哈希表實(shí)現(xiàn)的集合,不能往一個(gè)鍵上插入同一個(gè)字符串兩次。zset是有序集合,也就是在set的基礎(chǔ)上,還加上了一個(gè)順序(分?jǐn)?shù)):

$ zadd cloudox 1 a
(interger)1
$ zadd cloudox 1 a
(interger)0
$ zadd cloudox 2 b
(interger)1
$ zadd cloudox 3 c
(interger)1

$ zrangebyscore cloudox 1 2
1) "a"
2) "b"

如上,和set一樣,成功插入返回1,否則返回0。兩次插入同樣的“a”,會(huì)返回0。zrangebyscore的用法和list中的lrange差不多,通過(guò)數(shù)字劃定的閉區(qū)間范圍來(lái)獲取在該順序(分?jǐn)?shù))中的值。

分?jǐn)?shù)為float,可以是正數(shù)、負(fù)數(shù)、0。在查找是,可用 -inf +inf 來(lái)表示負(fù)無(wú)窮和正無(wú)窮。

更詳細(xì)的操作可以參考:
博客:https://blog.csdn.net/softwave/article/details/51084101
和文檔:http://redisdoc.com/sorted_set/zrangebyscore.html

Hiredis使用

更多的對(duì)Redis的操作還是在代碼中,Hiredis就是一個(gè)C庫(kù)函數(shù),提供了基本的操作函數(shù):

比如數(shù)據(jù)庫(kù)連接、發(fā)送命令、釋放資源:

/**連接數(shù)據(jù)庫(kù)*/
redisContext *redisConnect(const char *ip, int port);
/**發(fā)送命令請(qǐng)求*/
void *redisCommand(redisContext *c, const char *format, ...);
void *redisCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen);
void redisAppendCommand(redisContext *c, const char *format, ...);
void redisAppendCommandArgv(redisContext *c, int argc, const char **argv, const size_t *argvlen);
/*釋放資源*/
void freeReplyObject(void *reply);
void redisFree(redisContext *c);

在使用時(shí),一般順序?yàn)橄扔?redisConnect 連接數(shù)據(jù)庫(kù),然后用 redisCommand 執(zhí)行命令,執(zhí)行完后用 freeReplyObject 來(lái)釋放redisReply對(duì)象,最后用 redisFree 來(lái)釋放整個(gè)連接。

命令執(zhí)行函數(shù)返回的其實(shí)是一個(gè)指向redisReply對(duì)象的指針,redisReply對(duì)象是存儲(chǔ)Redis操作返回結(jié)果的結(jié)構(gòu)體:

/* This is the reply object returned by redisCommand() */
typedef struct redisReply {
    /*命令執(zhí)行結(jié)果的返回類(lèi)型*/
    int type; /* REDIS_REPLY_* */
    /*存儲(chǔ)執(zhí)行結(jié)果返回為整數(shù)*/
    long long integer; /* The integer when type is REDIS_REPLY_INTEGER */
    /*字符串值的長(zhǎng)度*/
    size_t len; /* Length of string */
    /*存儲(chǔ)命令執(zhí)行結(jié)果返回是字符串*/
    char *str; /* Used for both REDIS_REPLY_ERROR and REDIS_REPLY_STRING */
    /*返回結(jié)果是數(shù)組的大小*/
    size_t elements; /* number of elements, for REDIS_REPLY_ARRAY */
    /*存儲(chǔ)執(zhí)行結(jié)果返回是數(shù)組*/
    struct redisReply **element; /* elements vector for REDIS_REPLY_ARRAY */
} redisReply;

關(guān)于Hiredis原生接口的使用和介紹,這篇博客寫(xiě)的很詳細(xì)了:http://www.itdecent.cn/p/cafb80392fbb

這里提供一個(gè)C++封裝的接口類(lèi),來(lái)方便在C++開(kāi)發(fā)中的使用:

#ifndef HIREDISHELPER_H_
#define HIREDISHELPER_H_

#include "hiredis/include/hiredis.h"
#include <string>
#include <vector>

using namespace std;

class HiredisHelper {
public:
    void Init(const string &ip, int port, const string &auth_str,int timeout = 200) { //ms
        m_ip = ip;
        m_port = port;
        m_timeout = timeout;
        m_ctx = NULL;
        m_authstring = auth_str;
    }

    virtual ~HiredisHelper() {
        if (m_ctx) {
            redisFree(m_ctx);
            m_ctx = NULL;
        }
    }

    //調(diào)用者需自行調(diào)用  freeReplyObject(reply);
    redisReply *ExecuteCmd(const char *format, ...);
    redisReply* ExecuteCmd(const string &cmd);
private:
    int Connect();

private:
    int m_timeout;
    int m_port;
    string m_ip;
    string m_authstring;
    redisContext* m_ctx;
};

接口類(lèi)主要提供初始化及命令執(zhí)行函數(shù),連接操作在執(zhí)行命令時(shí)會(huì)檢測(cè)并連接,對(duì)連接的釋放會(huì)自動(dòng)進(jìn)行,但對(duì)reply的釋放還是需要手動(dòng)操作,因?yàn)樾枰煤笤籴尫拧?/p>

具體的實(shí)現(xiàn)代碼在我的git工程中可以獲取,其使用示例如下:

#include <iostream>
#include <vector>
#include <sstream>
#include "HiredisHelper.h"

using namespace std;

// hiredis官方: https://github.com/redis/hiredis/

#define CHECK_FREE_REDIS_REPLY(reply) \
    if (reply) {\
        freeReplyObject(reply);\
    } else {\
        cout << "freeReplyObject Fail" << endl;\
    }

int addStrContent(HiredisHelper &redis_conn) {
    string m_redis_key = "cloudox";
    stringstream ss_cmd;
    ss_cmd << "SET " << m_redis_key;
    ss_cmd << " " << "boy";

    string cmd = ss_cmd.str()
    redisReply *reply = redis_conn.ExecuteCmd(cmd);
    if (reply) {
        cout << "push redis succ " << cmd << endl;
        return 0;
    } else {
        cout << "push redis fail " << cmd << endl;
        return -1;
    }
    CHECK_FREE_REDIS_REPLY(reply);
}

int getStrContent(HiredisHelper &redis_conn, string &item) {
    string m_redis_key = "cloudox";
    stringstream ss_cmd;
    ss_cmd << "GET " << m_redis_key;

    string cmd = ss_cmd.str()
    redisReply *reply = redis_conn.ExecuteCmd(cmd);
    if (reply && reply->type == REDIS_REPLY_STRING) {
        item = reply->str;
        return 0;
    } else {
        cout << "get redis fail " << cmd << endl;
        return -1;
    }
    CHECK_FREE_REDIS_REPLY(reply);
}

int addZsetContent(HiredisHelper &redis_conn) {
    string m_redis_key = "cloudox";
    stringstream ss_cmd;
    ss_cmd << "ZADD " << m_redis_key;
    ss_cmd << " " << "1" << " " << "boy";

    string cmd = ss_cmd.str()
    redisReply *reply = redis_conn.ExecuteCmd(cmd);
    if (reply) {
        cout << "push redis succ " << cmd << endl;
        return 0;
    } else {
        cout << "push redis fail " << cmd << endl;
        return -1;
    }
    CHECK_FREE_REDIS_REPLY(reply);
}

int getZsetContent(HiredisHelper &redis_conn, vector<string> &items) {
    string m_redis_key = "cloudox";
    stringstream ss_cmd;
    ss_cmd << "ZRANGEBYSCORE " << m_redis_key << " -inf " << "5" << " limit 0 10"; 
    // 取負(fù)無(wú)窮~5分值內(nèi)的從第一個(gè)開(kāi)始的十個(gè)值。

    string cmd = ss_cmd.str()
    redisReply *reply = redis_conn.ExecuteCmd(cmd);
    if (reply && reply->type == REDIS_REPLY_ARRAY) {
        cout << "reply size:" << reply->elements << endl;
        for (size_t i = 0; i < reply->elements; ++i) {
            if (NULL != reply->element[i]) {
                redisReply *ele = reply->element[i];
                if (ele->type == REDIS_REPLY_INTEGER) {
                    items.push_back(to_string(ele->integer));// C++11
                } else if (ele->type == REDIS_REPLY_STRING) {
                    string s(ele->str, ele->len);
                    items.push_back(s);
                }
            }
        }

        return 0;
    } else {
        cout << "get redis fail " << cmd << endl;
        return -1;
    }
    CHECK_FREE_REDIS_REPLY(reply);
}

int main() {

    HiredisHelper redis_conn;
    string redis_ip = "172.20.0.4";
    int redis_port = 6379;
    string redis_auth = "crs-fsdfjlskdjflsajdlfas";
    redis_conn.Init(redis_ip, redis_port, redis_auth);

    // 添加字符串內(nèi)容
    int ret = addStrContent(redis_conn);

    // 獲取字符串內(nèi)容
    string item;
    ret = getStrContent(redis_conn, item);
    cout << item << endl;


    // 添加有序集合內(nèi)容
    ret = addZsetContent(redis_conn);

    // 獲取有序集合內(nèi)容
    vector<string> items;
    ret = getZsetContent(redis_conn, items);
    if (ret == 0) {
        for (int i = 0; i < items.size(); ++i) {
            cout << items[i] << endl;
        }
    }

    system("pause");// 暫停以顯示終端窗口
    return 0;
}

提供了對(duì)字符串和有序集合兩種數(shù)據(jù)類(lèi)型的存取操作,其他的也都類(lèi)似,其實(shí)Hiredis及封裝類(lèi)主要是提供了對(duì)redis的使用,真正的操作還是靠自己組裝命令來(lái)執(zhí)行,畢竟沒(méi)有做的特別細(xì)致,過(guò)于細(xì)致其實(shí)也就不夠通用了嘛。


查看作者首頁(yè)

最后編輯于
?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成,瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明:文章內(nèi)容(如有圖片或視頻亦包括在內(nèi))由作者上傳并發(fā)布,文章內(nèi)容僅代表作者本人觀點(diǎn),簡(jiǎn)書(shū)系信息發(fā)布平臺(tái),僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容