Java干货分享 发表于 2021-9-8 17:16:10

怎样使用空闲时间高效深入地阅读Redis的源码?

前言

学习了黄建宏老师的《Redis设计与实现》之后,对redis的部门实现有了一个简明的认识。在口试过程中,redis确实成为了口试官考核我的一个亮点,恰好以后的工作又与redis有着千丝万缕的联系,于是就想趁着毕业前的这段时间把redis的源代码研究一下,为以后的工作打个精良的底子。


Redis简介
redis全称REmote DIctionary Server,是一个由Salvatore Sanfilippo写的高性能key-value存储系统,其完全开源免费,服从BSD协议。Redis与其他key-value缓存产品(如memcache)有以下几个特点。

[*]Redis支持数据的持久化,可以将内存中的数据保存在磁盘中,重启的时候可以再次加载进行使用。
[*]Redis不仅仅支持简单的key-value类型的数据,同时还提供list,set,zset,hash等数据结构的存储。
[*]Redis支持数据的备份,即master-slave模式的数据备份。
Redis的性能极高且拥有丰富的数据类型,同时,Redis所有操作都是原子性的,也支持对几个操作合并后原子性的执行。另外,Redis有丰富的扩展特性,它支持publish/subscribe, 关照,key 过期等等特性。
Redis更为优秀的地方在于,它的代码风格极其精简,整个源码只有23000行,很有利于阅读和赏析!还在等什么呢?Start!
如何获取Redis源码?
redis是完全开源的,其源代码可以在直接在官网上获取(目前最新版本是3.2.5)。执行以下指令:
cd ... // 这里打开你存放redis的文件夹wget http://download.redis.io/releases/redis-3.2.5.tar.gztar zxvf redis-3.2.5.tar.gz此时,进入解压后的redis目次下的src文件夹,redis的所有源代码都存放在此。
# cd src/# lsMakefile      crc64.h      mkreleasehdr.sh    redis-cli.o   sort.oMakefile.depcrc64.o      multi.c            redis-sentinelsparkline.cadlist.c      db.c         multi.o            redis-server    sparkline.hadlist.h      db.o         networking.c       redis-trib.rb   sparkline.oadlist.o      debug.c      networking.o       redisassert.h   syncio.cae.c          debug.o      notify.c         release.c       syncio.oae.h          debugmacro.h   notify.o         release.h       t_hash.cae.o          dict.c         object.c         release.o       t_hash.oae_epoll.c    dict.h         object.o         replication.c   t_list.cae_evport.c   dict.o         pqsort.c         replication.o   t_list.oae_kqueue.c   endianconv.c   pqsort.h         rio.c         t_set.cae_select.c   endianconv.h   pqsort.o         rio.h         t_set.oanet.c      endianconv.o   pubsub.c         rio.o         t_string.canet.h      fmacros.h      pubsub.o         scripting.c   t_string.oanet.o      geo.c          quicklist.c      scripting.o   t_zset.caof.c         geo.h          quicklist.h      sds.c         t_zset.oaof.o         geo.o          quicklist.o      sds.h         testhelp.hasciilogo.h   help.h         rand.c             sds.o         util.cbio.c         hyperloglog.crand.h             sdsalloc.h      util.hbio.h         hyperloglog.orand.o             sentinel.c      util.obio.o         intset.c       rdb.c            sentinel.o      valgrind.supbitops.c      intset.h       rdb.h            server.c      version.hbitops.o      intset.o       rdb.o            server.h      ziplist.cblocked.c   latency.c      redis-benchmark    server.o      ziplist.hblocked.o   latency.h      redis-benchmark.csetproctitle.cziplist.ocluster.c   latency.o      redis-benchmark.osetproctitle.ozipmap.ccluster.h   lzf.h          redis-check-aof    sha1.c          zipmap.hcluster.o   lzfP.h         redis-check-aof.csha1.h          zipmap.oconfig.c      lzf_c.c      redis-check-aof.osha1.o          zmalloc.cconfig.h      lzf_c.o      redis-check-rdb    slowlog.c       zmalloc.hconfig.o      lzf_d.c      redis-check-rdb.cslowlog.h       zmalloc.ocrc16.c       lzf_d.o      redis-check-rdb.oslowlog.ocrc16.o       memtest.c      redis-cli          solarisfixes.hcrc64.c       memtest.o      redis-cli.c      sort.c源代码结构剖析
看了上面src目次下的文件,简直让人眼花缭乱。这里不得不品评以下redis的作者啊,都没有整理一下源代码,统统都放在一个文件夹下。
正所谓不打无准备的仗,拿到源码之后,我们首先要对这些文件进行一个分类,来规划一下我们的阅读顺序。这里介绍一下在网上看到的源码阅读方法(摘自redis源码剖析)。

