今年我讀了四個(gè)開源項(xiàng)目的源碼,來(lái)分享下心得
今年來(lái)看了 RocketMQ、Kafka、Dubbo 、Tomcat 的源碼,之前也有讀者詢問(wèn)過(guò)如何讀源碼,索性就來(lái)分享一下。
其實(shí)還看了一點(diǎn)點(diǎn) Linux、Redis、jdk8,這幾個(gè)閱讀的目的和上面幾個(gè)是不同的,下面會(huì)提到。
相信通過(guò)今天的分享你不會(huì)被源碼輕易勸退,其實(shí)沒(méi)什么,不就是代碼嗎?
而且你一直在看源碼,可能你沒(méi)意識(shí)到,你看別人的代碼不就是源碼?
你新入職一個(gè)公司要熟悉代碼的時(shí)候不就是看源碼?
這和你看開源框架源碼沒(méi)有本質(zhì)的區(qū)別,要真說(shuō)區(qū)別無(wú)非是代碼的質(zhì)量、整體的設(shè)計(jì)區(qū)別罷了。
那時(shí)候你怎么做的?
反正最終結(jié)果你應(yīng)該都是上手了的。
那就得了,開源框架的一樣,最終你也會(huì)上手。
所以沒(méi)啥好怕的,不要被勸退了。
我先分享一下我入職一家新公司接手項(xiàng)目的時(shí)候是怎么做的。
入職新公司接手項(xiàng)目就是在讀源碼
新入職接手項(xiàng)目的時(shí)候,我先拉上了產(chǎn)品經(jīng)理和原先這個(gè)項(xiàng)目的主力開發(fā)開了個(gè)會(huì)。
這個(gè)會(huì)的目的就是讓產(chǎn)品經(jīng)理介紹一下這個(gè)項(xiàng)目的背景、要解決什么問(wèn)題、有哪些功能。
開發(fā)在旁邊補(bǔ)充、解答我的疑惑,畢竟產(chǎn)品經(jīng)理不太了解細(xì)節(jié)上的數(shù)據(jù)交互。
這個(gè)會(huì)議下來(lái)你就能得知這個(gè)項(xiàng)目到底是干嘛的,能提供哪些功能。
業(yè)務(wù)上的理解對(duì)你之后讀源碼非常的重要!!
然后我會(huì)去要文檔、架構(gòu)圖、流程圖、時(shí)序圖等等(有多少要多少,沒(méi)的話沒(méi)辦法)。
看完之后對(duì)整個(gè)項(xiàng)目有了大致的了解。
然后讓項(xiàng)目跑起來(lái),跑起來(lái)之后,開始用這個(gè)軟件,各種功能點(diǎn)一點(diǎn),畢竟聽產(chǎn)品經(jīng)理說(shuō)和自己實(shí)際用還是有區(qū)別的。
基本上項(xiàng)目主流程都過(guò)了一遍之后,開始看源碼。
這個(gè)時(shí)候看源碼,單看文件的命名其實(shí)已經(jīng)能知道這個(gè)文件對(duì)應(yīng)著哪個(gè)模塊了,有種胸有成竹的感覺(jué)。
然后具體深入細(xì)節(jié)就看分配到的任務(wù)了,幾個(gè)需求接下來(lái)漸漸地細(xì)節(jié)就都全清楚了。
穩(wěn)了。
所以入職接手項(xiàng)目是需要了解背景、總覽全局然后再細(xì)化。
讀開源項(xiàng)目的源碼也是如此,自頂向下。
如何閱讀開源項(xiàng)目的源碼
讀源碼我個(gè)人分為兩種情況:為了提升自己和為了找問(wèn)題。
為了提升自己而讀源碼
我默認(rèn)你是知道你要看的開源項(xiàng)目是干嘛的,比如 RocketMQ 是消息隊(duì)列,消息隊(duì)列是干嘛的你應(yīng)該先知道。
我也默認(rèn)你用過(guò)這個(gè)開源項(xiàng)目,業(yè)務(wù)上沒(méi)用過(guò)自己私下也要先用用,了解簡(jiǎn)單功能怎么用,讓它先跑起來(lái)。
首先看官網(wǎng)、wiki。
我截個(gè) RocketMQ 的:
了解具體涉及到的概念、名稱、特性、架構(gòu)這是第一步。
這一步能讓你腦子里有個(gè)角色分布圖和數(shù)據(jù)流轉(zhuǎn)圖,讓你明白整體項(xiàng)目的主要角色及之間的交互。
然后看源碼目錄,你得先知道每個(gè)目錄是干嘛的涉及哪些功能,這其實(shí)和你看業(yè)務(wù)源碼一樣。
然后就是找突破口了,這種開源項(xiàng)目都有 demo ,跑,打斷點(diǎn)就完事兒了!
比如 RocketMQ 的:
比如 Dubbo 的:
這就是突破口。
然后就開始源碼之路了,是的還是得自己啃,硬啃,這是讀源碼的必經(jīng)之路!
但是這時(shí)候你不是像無(wú)頭蒼蠅一樣亂啃。
你是在知曉大體會(huì)涉及到的角色和數(shù)據(jù)流轉(zhuǎn)之后讀源碼,這很不一樣!
你會(huì)對(duì)一些方法調(diào)用有一種“認(rèn)可感”,因?yàn)槟阒獣源笾碌牧鞒蹋杂X(jué)得本該如此。
讀源碼有時(shí)候會(huì)覺(jué)得代碼很多,分支好多。
沒(méi)事,先拷貝一份,然后把一些異常處理和不常見的分支先刪了。
整體核心流程先理清楚!
并且理清楚了一個(gè)流程之后開始畫圖,流程圖、腦圖都上。
清楚之后再看沒(méi)刪減的代碼,把異常處理的一些也理解了,補(bǔ)充完整流程圖、腦圖等。
看看我之前分析 Kafka 的時(shí)候畫的圖,就類似這樣的搞清楚一個(gè)流程:
然后這一模塊就收工了!搞定!
然后各種分支發(fā)散出去,大致的流程就都清晰了,源碼也就讀的差不多了。
讀源碼的時(shí)候也會(huì)遇到一些不能理解的,先略過(guò),主流程先搞懂。
搞懂整體核心流程之后可以摳一些細(xì)節(jié)了,比如我之前看 Dubbo 的時(shí)候就摳了一個(gè)從一段 Dubbo 源碼到 CPU 分支預(yù)測(cè)的一次探險(xiǎn)之旅
再比如之前看 Kafka 的索引設(shè)計(jì)涉及到二分查找,但是源碼中是改版的二分查找。把索引項(xiàng)分為熱區(qū)和冷區(qū),深究下去是為了避免缺頁(yè)中斷。
再比如 RocketMQ 里面看預(yù)熱文件的時(shí)候涉及的這個(gè)方法。
這時(shí)候又涉及到 mlock、madvise 。
這些就是細(xì)節(jié),而細(xì)節(jié)往往就是我們需要學(xué)習(xí)的地方,所以在理清整體流程之后不要錯(cuò)過(guò)細(xì)節(jié)。
往往你覺(jué)得很奇怪的地方可能就是一些“騷操作”,學(xué)的就是“騷操作”。
這一趴讀源碼是為了讓自己得到晉升、學(xué)習(xí)學(xué)習(xí)優(yōu)秀開源框架是如何設(shè)計(jì)而讀的源碼。
為了找問(wèn)題而讀源碼
這個(gè)目的性很強(qiáng),有時(shí)候是項(xiàng)目出錯(cuò),一般而言有日志,所以通過(guò)日志搜就行。
如果你本身對(duì)這個(gè)框架很熟悉那當(dāng)然最好,如果不熟悉通過(guò)日志搜索結(jié)合上下文其實(shí)也能找到一些緣由。
不過(guò)有時(shí)候還是得整個(gè)鏈路分析下來(lái)才能排查問(wèn)題,這個(gè)看功力了。
有時(shí)候是因?yàn)榭吹揭恍┪恼碌恼f(shuō)法沖突了,一篇說(shuō) A 另一篇說(shuō) B ,如果你找不到權(quán)威的信息你只能自己去看源碼,通過(guò)關(guān)鍵字搜。
比如我這篇寫的:
這就是源碼之下無(wú)秘密。
這種目的性很強(qiáng)的讀源碼就得結(jié)合當(dāng)時(shí)上下文和靠個(gè)人功力了。
最后
不知不覺(jué)說(shuō)了這么多。
我只能告訴你不要被源碼勸退,你其實(shí)一直在看源碼。
然后要自頂向下的看源碼,不要一頭就鉆進(jìn)細(xì)節(jié),先從官網(wǎng)等渠道對(duì)開源框架有個(gè)全面的了解,然后看源碼理清主流程。
再配合流程圖、時(shí)序圖、腦圖等記錄、歸類。
然后再看細(xì)節(jié),學(xué)學(xué)優(yōu)秀開源框架的“騷操作”。
模仿它,學(xué)會(huì)它,從中能延展出很多額外的底層知識(shí),比如上面提到的預(yù)防缺頁(yè)中斷,預(yù)熱鎖頁(yè),分支預(yù)測(cè)等等。
當(dāng)然也可以先去網(wǎng)上搜一搜別人的源碼分析文章,比如我之前的一些,然后自己再上手,這樣會(huì)比較舒服和順利。
或者一些相關(guān)的付費(fèi)專欄,我個(gè)人覺(jué)得不要排斥知識(shí)付費(fèi),就這么點(diǎn)錢,比你買個(gè)皮膚劃算。
人家匯總整理知識(shí),你花點(diǎn)小錢,節(jié)省你自己研究的時(shí)間,我覺(jué)得不虧。
反正我自己買了很多,我自己從中有收獲,所以我說(shuō)的一點(diǎn)都不心虛。
最后,源碼是塊硬骨頭這毋庸置疑,我只能告訴你看源碼的準(zhǔn)備工作和一些小心得。
道阻且長(zhǎng),行則將至。
沖!
特別推薦一個(gè)分享架構(gòu)+算法的優(yōu)質(zhì)內(nèi)容,還沒(méi)關(guān)注的小伙伴,可以長(zhǎng)按關(guān)注一下:
長(zhǎng)按訂閱更多精彩▼
如有收獲,點(diǎn)個(gè)在看,誠(chéng)摯感謝
免責(zé)聲明:本文內(nèi)容由21ic獲得授權(quán)后發(fā)布,版權(quán)歸原作者所有,本平臺(tái)僅提供信息存儲(chǔ)服務(wù)。文章僅代表作者個(gè)人觀點(diǎn),不代表本平臺(tái)立場(chǎng),如有問(wèn)題,請(qǐng)聯(lián)系我們,謝謝!