高效閱讀源碼

① 如何高效閱讀源代碼

下面是之前寫的一篇文章：《如何快速閱讀源碼》

本文探討在需要了解一個開源項目時，如何快速的理清開源項目的代碼邏輯！

以下是個人認為行之有效的方法：

本文以Mybatis為例來進行演示！

程序界有個老傳統，學習新技術時都是從「Hello World」開始的！無論是學習新語言時，列印「Hello World」；還是學習新框架時編寫個demo！那為什麼這里的「跑起來」要打個引號呢？

實際上，當你想要閱讀一個開源項目的源碼時，絕大部分情況下，你已經能夠使用這個開源項目了！所以這里的「跑起來」就不是寫個「Hello World」，也不是能跑起來的程序了！而是能__在你的腦子里「跑起來」__！什麼意思？

Mybatis你會用了吧？那麼請問Mybatis是如何執行的呢？仔細想想，你能否用完整的語句把它描述出來？

這里是Mybatis的官方入門文章！你是如何看這篇文章的？讀一遍就行了嗎？還是跟著文章跑一遍就夠了嗎？從這篇文章里你能獲得多少信息？

我們來理一下：

回答出了上面這些問題！你也就基本能在腦子里把Mybatis「跑起來」了！之後，你才能正真的開始閱讀源碼！

當你能把一個開源項目「跑起來」後，實際上你就有了對開源項目最初步的了解了！就像「 書的索引 」一樣！基於這個索引，我們一步步的進行拆解，來細化出下一層的結構和流程，期間可能需要深入技術細節，考量實現，考慮是否有更好的實現方案！也就是說後面的三步並不是線性的，而是__不斷交替執行__的一個過程！最終就形成一個完整的源碼執行流程！

繼續通過Mybatis來演示（限於篇幅，我只演示一個大概流程）！我們現在已經有了一個大概的流程了：

雖說每個點都可以往下細化，但是也分個輕重緩急！

很明顯，SqlSession去執行 sql才是Mybatis的核心！我們先從這個點入手！

首先，你當然得先下載Mybatis的源碼了（請自行下載）！

我們直接去看SqlSession！它是個介面，裡面有一堆執行sql的方法！

這里只列出了一部分方法：

SqlSession就是通過這些方法來執行sql的！我們直接看我們常用的，也是Mybatis推薦的用法，就是基於Mapper的執行！也就是說「SqlSession通過Mapper來執行具體的sql」！上面的流程也就細化成了：

那SqlSession是如何獲取Mapper的呢？Mapper又是如何執行sql的呢？

我們來看SqlSession的實現！SqlSession有兩個實現類SqlSessionManager和DefaultSqlSession！通過IDE的引用功能可以查看兩個類的使用情況。你會發現SqlSessionManager實際並沒有使用！而DefaultSqlSession是通過DefaultSqlSessionFactory構建的！所以我們來看DefaultSqlSession是如何構建Mapper的！

它直接委託給了Configuration的getMapper方法！

Configuration又委託給了MapperRegistry類的getMapper方法！

在MapperRegistry類的getMapper中：

在這里knowMappers是什麼？MapperProxyFactory又是什麼？mapperProxyFactory.newInstance(sqlSession)具體做了什麼？

其實很簡單，knowMappers是個Map，裡麵包含了class與對應的MapperProxyFactory的對應關系！MapperProxyFactory通過newInstance來構建對應的Mapper（實際上是Mapper的代理）！

快接近真相了，看mapperProxyFactory.newInstance(sqlSession)里的代碼：

這里幹了什麼？

最終實際還是委託給了sqlSession去執行具體的sql！後面具體怎麼實現的就自行查看吧！

現在我們的流程大概是這樣的一個過程：

現在我們大概知道了：

那麼，

這個問題列表可以很長，可以按個人需要去思考並嘗試回答！可能最終這些問題已經和開源項目本身沒有什麼關系了！但是你思考後的收獲要比看源碼本身要多得多！

一輪結束後，可以再次進行：

不斷的拆解->深入->改進，最終你能__通過一個開源項目，學習到遠比開源項目本身多得多的知識__！

最重要的是，你的流程是完整的。無論是最初的大致流程：

