我們怎樣讀源碼才能更高效

用了這么久的 Redis，也翻了很多次源碼，經(jīng)常有人問我到底怎么讀 Redis 源碼。

一提到讀源碼，很多人都會比較畏懼，認(rèn)為讀源碼是高手才會做的事情。他們可能遇到問題時，會更傾向于去找別人分享的答案。但往往很多時候，自己查到的資料并不能解決所有問題，尤其是比較細(xì)節(jié)的問題。

從我的實(shí)戰(zhàn)經(jīng)驗(yàn)來看，遇到這種情況，通常就需要去源碼中尋找答案了，因?yàn)樵谠创a面前，這些細(xì)節(jié)會變得「一覽無余」。

而且我認(rèn)為，掌握讀源碼的能力，是從只懂得如何使用 Redis，到精通 Redis 實(shí)現(xiàn)原理的成長之路上，必須跨越的門檻。

可是，面對龐大復(fù)雜的項(xiàng)目，我們怎樣讀源碼才能更高效呢？

這篇文章我就來和你聊一聊，我讀 Redis 源碼的經(jīng)驗(yàn)，以及讀源碼的「通用思路」，希望這些心得可以幫助到你。

01 找到地圖

很多開源項(xiàng)目的源碼，代碼量一般都比較龐大，如果在讀代碼之前，我們沒有制定合理的方法，就一頭扎進(jìn)去讀代碼，勢必會把自己搞暈。

所以，我在拿到一個項(xiàng)目的代碼之后，并不會馬上著手去讀，而是會先對整個項(xiàng)目結(jié)構(gòu)進(jìn)行梳理，劃分出項(xiàng)目具體包含的模塊。這樣，我就對整個項(xiàng)目有了一個「宏觀」的了解。

讀代碼就好比去一個陌生城市旅行，這個旅途過程充滿著未知。如果在出發(fā)之前，我們手里能有一張地圖，那我們對自己的行程就可以有一個非常清晰的規(guī)劃。

我們就知道，如果想要到達(dá)目的地，需要從哪里出發(fā)、經(jīng)過哪些地方、通過什么方式才能到達(dá)，有了地圖就有了行進(jìn)方向，否則很容易迷失。

因此，提前花一些時間梳理整個項(xiàng)目的「結(jié)構(gòu)和目錄」，對于后面更好地閱讀代碼是非常有必要的。

就拿 Redis 來舉例，在讀 Redis 源碼之前，我們可以先梳理出整個項(xiàng)目的功能模塊，以及每個模塊對應(yīng)的代碼文件（src 下的代碼結(jié)構(gòu)）：

這樣，有了這張地圖之后，我們再去看代碼的時候，就可以有重點(diǎn)地閱讀了。

02 前置知識準(zhǔn)備

在梳理完整個項(xiàng)目結(jié)構(gòu)之后，我們就可以正式進(jìn)入閱讀環(huán)節(jié)當(dāng)中了。不過，在閱讀代碼之前，我們其實(shí)還需要預(yù)先掌握一些「前置知識」。

因?yàn)橐粋€完整的項(xiàng)目，必然綜合了各個領(lǐng)域的技術(shù)知識點(diǎn)，比如數(shù)據(jù)結(jié)構(gòu)、操作系統(tǒng)、網(wǎng)絡(luò)協(xié)議、編程語言等，如果我們提前做好一些功課，在讀源碼的過程中就會輕松很多。

以下是根據(jù)我在閱讀 Redis 書籍和實(shí)戰(zhàn)過程中，提取的讀源碼必備前置知識點(diǎn)，你可以參考下：

常用數(shù)據(jù)結(jié)構(gòu)：數(shù)組、鏈表、哈希表、跳表

網(wǎng)絡(luò)協(xié)議：TCP 協(xié)議

網(wǎng)絡(luò) IO 模型：IO 多路復(fù)用、非阻塞 IO、Reactor 網(wǎng)絡(luò)模型

操作系統(tǒng)：寫時復(fù)制（Copy On Write）、常見系統(tǒng)調(diào)用、磁盤 IO 機(jī)制

C 語言基礎(chǔ)：循環(huán)、分支、結(jié)構(gòu)體、指針

當(dāng)然，在閱讀源碼的過程中，我們也可以根據(jù)實(shí)際問題再去查閱相關(guān)資料，但不管怎樣，提前熟悉這些方面的知識，在真正讀代碼時就會省下不少時間。

03 從基礎(chǔ)模塊開始讀

好，有了地圖并掌握了前置知識之后，接下來我們就要進(jìn)入主題了：讀代碼。

