如何閱讀開源項(xiàng)目代碼

經(jīng)常有小伙伴私信問我怎么閱讀開源項(xiàng)目代碼，許多人不知道從何處入手，沒有方向感，就像學(xué)習(xí)一門語言總先要有個學(xué)習(xí)路線一樣。這其實(shí)不是三兩句話能說明白的，所以就有了這篇文章。

相信每個人都有一套自己的策略，這里整理了下我平時閱讀項(xiàng)目代碼的六大步，希望可以對大家有所幫助。

粗略看官方文檔，明確項(xiàng)目都有什么主要功能，以及如何運(yùn)行項(xiàng)目；

找到項(xiàng)目的入口，把項(xiàng)目運(yùn)行起來；

找到主要功能對應(yīng)的代碼。挑一個主要功能進(jìn)行調(diào)試，比如一個美妝項(xiàng)目，那可以挑一個口紅顏色強(qiáng)度的功能進(jìn)行調(diào)試，找到該功能的觸發(fā)函數(shù)，再往深處找到功能的具體實(shí)現(xiàn)，嘗試著修改部分代碼，比如打印一些log，并嘗試著為項(xiàng)目添加一些注釋；

再多挑幾個功能調(diào)試，多嘗試著了解這幾個功能具體是怎么實(shí)現(xiàn)的，嘗試著畫出功能的整個調(diào)用流程圖；

以點(diǎn)帶面，通過幾個功能調(diào)試的練習(xí)，進(jìn)一步理解整個項(xiàng)目的架構(gòu)，這里可以更多的配合文檔食用（這里首選官方文檔，也可以看下網(wǎng)上有沒有其他的源碼分析文章，站在巨人的肩膀上往往事半功倍），嘗試著畫出整個項(xiàng)目的架構(gòu)圖；

如果有必要，從功能入手，主要的功能點(diǎn)都深入到源碼層面進(jìn)行分析（可以根據(jù)實(shí)際情況選擇是否深入細(xì)節(jié)，比如你只想要了解項(xiàng)目的整體架構(gòu)，或者想了解某個問題的解決方案。其實(shí)大多數(shù)時候我們可能都沒必要過多的深入細(xì)節(jié)通讀源碼，比如代碼里有個紅黑樹，我們根本沒必要深入研究，這顯然不是我們真正想要關(guān)注的點(diǎn)。）；

注意：千萬不要一上來就死扣細(xì)節(jié)

? ? ? ? ? 那樣你會被折磨的很慘

閱讀分析代碼一定要有合適的工具，需要方便全局搜索，方便前進(jìn)和后退、高亮等基礎(chǔ)且常用的功能，我常用的是VS Code和Clion，聽說Source Insight也不錯，我看見很多人都在用，大家可以根據(jù)自己喜好選擇合適的工具。

實(shí)戰(zhàn)環(huán)節(jié)：這里嘗試按照上述思路來分析下glog的源碼實(shí)現(xiàn)。

第一步：看文檔（https://github.com/google/glog），了解glog都有什么功能。額，log庫的功能很明確，就是按照一定格式打印log。

第二步：把項(xiàng)目運(yùn)行起來。glog的編譯鏈接很簡單，文檔里面有詳細(xì)的操作步驟。

第三步：找到主要功能對應(yīng)的代碼。挑一個主要功能進(jìn)行調(diào)試。正常glog打log的方式是LOG(LEVEL) << xxx;，輸出的log有一定格式，時間-線程ID-信息等，那能否嘗試著通過修改源碼的方式改變輸出的log格式呢。

第四步：再挑幾個主要功能分析調(diào)試，比如glog如何實(shí)現(xiàn)的log寫文件功能，如何做到的線程安全？

第五步：分析了這么多功能，對整體代碼會有一個大體的認(rèn)知，再結(jié)合其他的源碼分析文章去分析glog項(xiàng)目整體結(jié)構(gòu)，嘗試著畫出項(xiàng)目整體架構(gòu)圖。

第六步：如果自己對某個細(xì)節(jié)感興趣，嘗試深入細(xì)節(jié)，比如我很好奇log在寫文件的過程中是如何刷新到磁盤中，是什么時候?qū)?shù)據(jù)刷新到磁盤中的？

好久之前我就寫過一篇glog的源碼分析文章《C 中g(shù)log源碼剖析以及如何設(shè)計一個高效 log模塊》，大家可以作為參考看看，當(dāng)年還很青澀，相信大家可以做的更好，快去實(shí)戰(zhàn)吧！

打完收工。

往期推薦

會吹牛逼真的很重要

一個內(nèi)核漏洞詳解：容器逃逸

C 并行編程中的“鎖”難題

關(guān)于堆棧的講解(我見過的最經(jīng)典的)

【程序員必讀】經(jīng)驗(yàn)：編程的智慧

寫出高效代碼的12條建議

高端 | 如何快速定位程序Core？

推薦幾個開源庫