還是到最終深入的細枝末節，都是個完整的流程！

這樣的好處是，你的時間能自由控制：

而不像debug那樣的方式，需要一下子花費很長的時間去一步步的理流程，費時費力、收效很小，而且如果中斷了就很難繼續了！

本文通過梳理Mybatis源碼的一個簡單流程，來講述一個個人認為比較好的閱讀源碼的方式，並闡述此方法與傳統debug方式相比的優勢。

閱讀源碼是每個優秀開發工程師的必經之路，那麼這篇文章就來講解下為什麼要閱讀源碼以及如何閱讀源碼。

首先來說下為什麼要讀源碼，有學習源碼的必要嗎？

為什麼要閱讀源碼？

關於為什麼閱讀和學習源碼，我個人認為可能有以下幾點：

（一）吊打面試官，應對面試

為了找到更好的工作，應對面試，因為在面試中肯定會問到源碼級別的問題，比如：為什麼 HashMap 是線程不安全的？

如果你沒有閱讀過源碼，面試官可能會對回答的結果不滿意，進而導致面試結果不太理想，但如果你對源碼有所研究，並能夠很好地問答面試官的問題，這可能就是你的加分點，可以形成自己獨特的競爭力，吊打面試官，升職加薪不是夢。

（二）解決問題（bug）

在開發過程中，我們或多或少會遇到 bug，比如：在 foreach 循環里進行元素的 remove/add 操作，為啥有可能會報 異常？

我們可以先在 Google、Stack Overflow 以及對應項目的 Issues 里看有沒有類似問題以及解決辦法，如果沒有的話，我們只能通過閱讀源碼的方式去解決了。如果我們對相關源碼有所涉獵，就可以快速定位到問題所在。

（三）提升編程能力

和閱讀一本好書一樣，閱讀源碼就是和編程大牛面對面交流的機會，在許多優秀的開源項目中，它們的編碼規范和架構設計都是很棒的，另外在設計上也使用了大量的設計模式，通過閱讀和學習源碼，能夠快速提升我們的編碼水平，以及對設計模式有更深的理解。

同時，在我們閱讀完一個源碼後，可以觸類旁通，能夠快速地對其他框架的源碼進行閱讀和學習，減少時間成本。

除了上述提到的原因之外，可能還有許多，在這里就不一一贅述了，那麼在確定了要閱讀源碼之後，就讓我們看下如何閱讀源碼吧！

如何閱讀源碼？

如何閱讀源碼取決於你為什麼要讀源碼，比如：

下面大概說下閱讀源碼的幾點建議：

在閱讀之前，可以先從開源項目的官網上看它的架構設計和功能文檔，了解這個項目的 整體架構、模塊組成以及各個模塊之間的聯系 。

如果沒有對應的項目文檔，可以根據代碼的模塊進行梳理，以形成對項目的初步了解，或者 查看已有的源碼解析文章或者書籍 ，在閱讀源碼之前，了解項目的架構和思路會使閱讀源碼事半功倍。

在了解一個類的時候，可以使用 ctrl+F12 來查看類中的成員變數和方法。

可以通過 IDEA 的 Diagrams 功能去了解一個類的繼承關系。

多打 斷點調試 ，斷點追蹤源碼是很好的閱讀源碼的方式，可以先通過 debug 了解下調用邏輯，都和哪些類有關聯，有大致了解後再通過 debug 了解整體代碼的功能實現，各個類都起到了什麼作用，有沒有涉及到設計模式等。

另外，優秀的開源項目中肯定會有許多地方應用到了 設計模式 ，建議在閱讀源碼之前，需要對常用的設計模式有大致的了解，不然閱讀源碼的效率會大大降低。

如果遇到讀不懂某部分源碼的時候，可以先跳過，之後再回來看，如果屬於搞不懂這部分就茶不思飯不想的人，可以在網上找是否有該部分源碼的解析或者文檔，也可以自己通過 源碼注釋和測試用例 去閱讀學習。

一般優秀的開源項目都會有 單元測試 ，可以通過對應類的單元測試去了解方法的含義和用法，加深對源碼邏輯的理解。

