如何快速阅读源码
本文探討在需要了解一個開源項目時，如何快速的理清開源項目的代碼邏輯！
以下是個人認為行之有效的方法：
- 先「跑起來」
- 自頂向下拆解
- 深入細節
- 延伸改進
本文以Mybatis為例來進行演示！
先“跑起來”
程序界有個老傳統，學習新技術時都是從「Hello World」開始的！無論是學習新語言時，打印「Hello World」；還是學習新框架時編寫個demo！那為什么這里的「跑起來」要打個引號呢？
實際上，當你想要閱讀一個開源項目的源碼時，絕大部分情況下，你已經能夠使用這個開源項目了！所以這里的“跑起來”就不是寫個「Hello World」，也不是能跑起來的程序了！而是能__在你的腦子里「跑起來」__！什么意思？
Mybatis你會用了吧？那么請問Mybatis是如何執行的呢？仔細想想，你能否用完整的語句把它描述出來？
這里是Mybatis的官方入門文章！你是如何看這篇文章的？讀一遍就行了嗎？還是跟著文章跑一遍就夠了嗎？從這篇文章里你能獲得多少信息？
我們來理一下：
- 安裝
- 如何在項目中引入Mybatis?
- Mybatis的groupId是什么？artifactId又是什么？目前最新版本是多少？
- 從 XML 中構建 SqlSessionFactory
- SqlSessionFactoryBuilder可以通過xml或者Configuration來構建SqlSessionFactory，那是如何構建的呢？
- xml配置了哪些信息？既然使用了xml，那肯定有xml解析，用什么方式解析的？
- xml里的標簽都是什么意思：configuration，environments，transactionManager，dataSource，mappers。以及這些標簽的屬性分別是什么意思？
- SqlSessionFactory的作用是什么？
- 不使用 XML 構建 SqlSessionFactory
- BlogDataSourceFactory，DataSource，TransactionFactory，Environment，Configuration這些類的作用是什么？
- *Mapper的作用是什么？
- 為什么提供基于XML和Java的兩種配置方式？這兩種配置方式的優缺點是什么？
- 從 SqlSessionFactory 中獲取 SqlSession
- SqlSession的作用是什么？
- selectOne和getMapper的執行方式有什么區別？
- 探究已映射的 SQL 語句
- *Mapper.xml的配置是什么？
- 命名空間，id的作用是什么？
- *Mapper.xml是如何和*Mapper.java進行匹配的？
- 匹配規則是什么？
- 基于注解的映射配置如何使用？
- 為什么提供基于XML和基于注解的兩種映射配置？有什么優劣？
- 作用域（Scope）和生命周期
- SqlSessionFactoryBuilder應該在哪個作用域使用？為什么？
- SqlSessionFactory應該在哪個作用域使用？為什么？
- SqlSession應該在哪個作用域使用？為什么？
- Mapper實例應該在哪個作用域使用？為什么？
回答出了上面這些問題！你也就基本能在腦子里把Mybatis「跑起來」了！之后，你才能正真的開始閱讀源碼！
當你能把一個開源項目「跑起來」后，實際上你就有了對開源項目最初步的了解了！就像「書的索引」一樣！基于這個索引，我們一步步的進行拆解，來細化出下一層的結構和流程，期間可能需要深入技術細節，考量實現，考慮是否有更好的實現方案！也就是說后面的三步并不是線性的，而是__不斷交替執行__的一個過程！最終就形成一個完整的源碼執行流程！
自頂向下拆解
繼續通過Mybatis來演示（限于篇幅，我只演示一個大概流程）！我們現在已經有了一個大概的流程了：
- SqlSessionFactoryBuilder通過xml或者Configuration構建出SqlSessionFactory
- 可以從SqlSessionFactory中獲取SqlSession
- SqlSession則是真正執行sql的類
雖說每個點都可以往下細化，但是也分個輕重緩急！
- 我們是先了解怎么構建SqlSessionFactory呢？
- 還是了解如何獲取SqlSession呢？
- 還是了解SqlSession如何執行sql的呢？
很明顯，SqlSession去執行 sql才是Mybatis的核心！我們先從這個點入手！
首先，你當然得先下載Mybatis的源碼了（請自行下載）！
我們直接去看SqlSession！它是個接口，里面有一堆執行sql的方法！
這里只列出了一部分方法：
public interface SqlSession extends Closeable {<T> T selectOne(String statement);<E> List<E> selectList(String statement);<K, V> Map<K, V> selectMap(String statement, String mapKey);<T> Cursor<T> selectCursor(String statement);void select(String statement, Object parameter, ResultHandler handler);int insert(String statement);int update(String statement);int delete(String statement);void commit();void rollback();List<BatchResult> flushStatements();<T> T getMapper(Class<T> type);... } 復制代碼SqlSession就是通過這些方法來執行sql的！我們直接看我們常用的，也是Mybatis推薦的用法，就是基于Mapper的執行！也就是說「SqlSession通過Mapper來執行具體的sql」！上面的流程也就細化成了：
- SqlSessionFactoryBuilder通過xml或者Configuration構建出SqlSessionFactory
- 可以從SqlSessionFactory中獲取SqlSession
- SqlSession則是真正執行sql的類
- SqlSession獲取對應的Mapper實例
- Mapper實例來執行相應的sql
那SqlSession是如何獲取Mapper的呢？Mapper又是如何執行sql的呢？
深入細節
我們來看SqlSession的實現！SqlSession有兩個實現類SqlSessionManager和DefaultSqlSession！通過IDE的引用功能可以查看兩個類的使用情況。你會發現SqlSessionManager實際并沒有使用！而DefaultSqlSession是通過DefaultSqlSessionFactory構建的！所以我們來看DefaultSqlSession是如何構建Mapper的！
public <T> T getMapper(Class<T> type) {return configuration.<T>getMapper(type, this); } 復制代碼它直接委托給了Configuration的getMapper方法！
public <T> T getMapper(Class<T> type, SqlSession sqlSession) {return mapperRegistry.getMapper(type, sqlSession); } 復制代碼Configuration又委托給了MapperRegistry類的getMapper方法！
public <T> T getMapper(Class<T> type, SqlSession sqlSession) {final MapperProxyFactory<T> mapperProxyFactory = (MapperProxyFactory<T>) knownMappers.get(type);if (mapperProxyFactory == null) {throw new BindingException("Type " + type+ " is not known to the MapperRegistry.");}try {return mapperProxyFactory.newInstance(sqlSession);} catch (Exception e) {throw new BindingException("Error getting mapper instance. Cause: " + e, e);} } 復制代碼在MapperRegistry類的getMapper中：
- 通過type從knownMappers中獲取對應的MapperProxyFactory實例
- 如果不存在則拋出異常
- 如果存在則調用mapperProxyFactory.newInstance(sqlSession)創建對應的Mapper
在這里knowMappers是什么？MapperProxyFactory又是什么？mapperProxyFactory.newInstance(sqlSession)具體做了什么？
其實很簡單，knowMappers是個Map，里面包含了class與對應的MapperProxyFactory的對應關系！MapperProxyFactory通過newInstance來構建對應的Mapper（實際上是Mapper的代理）！
快接近真相了，看mapperProxyFactory.newInstance(sqlSession)里的代碼：
public T newInstance(SqlSession sqlSession) {final MapperProxy<T> mapperProxy = new MapperProxy<T>(sqlSession, mapperInterface, methodCache);return newInstance(mapperProxy); }protected T newInstance(MapperProxy<T> mapperProxy) {return (T) Proxy.newProxyInstance(mapperInterface.getClassLoader(), new Class[] { mapperInterface }, mapperProxy); } 復制代碼這里干了什么？
- 通過sqlSession,mapperInterface和methodCache構建了一個MapperProxy對象
- 然后通過Java的動態代理，來生成了Mapper的代理類
- 將Mapper方法的執行都委托給了MapperProxy去執行
- 如果是Object里的方法則直接執行
- 否則執行MapperMethod的execute方法
最終實際還是委托給了sqlSession去執行具體的sql！后面具體怎么實現的就自行查看吧！
延伸改進
現在我們的流程大概是這樣的一個過程：
- SqlSessionFactoryBuilder通過xml或者Configuration構建出SqlSessionFactory
- 可以從SqlSessionFactory中獲取SqlSession
- SqlSession則是真正執行sql的類
- SqlSession獲取對應的Mapper實例
- DefaultSqlSession.getMapper
- Configuration.getMapper
- MapperRegistry.getMapper
- mapperProxyFactory.newInstance(sqlSession)
- 通過sqlSession,mapperInterface和methodCache構建了一個MapperProxy對象
- 然后通過Java的動態代理，來生成了Mapper的代理類
- Mapper實例來執行相應的sql
- 將Mapper方法的執行都委托給了MapperProxy去執行
- 如果是Object里的方法則直接執行
- 否則執行MapperMethod的execute方法
- 最終還是委托給sqlSession去執行sql
- SqlSession獲取對應的Mapper實例
現在我們大概知道了：
- 為什么Mapper是個接口了
- Mybatis基于這個接口做了什么
那么，
- 什么是動態代理（基礎哦）？
- 為什么使用動態代理來處理？
- 基于動態代理有什么優點？又有什么缺點？
- 除了動態代理，還有其它什么實現方式嗎？比如說cglib?
- 如果是其它語言的話，有沒有什么好的實現方式呢？
- ......
這個問題列表可以很長，可以按個人需要去思考并嘗試回答！可能最終這些問題已經和開源項目本身沒有什么關系了！但是你思考后的收獲要比看源碼本身要多得多！
再循環
一輪結束后，可以再次進行：
- 自頂向下拆解
- 深入細節
- 延伸改進
不斷的拆解->深入->改進，最終你能__通過一個開源項目，學習到遠比開源項目本身多得多的知識__！
最重要的是，你的流程是完整的。無論是最初的大致流程：
- SqlSessionFactoryBuilder通過xml或者Configuration構建出SqlSessionFactory
- 可以從SqlSessionFactory中獲取SqlSession
- SqlSession則是真正執行sql的類
還是到最終深入的細枝末節，都是個完整的流程！
這樣的好處是，你的時間能自由控制：
- 你是要花個半天時間，了解大致流程
- 還是花個幾天理解細節流程
- 還是花個幾周，幾個月來深入思考，不斷延伸 你都可以從之前的流程中快速進行下去！
而不像debug那樣的方式，需要一下子花費很長的時間去一步步的理流程，費時費力、收效很小，而且如果中斷了就很難繼續了！
總結
本文通過梳理Mybatis源碼的一個簡單流程，來講述一個個人認為比較好的閱讀源碼的方式，并闡述此方法與傳統debug方式相比的優勢。
公眾號：ivaneye
總結
- 上一篇： centos提示找不到netstat 和
- 下一篇： IDEA中一个工程多个模块(module