向优秀代码学习：Redis代码库源码概览

Redis是一个用ANSI C 编写的开源数据结构服务器。“数据结构服务器”只是对灵巧的key-value存储服务的另外一种称谓。你不仅仅可以存储简单的字符串，还可以存储包括 hash（或者map，甚至dicts），list，set，sorted set。我们在Top10 中 大量应用了Redis，大部分为了根据用户搜索的日期和酒店的空房情况和价格建立索引。我发现Redis的代码非常容易读懂，甚至是对于像我这样的新手。 代码写的很整洁，并且代码量相对较小（4.5万行左右），大部分都是单线程的，依赖也很少。所有的依赖都跟源代码放在一起了，这中做法让编译它变得非常简 单：clone它的库，然后输入make即可。

我们提供的服务有：成都网站设计、网站建设、外贸网站建设、微信公众号开发、网站优化、网站认证、新城ssl等。为上1000家企事业单位解决了网站和推广的问题。提供周到的售前咨询和贴心的售后服务，是有科学管理、有技术的新城网站制作公司

我决定通过为它增加一条命令来深入代码。而这简单的事情可以让我知道Redis怎么处理一条命令并调度响应它。命令rand，接收一个整型值作为 max，并随机返回0到max（不包含max）之间的一个整数。这不是使用键值存储的思路，但是实现它将会很有启发性。而我也肯定不会提交一个pull request。

免责声明：如我之前所说，我绝对不是一个C语言的专家，因此这里所有的代码和其解释都符合这个条款。而且，我链接了Redis的一个不稳定分支，所以它是不稳定的。如果你自己去获取Redis源码，用你喜欢的编辑器来查看时，你将发现更多本文的不同，特别是如果你编译并运行时会发现不同。

命令表在src/redis.c文件的靠顶部的位置。它是一个数组，数组的元素类型是redisCommand结构体。redisCommand是在src/redis.h中定义的。在redisCommandTable的上方有一块比较详细的注释，对它的每一个field做了解释。下面是get命令的定义：

 
 
 
    
  
  
  
  1. {"get",getCommand,2,"r",0,NULL,1,1,1,0,0}, 
    2.

***个field是命令的名字“get”。第二个field是一个函数指针，指向这个命令的具体实现（你可以查看实现细节t_string.c）。

第三个field是命令的参数数量限制（命令接收的参数个数）。指定这个，意味着在调用函数指针之前，查找和执行命令的代码可以做一个预先验证。这 种做法减少了在每个命令函数必须的错误处理代码。参数的个数算上了命令名字本身，所以它只接受两个参数：它自己的名字，key的名字（我们要获取它的 值）。

第四个field，被设为”r”，用来指明这个命令是只读的，不能修改这个key的value或状态。有一大堆的字母标志，你都可以用在这个位置。 而且在附近的注释块中，每个字母标志都有详细的解释。紧跟这个field的field总是被设置为0，后面会用来计算。它只是第四个field的字符串包 含信息的位掩码。

第六个field是NULL，因为它只有在你要用复杂的逻辑去告诉Redis哪个参数才是真正的key的时候才需要。一个key指向一个存储在 Redis中的值的引用，对应简单的参数，例如我们的max参数。这种机制，允许Redis在调用命令的实现之前，提取key的值（并且校验key是否存 在）。如果这个field被设置了值，那么它将会是一个函数指针，指向的函数会返回一个参数索引的整型数组（db.c中 的zunionInterGetKeys是一个示例）。在get命令（其他大部分命令）的场景下，这个数组的信息传达的信息跟后面三个field的一样。 get命令只有一个参数，而它就是key。因此，***个参数（key）在位置1上，***一个参数（也是key）在位置1上，从***个参数到***一个参数的 增量也是1（译者注：源码注释是：intkeystep;/* The step between first and last key */）。

redisCommand的***两个field是命令的度量项，由Redis来设置，并且总是初始化为0。

在命令表的底部加上我们的命令：

 
 
 
    
  
  
  
  1. {"rand",randCommand,2,"rRl",0,NULL,0,0,0,0,0} 
    2.

命令的名字是“rand”，randCommand指向实现的指针（还未实现），它接收2个参数（命令名字和max）。至于标志，它是只读的（r），返回随机的，不确定的输出（R），而且它可以在Redis还在加载数据的时候使用（l）。它没有关键参数。

下一步是在src/redis.h中增加randCommand的函数原型。Redis命令的函数接收一个参数，一个redisClient的结构体，作为命令的参数同时也用来向实际的客户端发送响应。

 
 
 
    
  
  
  
  1. void randCommand(redisClient *c); 
    2.

这个原型应该放在src/redis.h中与其他所有命令的原型一起。搜索下面的一行：

 
 
 
    
  
  
  
  1. /* Commands prototypes */ 
    2.

这将帮你找到正确的位置。

我们在src/redis.c中加一个空实现：

 
 
 
    
  
  
  
  1. void randCommand(redisClient *c) {  
    2.   
  
  
  2.   
    3.   
  
  
  3. } 
    4.

我将它加在了infoCommand定义的旁边。现在，我们执行make命令。

 
 
 
    
  
  
  
  1. make 
    2.

然后，启动我们刚刚编译成共的Redis服务（如果你已经有一个Redis服务在本地运行，你应该停掉它）：

 
 
 
    
  
  
  
  1. > src/redis-server 
    2.

接着我们在另外的终端中运行Redis客户端，并试着运行我们的命令：

 
 
 
    
  
  
  
  1. >redis-cli 
    2.

首先，我们试一试我们的异常处理：

 
 
 
    
  
  
  
  1. redis 127.0.0.1:6379> rand  
    2.   
  
  
  2. (error) ERR wrong number of arguments for 'rand' command 
    3.