但具體要從哪個地方開始讀起呢？我認(rèn)為要先從「最基礎(chǔ)」的模塊開始讀起。

我在前面也分析了，一個完整的項(xiàng)目會劃分很多的功能模塊，但這些模塊并不是孤立的，而很可能是有「依賴」關(guān)系的。

比如說，Redis 中的 networking.c 文件，表示處理網(wǎng)絡(luò) IO 的具體實(shí)現(xiàn)。而如果我們能在理解事件驅(qū)動模塊 ae.c 的基礎(chǔ)上，再去閱讀網(wǎng)絡(luò) IO 模塊，效率就會更高。

那在 Redis 源碼中，哪些是最基礎(chǔ)的模塊呢？

想一下，我們在使用 Redis 時，接觸最頻繁的是哪些功能？

答案是各種數(shù)據(jù)類型。

一切操作的基礎(chǔ)，其實(shí)都是基于這些最常用的數(shù)據(jù)類型來做的，比如 String、List、Hash、Set、Sorted Set等。所以，我們就可以從這些基礎(chǔ)模塊開始讀起，也就是從 t_string.c、t_list.c、t_hash.c、t_set.c、t_zset.c 代碼入手。

如果你對 Redis 的數(shù)據(jù)類型有所了解，就會看到這些數(shù)據(jù)類型在實(shí)現(xiàn)時，底層都對應(yīng)了不同的數(shù)據(jù)結(jié)構(gòu)。比如，String 的底層是 SDS，List 的底層是 ziplist + quicklist，Hash 底層可能是ziplist，也可能是哈希表，等等。

由此一來，我們會發(fā)現(xiàn)，這些數(shù)據(jù)結(jié)構(gòu)又是更為「底層」的模塊，所以我們在閱讀數(shù)據(jù)類型模塊時，就需要重點(diǎn)聚焦在這些模塊上，也就是 sds.c、ziplist.c、quicklist.c、dict.c、intset.c 文件，而且這些文件都是比較獨(dú)立的，閱讀起來就可以更加集中。

這樣，當(dāng)我們真正掌握了這些「底層數(shù)據(jù)結(jié)構(gòu)」的實(shí)現(xiàn)后，就能更好地理解基于它們實(shí)現(xiàn)的各種「數(shù)據(jù)類型」了。

這些基礎(chǔ)模塊就相當(dāng)于一座大廈的地基，地基打好了，才能做到高樓聳立。

04 找到核心主線

接著，掌握了數(shù)據(jù)結(jié)構(gòu)模塊之后，這時我們的重點(diǎn)就需要放在「核心主線」上來了。

在這個階段，我們需要找到一個明確的目標(biāo)，以這個目標(biāo)為主線去讀代碼。因?yàn)樽x源碼一個很常見的需求，就是為了了解這個項(xiàng)目最「核心功能」的實(shí)現(xiàn)細(xì)節(jié)，我們只有以此為目標(biāo)，找到這條主線去讀代碼，才能達(dá)到最終目的。

那么在讀 Redis 源碼時，什么才是它的核心主線呢？這里我分享一個非常好用的技巧，就是根據(jù)「Redis 究竟是怎么處理客戶端發(fā)來的命令的？」 為主線來梳理。

舉個例子，當(dāng)我們在執(zhí)行 SET testkey testval EX 60 這樣一條命令時，就需要搞清楚 Redis 是怎么執(zhí)行這條命令的。

也就是要明確，Redis 從收到客戶端請求，到把數(shù)據(jù)存到 Redis 中、設(shè)置過期時間，最后把響應(yīng)結(jié)果返回給客戶端，整個過程的每一個環(huán)節(jié)，到底是如何處理的。

有了這條主線，我們就有了非常明確的目標(biāo)，而且沿著這條主線去讀代碼，我們還可以很清晰地把多個模塊「串聯(lián)」起來。比如從前面的例子中，我們會看到一條命令的執(zhí)行，主要包含了這樣幾個階段。

Redis Server 初始化：加載配置、監(jiān)聽端口、注冊連接建立事件、啟動事件循環(huán)（server.c、anet.c）。

接收、解析客戶端請求：初始化 client、注冊讀事件、讀客戶端 socket（networking.c）。

處理具體的命令：找到對應(yīng)的命令函數(shù)、執(zhí)行命令（server.c、t_string.c、t_list.c、t_hash.c、t_set.c、t_zset.c）。

返回響應(yīng)給客戶端：寫客戶端緩沖區(qū)、注冊寫事件、寫客戶端 socket（networking.c）。

