為什么要讀源代碼，如何閱讀源代碼

來源：33h.co/eCv5

由于項目的需求，最近花了較多的時間來看開源項目的代碼，在本文中，簡單總結(jié)一下對為什么要看源碼、如何看源碼這兩個問題的思考。

看源碼只是一種方法、手段，而不是目的。我也曾經(jīng)給自己制定過“閱讀xxx源碼”的目標(biāo)，現(xiàn)在看起來真的很蠢，一點不smart（specific、measurable、attainable、relevant、time-bound）。

只有搞清楚了閱讀代碼的目標(biāo)，才能有的放矢，抓住重點，高效達(dá)成任務(wù)。

看源碼的意義總結(jié)起來包含但不限于以下幾點：

只要是代碼，就會有bug，只是說bug的多與少、深與淺罷了。

現(xiàn)在大家都喜歡發(fā)布、使用開源項目，不同的開源項目社區(qū)成熟度、代碼質(zhì)量又會有較大的差異，遇到bug就不足為奇了。

當(dāng)然，遇到bug肯定是先在網(wǎng)上搜索是否有類似的問題，一般可以在google、Stack Overflow、項目的issues里面有對應(yīng)的關(guān)鍵詞搜索。如果搜不到，那么就只能看源碼解決了。

我在如何學(xué)習(xí)新技術(shù)、團(tuán)隊技術(shù)選型時要注意些什么里面提到過，如果我們需要將一個開源項目用到自己的項目中，那么就必須了解這項項目的優(yōu)缺點，并深知原理，對部分細(xì)節(jié)（尤其是項目的優(yōu)勢、feature）進(jìn)行深入研究。

如果是成熟的開源項目，遇到問題也許能google到很多答案；但如果是一個處于快速發(fā)展中的開源項目，多了解其架構(gòu)、核心原理，也能幫助快速定位問題。

另外，有的項目文檔可能不那么豐富，但又不得不使用，那么如何以正確的姿勢使用呢？也得參考源碼。

看源碼也是一種不錯的學(xué)習(xí)方式（雖然不一定不是最佳的方式），尤其對于比較優(yōu)秀的開源項目，能讓人大開眼界。

即使是出于學(xué)習(xí)的目的，也是有很多側(cè)重的，比如

• 學(xué)習(xí)語言：代碼風(fēng)格、規(guī)范、慣用法、高級語法。對于某個語言的新手，找一個熟悉領(lǐng)域的開源項目來深入掌握這門語言，也是一個不錯的注意。

• 學(xué)習(xí)設(shè)計：數(shù)據(jù)接口、框架、整體架構(gòu)

• 學(xué)習(xí)理論：算法、協(xié)議。比如我之前寫過的raft協(xié)議，光看論文是很枯燥的，而且算法理論到工程實踐還是有一定的差距，這個時候結(jié)合開源項目(mongodb)實現(xiàn)往往更事半功倍。

• 其他

一般來說，我們剛開始僅僅是使用一個開源項目，但隨著使用的深入，會發(fā)現(xiàn)一些自己需要的功能并沒有很好的支持，向項目組提的issues也可能得不到快速的響應(yīng)。

這個時候就要自己開分支，改代碼，加功能了。當(dāng)然，比較好的是將自己分支比較好的新feature 給原項目提merge request，反哺開源項目，比如阿里的Blink。

他山之石可以攻玉，如果有需要重新開始自己造輪子，那么參考一些已有的、優(yōu)秀的輪子肯定是有好處的。

如何看源碼

看源碼的目的很大程度上影響了看源碼的方式、需要閱讀的代碼的范圍。

比如說，如果是為了修一個線上bug，那么閱讀代碼的范圍就緊緊圍繞bug本身；而如果是為了了解某個分布式算法，那就需要按大量的、可能運(yùn)行在不同節(jié)點（進(jìn)程）上的代碼，了解其交互原理、工作流程。

下面說一些通用的方法。

一般來說，文檔是對代碼的高度凝練，一個高質(zhì)量的開源一般會包含tutorial、specification、API reference等documents，通過選擇性的略讀、精讀這些文檔，就能大致了解項目的整體架構(gòu)、設(shè)計原則。

正確的路線是通過文檔去認(rèn)識這個項目，然乎通過閱讀代碼去驗證文檔、深入細(xì)節(jié)，而不是通過直接啃源碼來了解這個項目，以偏概全。

當(dāng)需要看代碼的時候，不要找到一個文件就開始，先看看代碼組織，粗略看看文件名、類名，基本就能猜測到每一部分。

比如redis的源碼就組織得很好，基本上看文件名就可以快速定位每一個command的實現(xiàn)位置。

看源碼的目標(biāo)決定了此時此刻的關(guān)注點，不管是解決遇到的bug還是學(xué)習(xí)某個算法，都讓我們聚焦到一個具體的問題，從這個具體的問題去追蹤代碼，忽略掉當(dāng)前無需關(guān)注的細(xì)枝末節(jié)，步步深入，直達(dá)目標(biāo)。

當(dāng)然在解決一個問題的時候，有可能會引發(fā)新的問題，尤其是學(xué)習(xí)的時候，此時只需記錄新問題（放到收集籃，不要立即發(fā)散），待之前追蹤的問題解決之后，再來看新發(fā)現(xiàn)的問題。

如果自己沒有問題，那么就幫忙解決別人的問題，通常來說，開源項目都有許多待解決的issue，從中選擇一個入手即可。

只要可以，一定先讓代碼編譯通過、跑起來，這樣不管是加log、打印調(diào)用棧還是斷點調(diào)試都方便很多。

尤其是對于像python這種動態(tài)類型代碼，不跑起來很難知道到底在干啥。

如果某份源代碼的閱讀并不是一錘子買賣，日后還可能回顧、重新閱讀，那么就一定要做好代碼注釋和筆記。

筆記主要是框架圖、類圖、流程圖，目標(biāo)是建立索引，方便日后快速回憶。而注釋就是閱讀代碼時的細(xì)節(jié)，重新閱讀的時候看注釋（特別是函數(shù)的注釋）能節(jié)省很多時間。

以上，僅僅是一些個人總結(jié)，還請多多指教！