很好，参数数量限制检查是正常的。这一次我们指定一个参数：

 
 
 
    
  
  
  
  1. redis 127.0.0.1:6379> rand 1 
    2.

Redis卡住了。这正是我预期的，因为我在randCommand函数中没有任何响应。将服务停掉，我们接着回去看代码。

我们想返回一个整数，因此我在代码里翻找例子，***在src/t_zset.c中找到了zcardCommand。这个命令用addReplyLongLong来向客户端返回一个64位（long long）的整数。我们也试一下： 

 
 
 
    
  
  
  
  1. void randCommand(redisClient *c) {  
    2.   
  
  
  2.     addReplyLongLong(c,3);  
    3.   
  
  
  3. } 
    4.

然后，我们在make一次，并测试命令：

 
 
 
    
  
  
  
  1. redis 127.0.0.1:6379> rand 1  
    2.   
  
  
  2. (integer) 3  
    3.   
  
  
  3.   
    4.   
  
  
  4. redis 127.0.0.1:6379> rand 2  
    5.   
  
  
  5. (integer) 3  
    6.   
  
  
  6.   
    7.   
  
  
  7. redis 127.0.0.1:6379> rand 3  
    8.   
  
  
  8. (integer) 3 
    9.

好吧，结果不是太随机，但这只是个开始。我们从命令里获取参数max，并返回一个由max限制的随机数：

 
 
 
    
  
  
  
  1. void randCommand(redisClient *c) {  
    2.   
  
  
  2.     long max;  
    3.   
  
  
  3.   
    4.   
  
  
  4.     if (getLongFromObjectOrReply(c,c->argv[1],&max,NULL) != REDIS_OK)  
    5.   
  
  
  5.         return;  
    6.   
  
  
  6.   
    7.   
  
  
  7.     addReplyLongLong(c,random() % max);  
    8.   
  
  
  8. } 
    9.

尽管Redis在整个代码库中都用原始类型和C型字符串，但它同时也拥有自己的以更通用的方式存在的内部对象系统，用来表示字符串，长整 型和更复杂的类型。一个利用这种类型的例子就是：每个命令的参数。每一个命令的参数都作为一个Redis对象被存在redisClient实例c的 field，数组argv里。（译注：在源码src/redis.c里面redisClient是一个结构体，argv是一个redisObject指针 的指针）。在src/t_string.c里面有一个从Redis对象获取长整型的例子：getrangeCommand，它调用了src/object.c中的getLongFromObjectOrReply函数。

 getLongFromObjectOrReply函数接收一个redisClient实例作参数，并检查它的第二个参数是否是一个长整型， 如果是则将第二个参数的指针赋给第三个参数（这个参数是一个指针类型），并且返回REDIS_OK。如果第二个参数不是长整型（或溢出了），函数返回 REDIS_ERR。这个方法的美丽之处在于：如果我们从我们的randCommand函数得到的返回值是REDIS_ERR，所有必须的错误响应已经被 发送给客户端了。我们再试一下我们的命令：

 
 
 
    
  
  
  
  1. redis 127.0.0.1:6379> rand 10  
    2.   
  
  
  2. (integer) 9  
    3.   
  
  
  3. redis 127.0.0.1:6379> rand notanumber  
    4.   
  
  
  4. (error) ERR value is not an integer or out of range  
    5.   
  
  
  5. redis 127.0.0.1:6379> rand 10  
    6.   
  
  
  6. (integer) 3  
    7.   
  
  
  7. redis 127.0.0.1:6379> rand 10  
    8.   
  
  
  8. (integer) 1  
    9.   
  
  
  9. redis 127.0.0.1:6379> rand 100  
    10.   
  
  
  10. (integer) 43  
    11.   
  
  
  11. redis 127.0.0.1:6379> rand 100  
    12.   
  
  
  12. (integer) 55  
    13.   
  
  
  13. redis 127.0.0.1:6379> rand 100  
    14.   
  
  
  14. (integer) 86 
    15.

看起来不错！rand看起来是一个没有多少意义的命令，但是从实现它的过程中学到很多关于Redis的东西，我希望你跟着做下来也同样学到很多。请在评论 里告诉我这篇文章里是否明显的错误。我也很高兴知道这篇文章对你很有用或者你很喜欢它。我考虑写一些类似的东西，关于Redis或者其他的开源的代码库。

原文链接：http://www.heychinaski.com/blog/2013/10/14/a-look-at-the-redis-source-code

译文链接：http://blog.jobbole.com/50837/

名称栏目：向优秀代码学习：Redis代码库源码概览
当前网址：http://www.gawzjz.com/qtweb/news35/208785.html

网站建设、网络推广公司-创新互联，是专注品牌与效果的网站制作，网络营销seo公司；服务项目有等

广告

声明：本网站发布的内容（图片、视频和文字）以用户投稿、用户转载内容为主，如果涉及侵权请尽快告知，我们将会在第一时间删除。文章观点不代表本网站立场，如需处理请联系客服。电话：028-86922220；邮箱：631063699@qq.com。内容未经允许不得转载，或转载时需注明来源： 创新互联

猜你还喜欢下面的内容

动态网站知识

行业网站建设

网络口碑营销　　 　德昌麦琪建站　　 　成都广告制作　　 　四川主机托管　　 　网站排名　　 　正泰动物制药　　 　软文推广　　 　特丽尔硅藻泥　　 　全网营销　　 　关键词排名　　 　网络营销推广　　 　IOS开发　　 　短视频拍摄　　 　网站SEO优化排名　　 　手机网站制作　　 　成都橡塑保温管　　 　广安园林绿化公司　　 　app制作　　 　重庆网站建设　　 　成都网站推广