在閱讀源碼的時候，可以在代碼上加上 注釋和總結 ，同時還可以畫出 時序圖和類圖 ，這樣對閱讀源碼有很大的幫助，可以很清楚地知道類之間的調用關系和依賴關系，也方便以後回顧，重新閱讀。

在這里推薦大家一個 IDEA 插件 SequenceDiagram，可以根據源碼生成調用時序圖，便於閱讀源碼。

剛開始閱讀源碼，不建議直接看框架源碼，可以先從 jdk 源碼看起：

jdk 源碼也是非常龐大的，可以分模塊來閱讀，下面是建議的閱讀順序：

其他包下的代碼也可以做下了解，JDK源碼閱讀筆記：https://github.com/wupeixuan/JDKSourceCode1.8

再有了一定的源碼閱讀經驗後，可以再去學習 Spring、Spring Boot、Dubbo、Spring Cloud 等框架的源碼。

主要介紹了為什麼讀源碼以及如何讀源碼，供大家參考，每個人都有適合自己的閱讀源碼的方式，希望可以在學習中去摸索出一套屬於自己的方式。

閱讀源碼不是一蹴而就的，這是持久戰，只要你能夠堅持下來，肯定受益匪淺。閱讀源碼的過程比較枯燥，可以在社群里一起討論學習，這樣可能效率更高些。

沒看過源代碼，都不好意思出來說了，最近剛好在看一些，來說一個。

先看一下這個庫是做什麼用的，然後提供了哪些功能。

一般會看下項目最新的情況，然後沒有關閉的issue，看下wiki，大家在討論什麼。

clone 一份到本地，然後先看下目錄結構，然後根據文檔看幾個簡單的組件的時候，一邊看掘金上的分析，一邊自己看下實現。

e le

餓了么這個框架代碼結構還是很清楚的，基本上每個組件都是分開的，所以你只要看其他的一個文件夾就行。然後一些工具的都在src文件夾。

要學會看issue，一般開源的項目都有人會來提建議，有些是bug，有些是功能，你可以看看自己是否有能力去解決，如果可以的話，你可以去fork代碼，然後自己修改，再提pr。

我最近恰好找摸索出一個梳理遺留系統架構的技巧：自底向上 找到一個典型的切面 沿著調用和回調的路徑 在代碼中添加結構化注釋（比如eclipse中加//TAG 流程A1.1 甲->>乙），這樣便得到了一個code地圖，並且在tasks視圖中看起來很直觀（看起來跟書的目錄一樣）可快速跳轉。將目錄到有道雲筆記的markdown序列圖中 就自動生成了一個序列圖。

我覺得這基本上就是可縮放的可視化架構地圖了，對維護一個比較亂和龐大的遺留系統非常有幫助，定位代碼 修改維護都方便多了。

1、需要過硬的基礎知識，這個前提。不然基本語法、常用的模式都不曉得怎麼讀。

2、多參考 歷史 版本和更新變化，好的源碼都是反復迭代出來的精華，開始就讀精華是很不明智的，所以看看版本更新說明，版本的 歷史 演變。就想人一樣是怎樣進化過來的。

3、參考別人閱讀注釋，想必在你讀源碼之前也有人讀過了源碼，並且總結，注釋。和分享原理，可供你參考，畢竟每個人讀一篇文章，理解的東西是有差異化的。

4、直接買書，有些作品直接出書就是源碼精解

5、找個大神給你慢慢分析，這個最快。娓娓道來，直接面授比啥都強。缺點是，你容易跟著他的思維走下去。

我覺得閱讀代碼就不應該高效，而應該像看小說一樣，看的過程就像是在和作者交流，有趣才是看代碼的動力。

畫圖，看數據走向，邏輯走向

先弄清楚這些代碼實現了哪些功能，然後從主線開始往下看，好的代碼光看變數和介面名稱就能明白是什麼意思？扒出源碼實現的整體框架邏輯，然後再對自己感興趣的模塊進行剖析，還是從整體把握，細節深入，慢慢地整個框架就被豐滿了。

接下來是思考為什麼要如此設計，這樣設計的好處是什麼？如果是你來做應該怎麼設計，把你覺得源碼缺點的地方進行仔細研究，了解裡面是否包含自己不清楚的細節，避免遺漏。

