如何閱讀開(kāi)源項(xiàng)目代碼
[導(dǎo)讀]經(jīng)常有小伙伴私信問(wèn)我怎么閱讀開(kāi)源項(xiàng)目代碼，許多人不知道從何處入手，沒(méi)有方向感，就像學(xué)習(xí)一門(mén)語(yǔ)言總先要有個(gè)學(xué)習(xí)路線(xiàn)一樣。這其實(shí)不是三兩句話(huà)能說(shuō)明白的，所以就有了這篇文章。相信每個(gè)人都有一套自己的策略，這里整理了下我平時(shí)閱讀項(xiàng)目代碼的六大步，希望可以對(duì)大家有所幫助。粗略看官方文檔，明...
經(jīng)常有小伙伴私信問(wèn)我怎么閱讀開(kāi)源項(xiàng)目代碼，許多人不知道從何處入手，沒(méi)有方向感，就像學(xué)習(xí)一門(mén)語(yǔ)言總先要有個(gè)學(xué)習(xí)路線(xiàn)一樣。這其實(shí)不是三兩句話(huà)能說(shuō)明白的，所以就有了這篇文章。相信每個(gè)人都有一套自己的策略，這里整理了下我平時(shí)閱讀項(xiàng)目代碼的六大步，希望可以對(duì)大家有所幫助。
粗略看官方文檔，明確項(xiàng)目都有什么主要功能，以及如何運(yùn)行項(xiàng)目；
找到項(xiàng)目的入口，把項(xiàng)目運(yùn)行起來(lái)；
找到主要功能對(duì)應(yīng)的代碼。挑一個(gè)主要功能進(jìn)行調(diào)試，比如一個(gè)美妝項(xiàng)目，那可以挑一個(gè)口紅顏色強(qiáng)度的功能進(jìn)行調(diào)試，找到該功能的觸發(fā)函數(shù)，再往深處找到功能的具體實(shí)現(xiàn)，嘗試著修改部分代碼，比如打印一些log，并嘗試著為項(xiàng)目添加一些注釋?zhuān)?/p>
再多挑幾個(gè)功能調(diào)試，多嘗試著了解這幾個(gè)功能具體是怎么實(shí)現(xiàn)的，嘗試著畫(huà)出功能的整個(gè)調(diào)用流程圖；
以點(diǎn)帶面，通過(guò)幾個(gè)功能調(diào)試的練習(xí)，進(jìn)一步理解整個(gè)項(xiàng)目的架構(gòu)，這里可以更多的配合文檔食用（這里首選官方文檔，也可以看下網(wǎng)上有沒(méi)有其他的源碼分析文章，站在巨人的肩膀上往往事半功倍），嘗試著畫(huà)出整個(gè)項(xiàng)目的架構(gòu)圖；
如果有必要，從功能入手，主要的功能點(diǎn)都深入到源碼層面進(jìn)行分析（可以根據(jù)實(shí)際情況選擇是否深入細(xì)節(jié)，比如你只想要了解項(xiàng)目的整體架構(gòu)，或者想了解某個(gè)問(wèn)題的解決方案。其實(shí)大多數(shù)時(shí)候我們可能都沒(méi)必要過(guò)多的深入細(xì)節(jié)通讀源碼，比如代碼里有個(gè)紅黑樹(shù)，我們根本沒(méi)必要深入研究，這顯然不是我們真正想要關(guān)注的點(diǎn)。）；
注意：千萬(wàn)不要一上來(lái)就死扣細(xì)節(jié)? ? ? ? ? 那樣你會(huì)被折磨的很慘
閱讀分析代碼一定要有合適的工具，需要方便全局搜索，方便前進(jìn)和后退、高亮等基礎(chǔ)且常用的功能，我常用的是VS Code和Clion，聽(tīng)說(shuō)Source Insight也不錯(cuò)，我看見(jiàn)很多人都在用，大家可以根據(jù)自己喜好選擇合適的工具。
實(shí)戰(zhàn)環(huán)節(jié)：這里嘗試按照上述思路來(lái)分析下glog的源碼實(shí)現(xiàn)。
第一步：看文檔（https://github.com/google/glog），了解glog都有什么功能。額，log庫(kù)的功能很明確，就是按照一定格式打印log。
第二步：把項(xiàng)目運(yùn)行起來(lái)。glog的編譯鏈接很簡(jiǎn)單，文檔里面有詳細(xì)的操作步驟。
第三步：找到主要功能對(duì)應(yīng)的代碼。挑一個(gè)主要功能進(jìn)行調(diào)試。正常glog打log的方式是LOG(LEVEL) << xxx;，輸出的log有一定格式，時(shí)間-線(xiàn)程ID-信息等，那能否嘗試著通過(guò)修改源碼的方式改變輸出的log格式呢。
第四步：再挑幾個(gè)主要功能分析調(diào)試，比如glog如何實(shí)現(xiàn)的log寫(xiě)文件功能，如何做到的線(xiàn)程安全？
第五步：分析了這么多功能，對(duì)整體代碼會(huì)有一個(gè)大體的認(rèn)知，再結(jié)合其他的源碼分析文章去分析glog項(xiàng)目整體結(jié)構(gòu)，嘗試著畫(huà)出項(xiàng)目整體架構(gòu)圖。
第六步：如果自己對(duì)某個(gè)細(xì)節(jié)感興趣，嘗試深入細(xì)節(jié)，比如我很好奇log在寫(xiě)文件的過(guò)程中是如何刷新到磁盤(pán)中，是什么時(shí)候?qū)?shù)據(jù)刷新到磁盤(pán)中的？
好久之前我就寫(xiě)過(guò)一篇glog的源碼分析文章《C 中g(shù)log源碼剖析以及如何設(shè)計(jì)一個(gè)高效 log模塊》，大家可以作為參考看看，當(dāng)年還很青澀，相信大家可以做的更好，快去實(shí)戰(zhàn)吧！打完收工。
往期推薦
會(huì)吹牛逼真的很重要一個(gè)內(nèi)核漏洞詳解：容器逃逸C 并行編程中的“鎖”難題關(guān)于堆棧的講解(我見(jiàn)過(guò)的最經(jīng)典的)【程序員必讀】經(jīng)驗(yàn)：編程的智慧寫(xiě)出高效代碼的12條建議高端 | 如何快速定位程序Core？推薦幾個(gè)開(kāi)源庫(kù)
粗略看官方文檔，明確項(xiàng)目都有什么主要功能，以及如何運(yùn)行項(xiàng)目；
找到項(xiàng)目的入口，把項(xiàng)目運(yùn)行起來(lái)；
找到主要功能對(duì)應(yīng)的代碼。挑一個(gè)主要功能進(jìn)行調(diào)試，比如一個(gè)美妝項(xiàng)目，那可以挑一個(gè)口紅顏色強(qiáng)度的功能進(jìn)行調(diào)試，找到該功能的觸發(fā)函數(shù)，再往深處找到功能的具體實(shí)現(xiàn)，嘗試著修改部分代碼，比如打印一些log，并嘗試著為項(xiàng)目添加一些注釋?zhuān)?/p>
再多挑幾個(gè)功能調(diào)試，多嘗試著了解這幾個(gè)功能具體是怎么實(shí)現(xiàn)的，嘗試著畫(huà)出功能的整個(gè)調(diào)用流程圖；
以點(diǎn)帶面，通過(guò)幾個(gè)功能調(diào)試的練習(xí)，進(jìn)一步理解整個(gè)項(xiàng)目的架構(gòu)，這里可以更多的配合文檔食用（這里首選官方文檔，也可以看下網(wǎng)上有沒(méi)有其他的源碼分析文章，站在巨人的肩膀上往往事半功倍），嘗試著畫(huà)出整個(gè)項(xiàng)目的架構(gòu)圖；
如果有必要，從功能入手，主要的功能點(diǎn)都深入到源碼層面進(jìn)行分析（可以根據(jù)實(shí)際情況選擇是否深入細(xì)節(jié)，比如你只想要了解項(xiàng)目的整體架構(gòu)，或者想了解某個(gè)問(wèn)題的解決方案。其實(shí)大多數(shù)時(shí)候我們可能都沒(méi)必要過(guò)多的深入細(xì)節(jié)通讀源碼，比如代碼里有個(gè)紅黑樹(shù)，我們根本沒(méi)必要深入研究，這顯然不是我們真正想要關(guān)注的點(diǎn)。）；
注意：千萬(wàn)不要一上來(lái)就死扣細(xì)節(jié)? ? ? ? ? 那樣你會(huì)被折磨的很慘
閱讀分析代碼一定要有合適的工具，需要方便全局搜索，方便前進(jìn)和后退、高亮等基礎(chǔ)且常用的功能，我常用的是VS Code和Clion，聽(tīng)說(shuō)Source Insight也不錯(cuò)，我看見(jiàn)很多人都在用，大家可以根據(jù)自己喜好選擇合適的工具。
實(shí)戰(zhàn)環(huán)節(jié)：這里嘗試按照上述思路來(lái)分析下glog的源碼實(shí)現(xiàn)。
第一步：看文檔（https://github.com/google/glog），了解glog都有什么功能。額，log庫(kù)的功能很明確，就是按照一定格式打印log。
第二步：把項(xiàng)目運(yùn)行起來(lái)。glog的編譯鏈接很簡(jiǎn)單，文檔里面有詳細(xì)的操作步驟。
第三步：找到主要功能對(duì)應(yīng)的代碼。挑一個(gè)主要功能進(jìn)行調(diào)試。正常glog打log的方式是LOG(LEVEL) << xxx;，輸出的log有一定格式，時(shí)間-線(xiàn)程ID-信息等，那能否嘗試著通過(guò)修改源碼的方式改變輸出的log格式呢。
第四步：再挑幾個(gè)主要功能分析調(diào)試，比如glog如何實(shí)現(xiàn)的log寫(xiě)文件功能，如何做到的線(xiàn)程安全？
第五步：分析了這么多功能，對(duì)整體代碼會(huì)有一個(gè)大體的認(rèn)知，再結(jié)合其他的源碼分析文章去分析glog項(xiàng)目整體結(jié)構(gòu)，嘗試著畫(huà)出項(xiàng)目整體架構(gòu)圖。
第六步：如果自己對(duì)某個(gè)細(xì)節(jié)感興趣，嘗試深入細(xì)節(jié)，比如我很好奇log在寫(xiě)文件的過(guò)程中是如何刷新到磁盤(pán)中，是什么時(shí)候?qū)?shù)據(jù)刷新到磁盤(pán)中的？
好久之前我就寫(xiě)過(guò)一篇glog的源碼分析文章《C 中g(shù)log源碼剖析以及如何設(shè)計(jì)一個(gè)高效 log模塊》，大家可以作為參考看看，當(dāng)年還很青澀，相信大家可以做的更好，快去實(shí)戰(zhàn)吧！打完收工。
往期推薦
會(huì)吹牛逼真的很重要一個(gè)內(nèi)核漏洞詳解：容器逃逸C 并行編程中的“鎖”難題關(guān)于堆棧的講解(我見(jiàn)過(guò)的最經(jīng)典的)【程序員必讀】經(jīng)驗(yàn)：編程的智慧寫(xiě)出高效代碼的12條建議高端 | 如何快速定位程序Core？推薦幾個(gè)開(kāi)源庫(kù)
下載文檔