沿著這條主線去讀代碼，我們就可以掌握一條命令的執(zhí)行全過程。

而且，由于這條主線的代碼邏輯，已經(jīng)覆蓋了「所有命令」的執(zhí)行流程，我們下次再去讀其它命令時，比如 SADD，就只需要關(guān)注「處理命令」部分的邏輯即可，其它邏輯有 80% 都是相同的。

05 先整體后細(xì)節(jié)

當(dāng)然，在閱讀主線代碼的過程中，肯定也會遇到過于「復(fù)雜」的函數(shù)，第一次在讀這種函數(shù)時，很容易就會「陷進(jìn)去」，導(dǎo)致整個主線代碼的閱讀，無法繼續(xù)推進(jìn)下去。

遇到這種情況其實(shí)是很正常的，可這時我們應(yīng)該怎么辦呢？

這里我的做法是，前期讀到這種邏輯時，不要馬上陷入到細(xì)節(jié)中去，而是要先「抓整體」。

具體來說，對于復(fù)雜的函數(shù)邏輯，我們剛開始并不需要知道它的每一個細(xì)節(jié)是如何實(shí)現(xiàn)的，而是只需知道這個函數(shù)「大致」做了幾件事情即可。

舉個例子，在執(zhí)行 HSET 命令時，有一段代碼很復(fù)雜，其中包括了很多分支判斷，一次很難讀懂：

那么，我在讀這段代碼時，就可以先簡化邏輯，把握整體思路：

之后，再了解每個分支大致做了哪些事情：

這樣做的好處，一是不會被復(fù)雜的細(xì)節(jié)邏輯搞暈，打擊自己的自信心，二是可以有效避免閱讀的連貫性被打斷，從而能持續(xù)推進(jìn)我們把整個主線邏輯讀完。

所以，這里的重點(diǎn)就是：先把復(fù)雜代碼的主邏輯搞清楚，知道涉及的每個方法完成了什么事，心里要先搭建一個簡單的「框架」，等有了框架之后，我們再去給框架填充「細(xì)節(jié)」。

這樣通過「先整體后細(xì)節(jié)」的方式，我們就可以不再畏懼代碼中的復(fù)雜邏輯。

06 先主線后支線

不過，在閱讀主線代碼的過程中，我們肯定還會遇到各種「支線」邏輯，比如數(shù)據(jù)過期、替換淘汰、持久化、主從復(fù)制等。

其實(shí)，在閱讀主線邏輯的時候，我們并不需要去重點(diǎn)關(guān)注這些支線，而當(dāng)整個主線邏輯「清晰」起來之后，我們再去讀這些支線模塊，就會容易很多了。

這時，我們就可以從這些支線中，選取下一個「目標(biāo)」，帶著這個目標(biāo)去閱讀，比如說：

過期策略是怎么實(shí)現(xiàn)的？（expire.c、lazyfree.c）

淘汰策略是如何實(shí)現(xiàn)的？（evict.c）

持久化 RDB、AOF 是怎么做的？（rdb.c、aof.c）

主從復(fù)制是怎么做的？（replication.c）

哨兵如何完成故障自動切換？（sentinel.c）

分片邏輯如何實(shí)現(xiàn)？（cluster.c）

。..

有了新的支線目標(biāo)后，我們依舊可以采用前面提到的「先整體后細(xì)節(jié)」的思路閱讀相關(guān)模塊，這樣下來，整個項(xiàng)目的每個模塊，就可以被「逐一擊破」了。

07 查漏補(bǔ)缺

最后，我們還需要「查漏補(bǔ)缺」。

按照前面提到的方法，基本就可以把整個項(xiàng)目的主要模塊讀得七七八八了，這時我們基本已經(jīng)對整個項(xiàng)目有了整體的「把控」。

不過，當(dāng)我們在工作中遇到問題時，很有可能會發(fā)現(xiàn)，在當(dāng)時讀代碼的過程中，有很多并不在意的「細(xì)節(jié)」被忽略了。

所以這時，我們就可以再帶著「具體問題」出發(fā)，聚焦這個問題相關(guān)的模塊，再一次去讀源碼。這樣一來，我們就可以填補(bǔ)當(dāng)時閱讀源碼的「空白區(qū)」。

舉個例子，當(dāng)我們在閱讀 String 底層數(shù)據(jù)結(jié)構(gòu) SDS（簡單動態(tài)字符串）的實(shí)現(xiàn)時，我們會看到當(dāng) SDS 需要追加新內(nèi)容時會進(jìn)行擴(kuò)容，而我們之前閱讀這塊代碼時，很有可能只是了解到有這樣的邏輯存在，但并沒有在意擴(kuò)容的相關(guān)細(xì)節(jié)（一次擴(kuò)容多大）。

