MyBatis 源碼解析筆記

作者筆記倉庫：https://github.com/seazean/javanotes

歡迎各位關注我的筆記倉庫，clone 倉庫到本地后使用 Typora 閱讀效果更好。

筆記內容參考視頻：https://www.bilibili.com/video/BV1mW411M737?p=71

---

一、運行機制

MyBatis 運行過程：

1. 加載 MyBatis 全局配置文件，通過 XPath 方式解析 XML 配置文件，首先解析核心配置文件， 標簽中配置屬性項有 defaultExecutorType，用來配置指定 Executor 類型，將配置文件的信息填充到 Configuration對象。最后解析映射器配置的映射文件，並 構建 MappedStatement 對象填充至 Configuration，將解析后的映射器添加到 mapperRegistry 中，用於獲取代理

2. 創建一個 DefaultSqlSession 對象，根據參數創建指定類型的 Executor，二級緩存默認開啟，把 Executor 包裝成緩存執行器

3. DefaulSqlSession 調用 getMapper()，通過 JDK 動態代理獲取 Mapper 接口的代理對象 MapperProxy

4. 執行 SQL 語句：

   • MapperProxy.invoke() 執行代理方法，通過 MapperMethod 判斷執行的是增刪改查中的哪個方法
   • 獲取執行者對象 MappedStatement，Executor 調用 executor 開始驅動方法的執行
   • 首先通過 CachingExecutor 去二級緩存查詢，查詢不到去一級緩存查詢，最后去數據庫查詢並放入一級緩存

