如何高效閱讀源代碼？

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

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

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

先「跑起來」自頂向下拆解深入細節(jié)延伸改進

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

先“跑起來”

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

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

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

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

我們來理一下：

安裝如何在項目中引入Mybatis?Mybatis的groupId是什么？artifactId又是什么？目前最新版本是多少？從 XML 中構(gòu)建 SqlSessionFactorySqlSessionFactoryBuilder可以通過xml或者Configuration來構(gòu)建SqlSessionFactory，那是如何構(gòu)建的呢？xml配置了哪些信息？既然使用了xml，那肯定有xml解析，用什么方式解析的？xml里的標簽都是什么意思：configuration，environments，transactionManager，dataSource，mappers。以及這些標簽的屬性分別是什么意思？SqlSessionFactory的作用是什么？不使用 XML 構(gòu)建 SqlSessionFactoryBlogDataSourceFactory，DataSource，TransactionFactory，Environment，Configuration這些類的作用是什么？*Mapper的作用是什么？為什么提供基于XML和Java的兩種配置方式？這兩種配置方式的優(yōu)缺點是什么？從 SqlSessionFactory 中獲取 SqlSessionSqlSession的作用是什么？selectOne和getMapper的執(zhí)行方式有什么區(qū)別？探究已映射的 SQL 語句*Mapper.xml的配置是什么？命名空間，id的作用是什么？*Mapper.xml是如何和*Mapper.java進行匹配的？匹配規(guī)則是什么？基于注解的映射配置如何使用？為什么提供基于XML和基于注解的兩種映射配置？有什么優(yōu)劣？作用域（Scope）和生命周期SqlSessionFactoryBuilder應(yīng)該在哪個作用域使用？為什么？SqlSessionFactory應(yīng)該在哪個作用域使用？為什么？SqlSession應(yīng)該在哪個作用域使用？為什么？Mapper實例應(yīng)該在哪個作用域使用？為什么？

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

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

自頂向下拆解

繼續(xù)通過Mybatis來演示（限于篇幅，我只演示一個大概流程）！我們現(xiàn)在已經(jīng)有了一個大概的流程了：

SqlSessionFactoryBuilder通過xml或者Configuration構(gòu)建出SqlSessionFactory可以從SqlSessionFactory中獲取SqlSessionSqlSession則是真正執(zhí)行sql的類

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

我們是先了解怎么構(gòu)建SqlSessionFactory呢？還是了解如何獲取SqlSession呢？還是了解SqlSession如何執(zhí)行sql的呢？

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

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

我們直接去看SqlSession！它是個接口，里面有一堆執(zhí)行sql的方法！

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

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

SqlSessionFactoryBuilder通過xml或者Configuration構(gòu)建出SqlSessionFactory可以從SqlSessionFactory中獲取SqlSessionSqlSession則是真正執(zhí)行sql的類SqlSession獲取對應(yīng)的Mapper實例Mapper實例來執(zhí)行相應(yīng)的sql

那SqlSession是如何獲取Mapper的呢？Mapper又是如何執(zhí)行sql的呢？

深入細節(jié)

我們來看SqlSession的實現(xiàn)！SqlSession有兩個實現(xiàn)類SqlSessionManager和DefaultSqlSession！通過IDE的引用功能可以查看兩個類的使用情況。你會發(fā)現(xiàn)SqlSessionManager實際并沒有使用！而DefaultSqlSession是通過DefaultSqlSessionFactory構(gòu)建的！所以我們來看DefaultSqlSession是如何構(gòu)建Mapper的！

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

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

在MapperRegistry類的getMapper中：

通過type從knownMappers中獲取對應(yīng)的MapperProxyFactory實例如果不存在則拋出異常如果存在則調(diào)用mapperProxyFactory.newInstance(sqlSession)創(chuàng)建對應(yīng)的Mapper

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

其實很簡單，knowMappers是個Map，里面包含了class與對應(yīng)的MapperProxyFactory的對應(yīng)關(guān)系！MapperProxyFactory通過newInstance來構(gòu)建對應(yīng)的Mapper（實際上是Mapper的代理）！

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

這里干了什么？

通過sqlSession,mapperInterface和methodCache構(gòu)建了一個MapperProxy對象然后通過Java的動態(tài)代理，來生成了Mapper的代理類將Mapper方法的執(zhí)行都委托給了MapperProxy去執(zhí)行如果是Object里的方法則直接執(zhí)行否則執(zhí)行MapperMethod的execute方法

最終實際還是委托給了sqlSession去執(zhí)行具體的sql！后面具體怎么實現(xiàn)的就自行查看吧！

延伸改進

現(xiàn)在我們的流程大概是這樣的一個過程：

SqlSessionFactoryBuilder通過xml或者Configuration構(gòu)建出SqlSessionFactory可以從SqlSessionFactory中獲取SqlSessionSqlSession則是真正執(zhí)行sql的類SqlSession獲取對應(yīng)的Mapper實例DefaultSqlSession.getMapperConfiguration.getMapperMapperRegistry.getMappermapperProxyFactory.newInstance(sqlSession)通過sqlSession,mapperInterface和methodCache構(gòu)建了一個MapperProxy對象然后通過Java的動態(tài)代理，來生成了Mapper的代理類Mapper實例來執(zhí)行相應(yīng)的sql將Mapper方法的執(zhí)行都委托給了MapperProxy去執(zhí)行如果是Object里的方法則直接執(zhí)行否則執(zhí)行MapperMethod的execute方法最終還是委托給sqlSession去執(zhí)行sql

現(xiàn)在我們大概知道了：

為什么Mapper是個接口了Mybatis基于這個接口做了什么

那么，

什么是動態(tài)代理（基礎(chǔ)哦）？為什么使用動態(tài)代理來處理？基于動態(tài)代理有什么優(yōu)點？又有什么缺點？除了動態(tài)代理，還有其它什么實現(xiàn)方式嗎？比如說cglib?如果是其它語言的話，有沒有什么好的實現(xiàn)方式呢？......

這個問題列表可以很長，可以按個人需要去思考并嘗試回答！可能最終這些問題已經(jīng)和開源項目本身沒有什么關(guān)系了！但是你思考后的收獲要比看源碼本身要多得多！

再循環(huán)

一輪結(jié)束后，可以再次進行：

自頂向下拆解深入細節(jié)延伸改進

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

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

SqlSessionFactoryBuilder通過xml或者Configuration構(gòu)建出SqlSessionFactory可以從SqlSessionFactory中獲取SqlSessionSqlSession則是真正執(zhí)行sql的類

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

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

你是要花個半天時間，了解大致流程還是花個幾天理解細節(jié)流程還是花個幾周，幾個月來深入思考，不斷延伸你都可以從之前的流程中快速進行下去！

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

總結(jié)

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