所以，當(dāng)我們在工作中遇到這個細(xì)節(jié)問題后，就可以把目光聚焦在 SDS 的擴(kuò)容邏輯上（sds.c 的sdsMakeRoomFor函數(shù)），而此時我們會發(fā)現(xiàn)，當(dāng)需要申請的新內(nèi)存小于 1MB 時，Redis 就會翻倍申請內(nèi)存，否則按 1MB 申請新內(nèi)存。

采用這個方法進(jìn)行查漏補(bǔ)缺，我們就可以對整個項(xiàng)目了解得更深入、更全面，真正把項(xiàng)目「吃透」。

總結(jié)

好了，以上就是我在閱讀 Redis 源碼時的經(jīng)驗(yàn)心得，總結(jié)一下這 7 個步驟。

1、找到地圖：拿到項(xiàng)目代碼后，提前梳理整個項(xiàng)目結(jié)構(gòu)，知曉整個項(xiàng)目的模塊劃分，以及對應(yīng)的代碼文件。

2、前置知識準(zhǔn)備：提前掌握項(xiàng)目中用到的前置知識，比如數(shù)據(jù)結(jié)構(gòu)、操作系統(tǒng)原理、網(wǎng)絡(luò)協(xié)議、網(wǎng)絡(luò) IO 模型、編程語言語法等等。

3、從基礎(chǔ)模塊開始讀：從最底層的基礎(chǔ)模塊開始入手，先掌握了這些模塊，之后基于它們構(gòu)建的模塊讀起來會更加高效。

4、找到核心主線：找到整個項(xiàng)目中最核心的主線邏輯，以此為目標(biāo)，了解各模塊為了完成這個功能，是如何協(xié)作和組織的。

5、先整體后細(xì)節(jié)：對于復(fù)雜函數(shù)，不要上來就陷入細(xì)節(jié)，前期閱讀只需了解這個函數(shù)大致做了什么事情，建立框架，等搭建起框架之后，再去填充細(xì)節(jié)。

6、先主線后支線：整個主線邏輯清晰之后，再去延伸閱讀支線邏輯，因?yàn)橹Ь€邏輯肯定是服務(wù)主線邏輯的，讀完主線后再去讀這些支線，也會變得更簡單。

7、查漏補(bǔ)缺：在工作中遇到具體問題，帶著這些實(shí)際的問題出發(fā)再次去讀源碼，進(jìn)行查漏補(bǔ)缺，填補(bǔ)之前讀源碼時沒有注意到的地方。

后記

你可以看到，這篇文章介紹的閱讀源碼的方法，其實(shí)并不局限于讀 Redis 代碼。

這 7 個步驟，可以算是一個的「通用思路」，我也經(jīng)常用這個思路來讀其它項(xiàng)目的源碼，非常有用，你也可以試試。

另外，我認(rèn)為很多人讀源碼覺得難，一是因?yàn)樾睦砩献哉J(rèn)為自己讀不懂，不敢邁步這一步，二是因?yàn)檎也坏胶侠淼姆椒?，在讀源碼時屢次受挫，最終知難而退。

我在讀源碼時也經(jīng)歷過這些，這里再分享一下我的經(jīng)驗(yàn)。

1、永遠(yuǎn)不要給自己設(shè)限：想想看，曾經(jīng)以為很多自己做不到的事，在有壓力的情況下，是不是慢慢都做到了，而且發(fā)現(xiàn)做得還挺好？學(xué)習(xí)技術(shù)也是一樣，技術(shù)是死的，東西就那么多，一遍不行來兩遍，總有一次能搞懂，所以心態(tài)上一定不要先「否定」自己，凡事先邁一小步進(jìn)去試試看，好的開始就是成功的一半。

2、找到對的學(xué)習(xí)方法：正所謂「學(xué)會學(xué)習(xí)，再學(xué)習(xí)」，科學(xué)高效的方法，能幫你事半功倍，這篇文章分享的方法論，就是屬于學(xué)習(xí)方法的范疇，你可以結(jié)合自己的實(shí)際情況試試看。

希望我的這些經(jīng)驗(yàn)和心得，對你有所啟發(fā)。

如果你也有自己的閱讀源碼的實(shí)踐經(jīng)驗(yàn)和方法，歡迎在留言區(qū)分享出來，我們一起交流，共同進(jìn)步~

責(zé)任編輯：haq