經(jīng)常有小伙伴私信問我怎么閱讀開源項目代碼,許多人不知道從何處入手,沒有方向感,就像學習一門語言總先要有個學習路線一樣。這其實不是三兩句話能說明白的,所以就有了這篇文章。
相信每個人都有一套自己的策略,這里整理了下我平時閱讀項目代碼的六大步,希望可以對大家有所幫助。
粗略看官方文檔,明確項目都有什么主要功能,以及如何運行項目;
找到項目的入口,把項目運行起來;
找到主要功能對應的代碼。挑一個主要功能進行調試,比如一個美妝項目,那可以挑一個口紅顏色強度的功能進行調試,找到該功能的觸發(fā)函數(shù),再往深處找到功能的具體實現(xiàn),嘗試著修改部分代碼,比如打印一些log,并嘗試著為項目添加一些注釋;
再多挑幾個功能調試,多嘗試著了解這幾個功能具體是怎么實現(xiàn)的,嘗試著畫出功能的整個調用流程圖;
以點帶面,通過幾個功能調試的練習,進一步理解整個項目的架構,這里可以更多的配合文檔食用(這里首選官方文檔,也可以看下網(wǎng)上有沒有其他的源碼分析文章,站在巨人的肩膀上往往事半功倍),嘗試著畫出整個項目的架構圖;
如果有必要,從功能入手,主要的功能點都深入到源碼層面進行分析(可以根據(jù)實際情況選擇是否深入細節(jié),比如你只想要了解項目的整體架構,或者想了解某個問題的解決方案。其實大多數(shù)時候我們可能都沒必要過多的深入細節(jié)通讀源碼,比如代碼里有個紅黑樹,我們根本沒必要深入研究,這顯然不是我們真正想要關注的點。);
閱讀分析代碼一定要有合適的工具,需要方便全局搜索,方便前進和后退、高亮等基礎且常用的功能,我常用的是VS Code和Clion,聽說Source Insight也不錯,我看見很多人都在用,大家可以根據(jù)自己喜好選擇合適的工具。
實戰(zhàn)環(huán)節(jié):這里嘗試按照上述思路來分析下glog的源碼實現(xiàn)。
第一步:看文檔(https://github.com/google/glog),了解glog都有什么功能。額,log庫的功能很明確,就是按照一定格式打印log。
第二步:把項目運行起來。glog的編譯鏈接很簡單,文檔里面有詳細的操作步驟。
第三步:找到主要功能對應的代碼。挑一個主要功能進行調試。正常glog打log的方式是LOG(LEVEL) << xxx;,輸出的log有一定格式,時間-線程ID-信息等,那能否嘗試著通過修改源碼的方式改變輸出的log格式呢。
第四步:再挑幾個主要功能分析調試,比如glog如何實現(xiàn)的log寫文件功能,如何做到的線程安全?
第五步:分析了這么多功能,對整體代碼會有一個大體的認知,再結合其他的源碼分析文章去分析glog項目整體結構,嘗試著畫出項目整體架構圖。
第六步:如果自己對某個細節(jié)感興趣,嘗試深入細節(jié),比如我很好奇log在寫文件的過程中是如何刷新到磁盤中,是什么時候將數(shù)據(jù)刷新到磁盤中的?
好久之前我就寫過一篇glog的源碼分析文章《C++中glog源碼剖析以及如何設計一個高效 log模塊》,大家可以作為參考看看,當年還很青澀,相信大家可以做的更好,快去實戰(zhàn)吧!
打完收工。
往期推薦