• Configuration 對象根據 標簽的 statementType 屬性創建 StatementHandler 對象，在 StatementHandler 的構造方法中，創建了 ParameterHandler 和 ResultSetHandler 對象 最后獲取 JDBC 原生的 Connection 對象，創建 Statement 執行者對象，然后進行參數的設置 通過 ParameterHandler 設置預編譯參數，通過 StatementHandler 調用原生的執行者對象執行增刪改查，最后調用ResultsetHandler 封裝查詢結果 四大對象： StatementHandler：執行 SQL 語句的對象 ParameterHandler：設置預編譯參數用的 ResultHandler：處理結果集 Executor：執行器，真正進行 Java 與數據庫交互的對象 二、獲取工廠 SqlSessionFactoryBuilder.build(InputStream, String, Properties)：構建工廠 XMLConfigBuilder.parse()：解析核心配置文件每個標簽的信息（XPath） parseConfiguration(parser.evalNode("/configuration"))：讀取節點內數據， 是 MyBatis 配置文件中的頂層標簽 settings = settingsAsProperties(root.evalNode("settings"))：讀取核心配置文件中的 標簽 settingsElement(settings)：設置框架相關的屬性 configuration.setDefaultExecutorType()：設置 Executor 類型到 configuration，默認是 SIMPLE mapperElement(root.evalNode("mappers"))：解析 mappers 信息，分為 package 和 單個注冊兩種 Configuration.addMappers()：將核心配置文件配置的映射器添加到 mapperRegistry 中，用來獲取代理對象 if...else...：根據映射方法選擇合適的讀取方式 XMLMapperBuilder.parse()：解析 mapper 的標簽的信息 configurationElement(parser.evalNode("/mapper"))：解析 mapper 文件，頂層節點 buildStatementFromContext(context.evalNodes("select..."))：解析操作標簽 XMLStatementBuilder.parseStatementNode()：解析操作標簽的所有的屬性 builderAssistant.addMappedStatement(...)：封裝成 MappedStatement 對象加入 return configuration：返回配置完成的 configuration 對象 return new DefaultSqlSessionFactory(config)：返回工廠對象 總結：解析 XML 是對 Configuration 中的屬性進行填充，那么可以在一個類中創建 Configuration 對象，自定義其中屬性的值來達到配置的效果 三、獲取會話 DefaultSqlSessionFactory.openSession()：獲取 Session 對象，並且創建 Executor 對象 DefaultSqlSessionFactory.openSessionFromDataSource(...)：ExecutorType 為 Executor 的類型，TransactionIsolationLevel 為事務隔離級別，autoCommit 是否開啟事務 transactionFactory.newTransaction(DataSource, IsolationLevel, boolean：事務對象 configuration.newExecutor(tx, execType)：根據參數創建指定類型的 Executor 批量操作筆記的部分有講解到 的屬性 defaultExecutorType，根據配置創建對象 二級緩存默認開啟，會包裝 Executor 對象 new CachingExecutor(executor) return new DefaultSqlSession(configuration, executor, autoCommit)：返回 DefaultSqlSession 對象 四、獲取代理 Configuration.getMapper(Class, SqlSession)：獲取代理的 mapper 對象 MapperRegistry.getMapper(Class, SqlSession)：MapperRegistry 是 Configuration 屬性，在獲取工廠對象時初始化 (MapperProxyFactory<T>) knownMappers.get(type)：獲取接口信息封裝為 MapperProxyFactory 對象 mapperProxyFactory.newInstance(sqlSession)：創建代理對象 new MapperProxy<>(sqlSession, mapperInterface, methodCache)：包裝對象 methodCache 是並發安全的 ConcurrentHashMap 集合，存放要執行的方法 MapperProxy<T> implements InvocationHandler 說明 MapperProxy 默認是一個 InvocationHandler 對象 Proxy.newProxyInstance()：JDK 動態代理創建 MapperProxy 對象 五、執行SQL MapperProxy.invoke()：執行 SQL 語句，Object 類的方法直接執行 public Object invoke(Object proxy, Method method, Object[] args) throws Throwable { try { // 當前方法是否是屬於 Object 類中的方法 if (Object.class.equals(method.getDeclaringClass())) { return method.invoke(this, args); // 當前方法是否是默認方法 } else if (isDefaultMethod(method)) { return invokeDefaultMethod(proxy, method, args); } } catch (Throwable t) { throw ExceptionUtil.unwrapThrowable(t); } // 包裝成一個 MapperMethod 對象並初始化該對象 final MapperMethod mapperMethod = cachedMapperMethod(method); // 【根據 switch-case 判斷使用的什么類型的 SQL 進行邏輯處理】，此處分析查詢語句的查詢操作 return mapperMethod.execute(sqlSession, args); } sqlSession.selectOne(String, Object)：查詢數據 public Object execute(SqlSession sqlSession, Object[] args) { //..... // 解析傳入的參數 Object param = method.convertArgsToSqlCommandParam(args); result = sqlSession.selectOne(command.getName(), param); } // DefaultSqlSession.selectList(String, Object) public <E> List<E> selectList(String statement, Object parameter, RowBounds rowBounds) { // 獲取執行者對象 MappedStatement ms = configuration.getMappedStatement(statement); // 開始執行查詢語句，參數通過 wrapCollection() 包裝成集合類 return executor.query(ms, wrapCollection(parameter), rowBounds, Executor.NO_RESULT_HANDLER); } Executor#query()： CachingExecutor.query()：先執行 CachingExecutor 去二級緩存獲取數據 MappedStatement.getBoundSql(parameterObject)：把 parameterObject 封裝成 BoundSql 構造函數中有：this.parameterObject = parameterObject CachingExecutor.createCacheKey()：創建緩存對象 ms.getCache()：獲取二級緩存 tcm.getObject(cache, key)：嘗試從二級緩存中獲取數據 BaseExecutor.query()：獲取不到緩存繼續執行該方法 localCache.getObject(key) ：嘗試從本地緩存（一級緩存）獲取數據 BaseExecutor.queryFromDatabase()：緩存獲取數據失敗，開始從數據庫獲取數據，並放入本地緩存 SimpleExecutor.doQuery()：執行 query configuration.newStatementHandler()：創建 StatementHandler 對象 根據 標簽的 statementType 屬性，根據屬性選擇創建哪種對象
• 判斷 BoundSql 是否被創建，沒有創建會重新封裝參數信息到 BoundSql
• StatementHandler 的構造方法中，創建了 ParameterHandler 和 ResultSetHandler 對象
• interceptorChain.pluginAll(statementHandler)：攔截器鏈

prepareStatement()：通過 StatementHandler 創建 JDBC 原生的 Statement 對象

• getConnection()：獲取 JDBC 的 Connection 對象
• handler.prepare()：初始化 Statement 對象
  • instantiateStatement(Connection connection)：Connection 中的方法實例化對象
    • 獲取普通執行者對象：Connection.createStatement()
    • 獲取預編譯執行者對象：Connection.prepareStatement()
• handler.parameterize()：進行參數的設置
  • ParameterHandler.setParameters()：通過 ParameterHandler 設置參數
    • typeHandler.setParameter()：底層通過 TypeHandler 實現

StatementHandler.query()：封裝成 JDBC 的 PreparedStatement 執行 SQL

resultSetHandler.handleResultSets(ps)：通過 ResultSetHandler 對象封裝結果集

localCache.putObject(key, list)：放入本地緩存

return list.get(0)：返回結果集的第一個數據