[*]自底向上:从耦合关系最小的模块开始读,然后渐渐过度到关系紧密的模块。就好像写程序的测试一样,先从单元测试开始,然后才到功能测试。
[*]从功能入手:通过文件名(模块名)和函数名,快速定位到一个功能的具体实现,然后追踪整个实现的运作流程,从而了解该功能的实现方式。
[*]自顶向下:从程序的 main() 函数,或者某个特别大的调用者函数为入口,以深度优先或者广度优先的方式阅读它的源码。
按照上图对Redis源码的模块分别,初步确定一下源码的学习路线如下:
第一阶段

[*]阅读Redis的数据结构部门,根本位于如下文件中:内存分配 zmalloc.c和zmalloc.h
[*]动态字符串 sds.h和sds.c
[*]双端链表 adlist.c和adlist.h
[*]字典 dict.h和dict.c
[*]跳跃表 server.h文件内里关于zskiplist结构和zskiplistNode结构,以及t_zset.c中所有zsl开头的函数,比如 zslCreate、zslInsert、zslDeleteNode等等。
[*]基数统计 hyperloglog.c 中的 hllhdr 结构, 以及所有以 hll 开头的函数
第二阶段 熟悉Redis的内存编码结构

[*]整数聚集数据结构 intset.h和intset.c
[*]压缩列表数据结构 ziplist.h和ziplist.c
第三阶段 熟悉Redis数据类型的实现

[*]对象系统 object.c
[*]字符串键 t_string.c
[*]列表建 t_list.c
[*]散列键 t_hash.c
[*]聚集键 t_set.c
[*]有序聚集键 t_zset.c中除 zsl 开头的函数之外的所有函数
[*]HyperLogLog键 hyperloglog.c中所有以pf开头的函数
第四阶段 熟悉Redis数据库的实现

[*]数据库实现 redis.h文件中的redisDb结构,以及db.c文件
[*]关照功能 notify.c
[*]RDB持久化 rdb.c
[*]AOF持久化 aof.c
以及一些独立功能模块的实现

[*]发布和订阅 redis.h文件的pubsubPattern结构,以及pubsub.c文件
[*]事务 redis.h文件的multiState结构以及multiCmd结构,multi.c文件
第五阶段 熟悉客户端和服务器端的代码实现

[*]事件处理模块 ae.c/ae_epoll.c/ae_evport.c/ae_kqueue.c/ae_select.c
[*]网路链接库 anet.c和networking.c
[*]服务器端 redis.c
[*]客户端 redis-cli.c
[*]这个时候可以阅读下面的独立功能模块的代码实现
[*]lua脚本 scripting.c
[*]慢查询 slowlog.c
[*]监督 monitor.c
第六阶段 这一阶段主要是熟悉Redis多机部门的代码实现

[*]复制功能 replication.c
[*]Redis Sentinel sentinel.c
[*]集群 cluster.c
其他代码文件介绍

关于测试方面的文件有:

[*]memtest.c 内存检测
[*]redis_benchmark.c 用于redis性能测试的实现。
[*]redis_check_aof.c 用于更新日志检查的实现。
[*]redis_check_dump.c 用于本地数据库检查的实现。
[*]testhelp.c 一个C风格的小型测试框架。
一些工具类的文件如下:

[*]bitops.c GETBIT、SETBIT 等二进制位操作下令的实现
[*]debug.c 用于调试时使用
[*]endianconv.c 高低位转换,不同系统,高低位顺序不同
[*]help.h 辅助于下令的提示信息
[*]lzf_c.c 压缩算法系列
[*]lzf_d.c 压缩算法系列
[*]rand.c 用于产生随机数
[*]release.c 用于发布时使用
[*]sha1.c sha加密算法的实现
[*]util.c 通用工具方法
[*]crc64.c 循环冗余校验
[*]sort.c SORT下令的实现
[*]一些封装类的代码实现:
[*]bio.c background I/O的意思,开启后台线程用的
[*]latency.c 延迟类
[*]migrate.c 下令迁移类,包罗下令的还原迁移等
[*]pqsort.c 排序算法类
[*]rio.c redis定义的一个I/O类
[*]syncio.c 用于同步Socket和文件I/O操作
整个Redis的源码分类大体上如上所述了,接下来就按照既定的几个阶段一一去分析Redis这款如此优秀的源代码吧!
又给自己制定了一个艰巨的计划,希望自己能像之前一样坚持下去,一点一点去分析,相信最后会收获很多!
推荐阅读:

口试十余家大厂,因Redis答得好都让我明天入职!
这份阿里逆天的Redis手册,于内卷中首次亮相了
页: [1]
查看完整版本: 怎样使用空闲时间高效深入地阅读Redis的源码?