前段时间学习 redis 时候,听到 hiredis 的大名,正好也在做异步的学习,就找来代码学习一下。我几乎不太会 c,仅限于最简单的语法,完全没有在生产环境中写过,所以先看个 client 简单代码,下次看 memcached 代码应该会更顺畅一些。 hiredis 是用 c 写的 r
前段时间学习 redis 时候,听到 hiredis 的大名,正好也在做异步的学习,就找来代码学习一下。 我几乎不太会 c,仅限于最简单的语法,完全没有在生产环境中写过, 所以先看个 client 简单代码,下次看 memcached 代码应该会更顺畅一些。
hiredis 是用 c 写的 redis 客户端,对 redis 协议进行了简单的封装, 同时提供了同步和异步的两种 api。hiredis 的代码位于 https://github.com/redis/hiredis。
一分钟使用入门
同步 api 的调用方法:
rediscontext *context = redisconnect("127.0.0.1", 6379);
reply = rediscommand(context, "set foo %s", value);
printf("ping: %sn", reply->str);
freereplyobject(reply)
redisfree(context);
redis ae 异步 api 的调用方法,使用 redis 自己的 ae 事件库, 至于为什么 redis 没有使用 libevent 或者 libev,可以参考 reason, 中文翻译:
void connectcallback(const redisasynccontext *c, int status) {
printf("connected...n");
}
void disconnectcallback(const redisasynccontext *c, int status) {
printf("disconnected...n");
}
void getcallback(redisasynccontext *c, void *r, void *privdata) {
redisreply *reply = r;
if (reply == null) return;
printf("argv[%s]: %sn", (char*)privdata, reply->str);
redisasyncdisconnect(c);
}
redisasynccontext *c = redisasyncconnect("127.0.0.1", 6379);
loop = aecreateeventloop();
redisaeattach(loop, c);
redisasyncsetconnectcallback(c,connectcallback);
redisasyncsetdisconnectcallback(c,disconnectcallback);
redisasynccommand(c, getcallback, (char*)"end-1", "get key");
libev 异步 api 调用,因为 adapters/*.h 封装的好,所以几乎和 ae 调用一致:
void connectcallback(const redisasynccontext *c, int status) {
printf("connected...n");
}
void disconnectcallback(const redisasynccontext *c, int status) {
printf("disconnected...n");
}
void getcallback(redisasynccontext *c, void *r, void *privdata) {
redisreply *reply = r;
if (reply == null) return;
printf("argv[%s]: %sn", (char*)privdata, reply->str);
/* disconnect after receiving the reply to get */
redisasyncdisconnect(c);
}
redisasynccontext *c = redisasyncconnect("127.0.0.1", 6379);
redislibevattach(ev_default_ c);
redisasyncsetconnectcallback(c,connectcallback);
redisasyncsetdisconnectcallback(c,disconnectcallback);
redisasynccommand(c, getcallback, (char*)"end-1", "get key");
hiredis 还支持使用 libevent,我就不列出来了。
详细的使用 example 可以看 https://github.com/redis/hiredis/tree/master/examples。
主要结构
- redisreply
- redisreader
- rediscontext
流程
同步连接同步连接的代码在 hiredis.c 和 net.c 中。
redisconnect / redisconnectwithtimeout / redisconnectnonblock 都调用了net.c 里面的 rediscontextconnecttcp。使用 fcntl(fd, f_setfl, flags) 设置是否阻塞连接。
o_nonblock 即 socket 非阻塞模式,但仍然是同步的哦。
事实上,无论阻塞还是非阻塞,hiredis 都会使用非阻塞(poll)来connect 连接服务器,会返回 -1,并且 errno 为 einprogress,这是非阻塞模式正常的表现。 为什么阻塞模式也会强制使用非阻塞的 poll 连接?其实是为了能够支持 timeout 功能。 hiredis 在连接成功之后,按照之前需求重新设定为阻塞或者非阻塞模式。
关于如何设计超时功能,可以参考 http://blog.csdn.net/ast_224/article/details/2957294。
命令使用 va_list 解决变参问题(c 也支持变长参数,被惊呆了,我果然是 c 盲啊)。
int redisformatcommand(char **target, const char *format, ...) {
va_list ap;
int len;
va_start(ap,format);
}
redisvcommand 用来执行阻塞redis 命令,它会调用 __redisblockforreply, 内部调用 redisbufferwrite 从 socket 写 buffer,然后同步等待,从redisbufferread 读数据,用 redisgetreplyfromreader 解析返回数据。
异步连接异步调用的代码在 async.c 中,我先看 ae 库。
重要的结构是 redisasynccontext 和 redisaeevents,前者重要的方法是注册回调函数:addread / delread / addwrite / delwrite,后者是用来存放 loop / fd / event stream 的。
异步连接时候,仍然使用 rediscontextconnecttcp 来发起到服务器的非阻塞连接。
使用 aecreateeventloop 创建一个事件循环,然后使用 redisaeattach 给context 注册事件,比如说 aecreatefileevent(loop,e->fd,ae_readable,redisaereadevent,e) 就注册了一个 read 事件,并将 callback 调用设置到 redisaereadevent,redisaereadevent 再将这个事件托管给 redisasynchandleread(定义在 async.c 里面, 被三个 event 库调用)。
所以,hiredis 通过 adapter 的封装,屏蔽了 ae / libevent / libev 的 api 差异, 从而可以灵活的选择。据说 ae 是从两个 libevent 库重写过来的,可是我觉得 ae 的风格和 libev 比较像,而 libevent 的风格比较好理解。
如果拿这段代码的复杂度和 tornado 的 ioloop 进行对比,真实感觉 tornado 那段 api 封装太人性化了,c 的代码写起来好复杂,系统 api、资源控制、错误控制都挺麻烦。
redis ae 事件库的分析可以参考 http://my.oschina.net/u/917596/blog/161077#osc_h4_6。 libevent 的一个简单教程 http://www.wangafu.net/~nickm/libevent-book/01_intro.html。
关于 c
作为 c 渣的我,勉强读完 hiredis,感觉那点 c 基础完全不够用, 稍微将学习过程中疑惑的地方罗列一下:
- ifdef 使用,可以防止重复导入同一个头文件定义,这里有一个详细的解释 http://faculty.cs.niu.edu/~mcmahon/cs241/c241man/node90.html
- __cplusplus: c++ 里面定义了这个变量,而 c 没有定义,所以当 c++ 编译器识别 source 时候,通过这个加上 ifdef 来使用 extern 编译 c 代码。
- long long: long 只能存放 32 位,long long 可以存放 64 位长度,即 0 - 2^64-1。
- c->flags |= redis_block / c->flags &= ~redis_block; 简洁的位操作。
- sds(simple dynamic string)是 redis 自己实现的 c string 字符串结构。
- ((void)fd) 好像是将 fd 指针转成无类型的指针,不知道有什么用处。
【说明】:本文章由站长整理发布,文章内容不代表本站观点,如文中有侵权行为,请与本站客服联系(QQ:)!