接下來就是根據代碼改造或者是調試錯誤，對於源碼中遇到的不理解的地方一定要弄明白，有的確實是畫蛇添足，有的有獨特的作用。

多多學習，對每一種主流框架銘記於心，對主流設計模式了如指掌，萬變不離其宗，源碼看多了，跟看一個電視機遙控器的操作說明一樣。

1、一邊閱讀代碼一邊寫注釋。這是我用過的最好的方法，對代碼理解得更深入，看一些重要代碼或者特別難懂的代碼時挺有用。更何況，注釋也是一種文檔嘛。

2、一邊閱讀代碼一邊繪制UML。這個方法適用於類之間的關系較復雜和調用層次較深的情況，我一般都是先繪制順序圖，然後為順序圖中的類繪制關系圖。

3、通過Debug來跟蹤程序的主要執行過程，這樣就可以分清主次了，閱讀的時候更有針對性。

4、類的快速閱讀。先弄清楚它在繼承鏈中的位置，看看它的內部狀態，也就是成員變數，一般來說，類的對外介面都是對成員變數的訪問、加工、代理等，然後看看它的對外介面，也就是公有成員函數，識別核心的一個或多個函數，這時候你應該可以大概了解這個類的職責或作用了。可能這個類是某個設計模式中的一個組成部分，所以，設計模式的掌握對代碼的快速閱讀也是很有幫助的。

5、帶著問題去閱讀。比如想了解android中的消息機制，那麼看看Looper、Handler、MessegeQueue這幾個類就可以了，其他的不要去看，要不然就跑題了。

下面列幾個閱讀源碼時所處的情景，在特定場景下用哪些方法： 不太熟悉業務邏輯，還不是很清楚它是幹啥的，可以用3、5。 代碼量很大，有幾十萬行，甚至百萬行，可以用2、3、5。 你無法看見程序的運行過程，比如沒有用戶界面，也有可能是無法運行的，可以用3、5。 設計復雜，用了大量的設計模式，調用鏈很深，可以用1、2、3、4、5。 時間有限，沒有那麼多時間讓你看源碼，可以用3、5。

畫出邏輯流程圖，先了解整體流程，再詳解具體函數

② [探討]提高代碼質量的方法有哪些

1. 代碼風格和規范：

多看看網上的一些代碼規范，仔細思考一下制定這些規范的出發點是什麼。例如Oracle（前

SUN)公司的代碼規范，Google的代碼規范 。

2. 學習最佳實踐

在編碼中遇到的各種大大小小的問題，首先不是自己去「閉門造車」的冥思苦想，多用

Google，搜搜是否已經有現成的解決方案。

3. 閱讀優秀的開源代碼

網上有很多優秀的開源項目，針對你自己項目中遇到的問題，找找類似的開源項目，學習、

研究，最重要的是變成自己的東西。

4. 學好英語

英語是目前所有編程語言的基礎。你的文件名、類名、方法名、變數名都是需要一個好的英

語基礎才能夠起得合適。任何的業務邏輯，都需要你使用以英語為基礎的計算機語言表達出來。

英語不好，你的代碼永遠看起來不專業。

書籍涵蓋的主題從個人責任、職業發展，知道用於使代碼保持靈活、並且易於改編和復用的

各種架構技術。

總結起來方法有三：平時多練手，多閱讀優秀的源碼，閱讀優秀的編程技巧類型的書。

③ 怎樣高效的閱讀javaWeb項目源代碼

首先要理清楚代碼結構和業務結構（應該有些文檔或者大的流程圖），這是閱讀具體代碼的前提。

閱讀Javaweb項目的代碼：
你需要找到
View層的代碼：前端頁面、圖片、資源文件都在其中。
Controller層的代碼：控制試圖與模型層以及數據傳遞。
Service層的代碼：業務邏輯。
Dao層的代碼：資料庫訪問邏輯。

從web.xml-appcontext.xml-xxx

④ 學習JAVA的同學都是怎麼讀源碼的

剛參加工作那會，沒想過去讀源碼，更沒想過去改框架的源碼;總想著別人的框架應該是完美的、萬能的，應該不需要改;另外即使我改了源碼，怎麼樣讓我的改動生效了?項目中引用的不還是沒改的jar包嗎。回想起來覺得那時候的想法確實挺??