hiredis中异步的实现小结

前言

一般情况下我们使用的都是hiredis的同步通信机制，这种机制下每当你向服务器发送命令请求，程序都会阻塞直到收到服务器的回复并处理。而如果采用异步通信，程序就不需要阻塞等待服务器的回复，而是直接继续执行后边的代码，当服务器回复到来后由程序中预先注册的回调函数来处理回复。

同步通信下程序写起来逻辑更清晰，代码量也少，但是由于每次请求都要停下来等待回复，可能会影响程序的运行速度。异步通信下程序逻辑会变得很复杂，你必须考虑回调函数的编写，并且需要多开一个线程来实现异步事件的处理，但是异步通信下程序在发送完redis命令请求后不需要等待回复，可以继续做其他事，程序速度的提升自然不言而喻。异步通信比较适合程序对速度要求比较高的情况下。

hiredis中的异步api

hiredis中有一套异步api可供我们使用。要使用hiredis中的异步api你必须先了解hiredis中的异步实现。hiredis的异步主要是通过libevent等异步事件触发库来实现的。hiredis可以通过一下事件触发库：libae(redis自带的异步事件触发库）、libev、libuv、libevent中的一个实现。在我的实际使用中，libae库出现了头文件问题，libev出现了异步消息无法接受的问题，libuv没有安装成功，所有我最终选择了libevent库，而这个库的表现也非常稳定。

要使用redis客户端的异步通信，单靠hiredis自带的那几个api是不够的，还需要事件触发库的支持。这里要黑一下hiredis的github主页，上边的异步api说明中没有讲解hiredis异步api所需的那些事件触发库，让我想当然的以为单单依靠hiredis的自带api就可以实现异步，结果浪费了大量时间去调试错误的程序，希望大家引以为戒。下边就以libevent为例讲一下hiredis异步api用到的事件触发库。

事件触发库libevent

libevent是一个成熟事件触发库，分布式缓存软件memcached就使用了这个库。libevent可以实现对多种事件的触发管理。详细的说，你可以通过libevent去对各种IO事件进行触发注册，之后如果该IO事件发生，libevent就会直接调用你之前为IO事件注册的函数来处理这个事件。除了IO事件外，libevent还可以管理定时器事件、信号事件，功能非常的强大。

下边简单讲一下libevent的使用。libevent本身的使用是比较复杂的，考虑到我们的重点是hiredis，所以这里只讲hiredis中要用到的。libevent首先要设置并添加你要监听的异步事件，这一步hiredis已经为你做好了，只需要两步：

base = event_base_new();//创建一个新的libevent事件处理实例。

redisLibeventAttach(ac, base);//对hiredis进行libevent事件注册，这里的base就是上一步创建的事件处理实例

event_base_dispatch(base);//开始libevent事件处理循环。运行这个函数后libevent才真正开始监听并处理事件。在实际的hiredis使用中这个函数通常要单独开一个线程去运行，因为这个函数运行后就会陷入死循环。

hiredis用到的libevent函数就这么几个，是不是觉得很简单！

hiredis异步APi的使用

下边才是重点，如何使用hiredis的异步API来实现我们要做的redi异步通信。

首先要创建连接：

redisAsyncContext *c = redisAsyncConnect("127.0.0.1", 6379);

这里的创建连接跟同步下区别不大。但是需要注意的是异步的连接函数会立刻返回，不论你的程序是否真的连上了redis服务器。是否成功连接只能在连接回调函数中确定。所以不要指望依靠这个函数去检查你的连接是否成功建立。

可以通过这个函数注册连接回调函数：

redisAsyncSetConnectCallback(c, ccdbRedisAsync::connectCallback);

回调函数需要是下边的格式：

void ccdbRedisAsync::connectCallback(const redisAsyncContext *c, int status)

其中参数status会告诉你连接是否成功。

以下函数实现断开连接以及相应的回调函数：

redisAsyncDisconnect(c);//断开连接

redisAsyncSetDisconnectCallback(c, ccdbRedisAsync::disconnectCallback);//回调函数的格式和使用同连接回调函数

如果你想实现redis的断线重连，那么就可以考虑在上边的回调函数中实现。

注意创建连接后还要进行之前的libevent事件注册过程。

连接创建好后解可以发送命令了。异步命令的发送方式和同步很像，区别在于异步发送函数执行后只能得到该命令是否成功过加入发送队列的返回，而无法确定这个命令是否发送成功以及命令的返回。

int redisAsyncCommand(

redisAsyncContext *ac, redisCallbackFn *fn, void *privdata, const char *format, ...);//参数fn是回调函数的地址，privdate可以用来存储            任意的用户指针，这个指针可以在回调函数调用的时候得到

一般你需要设置一个回调函数来处理命令的返回：

void(redisAsyncContext *c, void *reply, void *privdata);

其中的reply参数指向的是与同步下有相同定义的reply结构。注意此处的reply占用的空间是会在回调函数执行后被自动释放的，这点要区别于同步。private参数是你发送命令时所指定的指针，你可以把一些信息，例如所执行的命令保存在这个指针的空间中，这样回调函数被调用的时候你才能判断这个回复是由之前执行的哪个命令产生的。

上边就是异步redis所需的主要API了。

例程

下边的例程来自hiredis的作者。注意这个历程里边没有为libevent事件处理单开线程，这在实际运用中是不多见的。

#include <stdio.h>
#include <stdlib.h>
#include <string.h>
#include <signal.h>

#include <hiredis.h>
#include <async.h>
#include <adapters/libevent.h>

//设置命令执行后的回调函数
void getCallback(redisAsyncContext *c, void *r, void *privdata) {
    redisReply *reply = r;
    if (reply == NULL) return;
    printf("argv[%s]: %s\n", (char*)privdata, reply->str);

    /* Disconnect after receiving the reply to GET */
    redisAsyncDisconnect(c);
}

//设置连接回调函数
void connectCallback(const redisAsyncContext *c, int status) {
    if (status != REDIS_OK) {
        printf("Error: %s\n", c->errstr);
        return;
    }
    printf("Connected...\n");
}

//设置断开连接回调函数
void disconnectCallback(const redisAsyncContext *c, int status) {
    if (status != REDIS_OK) {
        printf("Error: %s\n", c->errstr);
        return;
    }
    printf("Disconnected...\n");
}

int main (int argc, char **argv) {
    signal(SIGPIPE, SIG_IGN);//捕捉程序收到数据包时候的信号
    struct event_base *base = event_base_new();//新建一个libevent事件处理

    redisAsyncContext *c = redisAsyncConnect("127.0.0.1", 6379);//新建异步连接
    if (c->err) {
        /* Let *c leak for now... */
        printf("Error: %s\n", c->errstr);
        return 1;
    }

    redisLibeventAttach(c,base);//将连接添加到libevent事件处理
    redisAsyncSetConnectCallback(c,connectCallback);//设置连接回调
    redisAsyncSetDisconnectCallback(c,disconnectCallback);//设置断开连接回调
    redisAsyncCommand(c, NULL, NULL, "SET key %b", argv[argc-1], strlen(argv[argc-1]));//发送set命令
    redisAsyncCommand(c, getCallback, (char*)"end-1", "GET key");//发送get命令
    event_base_dispatch(base);//开始libevent循环。注意在这一步之前redis是不会进行连接的，前边调用的命令发送函数也没有真正发送命令
    return 0;
}

hiredis中异步的实现小结