2. 程式人生 > >Mybatis原始碼分析（6）—— 從JDBC看Mybatis的設計

Mybatis原始碼分析（6）—— 從JDBC看Mybatis的設計

阿新 • • 發佈：2018-10-31

Java資料庫連線，（Java Database Connectivity，簡稱JDBC）是Java語言中用來規範客戶端程式如何來訪問資料庫的應用程式介面，提供了諸如查詢和更新資料庫中資料的方法。

六步流程:

  • 載入驅動（5.x驅動包不需要這步了）
  • 建立連線
  • 建立Statement
  • 執行SQL語句
  • 獲取結果集
  • 關閉資源

這裡只取後面幾步分析下，基本上都是從Executor開始。DefaultSqlSession被每個Mapper持有，將各種基於SQL的操作轉移到呼叫Executor的query和update方法。

Executor的類圖如下：

image

以ReuseExecutor的doQuery方法為例：

public <E> List<E> doQuery(MappedStatement ms, Object parameter, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) throws SQLException {
    Configuration configuration = ms.getConfiguration();
    StatementHandler handler = configuration.newStatementHandler(this
 
, ms, parameter, rowBounds, resultHandler, boundSql);
    Statement stmt = prepareStatement(handler, ms.getStatementLog());
    return handler.<E>query(stmt, resultHandler);
}

建立連線

上面ReuseExecutor的doQuery方法呼叫其prepareStatement方法：

private Statement prepareStatement(StatementHandler handler
 
, Log statementLog) throws SQLException {
    Statement stmt;
    BoundSql boundSql = handler.getBoundSql();
    String sql = boundSql.getSql();
    if (hasStatementFor(sql)) {
      stmt = getStatement(sql);
    } else {
      Connection connection = getConnection(statementLog);
      stmt = handler.prepare(connection);
      putStatement(sql, stmt);
    }
    handler.parameterize(stmt);
    return stmt;
}

然後呼叫getConnection方法獲取連線：

protected Connection getConnection(Log statementLog) throws SQLException {
    Connection connection = transaction.getConnection();
    if (statementLog.isDebugEnabled() || connectionLog.isDebugEnabled()) {
      return ConnectionLogger.newInstance(connection, statementLog);
    } else {
      return connection;
    }
}

這個連線是從Transaction物件中獲取的。

當我們和Spring一起使用時，當然由Spring統一管理，回顧DefaultSqlSessionFactory類中的openSessionFromDataSource方法，這個連線就是找Spring要的（DataSourceUtils#getConnection），要過來放到了SpringManagedTransaction中。

建立Statement

  • Statement createStatement()

建立Statement 物件，Statement介面提供基本執行SQL語句的能力。

  • PreparedStatement prepareStatement(String sql)

建立PreparedStatement物件，PreparedStatement介面繼承了Statement介面，提供SQL語句接受輸入引數的能力。

  • CallableStatement prepareCall(String sql)

建立CallableStatement物件，CallableStatement介面繼承了PreparedStatement介面，提供執行儲存過程的能力。

針對這三種情況，Mybatis提供了三個StatementHandler實現：
image

並建立了一個RoutingStatementHandler作為路由（代理類），根據MappedStatement中的statementType來確定建立哪個作為實際的StatementHandler實現。對外提供一致介面，實際呼叫交給委託類。

還是接著看上面的prepareStatement方法，它獲取連線後就接著呼叫StatementHandler的prepare方法：

private Statement prepareStatement(StatementHandler handler, Log statementLog) throws SQLException {
    Statement stmt;
    BoundSql boundSql = handler.getBoundSql();
    String sql = boundSql.getSql();
    if (hasStatementFor(sql)) {
      stmt = getStatement(sql);
    } else {
      Connection connection = getConnection(statementLog);
      stmt = handler.prepare(connection);
      putStatement(sql, stmt);
    }
    handler.parameterize(stmt);
    return stmt;
}

這個來自BaseStatementHandler的prepare方法又是呼叫子類的instantiateStatement方法來例項化Statement:

protected Statement instantiateStatement(Connection connection) throws SQLException {
    String sql = boundSql.getSql();
    if (mappedStatement.getKeyGenerator() instanceof Jdbc3KeyGenerator) {
      String[] keyColumnNames = mappedStatement.getKeyColumns();
      if (keyColumnNames == null) {
        return connection.prepareStatement(sql, PreparedStatement.RETURN_GENERATED_KEYS);
      } else {
        return connection.prepareStatement(sql, keyColumnNames);
      }
    } else if (mappedStatement.getResultSetType() != null) {
      return connection.prepareStatement(sql, mappedStatement.getResultSetType().getValue(), ResultSet.CONCUR_READ_ONLY);
    } else {
      return connection.prepareStatement(sql);
    }
}

這裡最終呼叫connection的prepareStatement方法，回到了我們傳統的操作。

執行SQL語句

在Executor的實現類中，doUpdate和doQuery方法都會呼叫下面兩個方法：

handler.update(stmt);

handler.query(stmt, resultHandler);

SimpleStatementHandler的query方法：

public <E> List<E> query(Statement statement, ResultHandler resultHandler)
      throws SQLException {
    String sql = boundSql.getSql();
    statement.execute(sql);
    return resultSetHandler.<E>handleResultSets(statement);
}

PreparedStatementHandler的query方法：

public <E> List<E> query(Statement statement, ResultHandler resultHandler) throws SQLException {
    PreparedStatement ps = (PreparedStatement) statement;
    ps.execute();
    return resultSetHandler.<E> handleResultSets(ps);
}

CallableStatementHandler的query方法：

public <E> List<E> query(Statement statement, ResultHandler resultHandler)
      throws SQLException {
    CallableStatement cs = (CallableStatement) statement;
    cs.execute();
    List<E> resultList = resultSetHandler.<E>handleResultSets(cs);
    resultSetHandler.handleOutputParameters(cs);
    return resultList;
}

這裡都是直接調的Statement或PreparedStatement的execute方法。

返回結果集

上面的三種StatementHandler，最終都會處理結果集，CallableStatementHandler有點特殊，其它兩種都是呼叫ResultSetHandler的handleResultSets方法來處理結果集。ResultSetHandler在基類BaseStatementHandler的建構函式中通過configuration物件來建立：

this.resultSetHandler = configuration.newResultSetHandler(executor, mappedStatement, rowBounds, parameterHandler, resultHandler, boundSql);

具體的實現有兩種，FastResultSetHandler和NestedResultSetHandler，且NestedResultSetHandler繼承了FastResultSetHandler，重寫了handleRowValues方法。

在FastResultSetHandler的handleResultSets方法中：

public List<Object> handleResultSets(Statement stmt) throws SQLException {
    final List<Object> multipleResults = new ArrayList<Object>();
    final List<ResultMap> resultMaps = mappedStatement.getResultMaps();
    int resultMapCount = resultMaps.size();
    int resultSetCount = 0;
    ResultSet rs = stmt.getResultSet();

    while (rs == null) {
      // move forward to get the first resultset in case the driver
      // doesn't return the resultset as the first result (HSQLDB 2.1)
      if (stmt.getMoreResults()) {
        rs = stmt.getResultSet();
      } else {
        if (stmt.getUpdateCount() == -1) {
          // no more results.  Must be no resultset
          break;
        }
      }
    }
    // 驗證是否定義了resultType或者resultMap
    validateResultMapsCount(rs, resultMapCount);
    while (rs != null && resultMapCount > resultSetCount) {
      final ResultMap resultMap = resultMaps.get(resultSetCount);
      ResultColumnCache resultColumnCache = new ResultColumnCache(rs.getMetaData(), configuration);
      handleResultSet(rs, resultMap, multipleResults, resultColumnCache);
      rs = getNextResultSet(stmt);
      cleanUpAfterHandlingResultSet();
      resultSetCount++;
    }
    return collapseSingleResultList(multipleResults);
}

處理結果行：

protected void handleRowValues(ResultSet rs, ResultMap resultMap, ResultHandler resultHandler, RowBounds rowBounds, ResultColumnCache resultColumnCache) throws SQLException {
    final DefaultResultContext resultContext = new DefaultResultContext();
    skipRows(rs, rowBounds);
    while (shouldProcessMoreRows(rs, resultContext, rowBounds)) {
      final ResultMap discriminatedResultMap = resolveDiscriminatedResultMap(rs, resultMap, null);
      Object rowValue = getRowValue(rs, discriminatedResultMap, null, resultColumnCache);
      callResultHandler(resultHandler, resultContext, rowValue);
    }
}

skipRows就是跳過行，基於查詢結果的分頁使用，其中會直接呼叫ResultSet的absolute方法：

rs.absolute(rowBounds.getOffset());

而shouldProcessMoreRows方法就是判斷是否應該獲取更多的行：

protected boolean shouldProcessMoreRows(ResultSet rs, ResultContext context, RowBounds rowBounds) throws SQLException {
    return !context.isStopped() && rs.next() && context.getResultCount() < rowBounds.getLimit();
}

也對應了分頁的limit欄位，這種分頁可以說是偽分頁，查出來再分頁。所以我們一般使用外掛的形式來實現分頁，基於sql的動態替換。

具體針對行的處理在getRowValue方法中：

protected Object getRowValue(ResultSet rs, ResultMap resultMap, CacheKey rowKey, ResultColumnCache resultColumnCache) throws SQLException {
    final ResultLoaderMap lazyLoader = instantiateResultLoaderMap();
    Object resultObject = createResultObject(rs, resultMap, lazyLoader, null, resultColumnCache);
    if (resultObject != null && !typeHandlerRegistry.hasTypeHandler(resultMap.getType())) {
      final MetaObject metaObject = configuration.newMetaObject(resultObject);
      boolean foundValues = resultMap.getConstructorResultMappings().size() > 0;
      if (shouldApplyAutomaticMappings(resultMap, !AutoMappingBehavior.NONE.equals(configuration.getAutoMappingBehavior()))) {
        final List<String> unmappedColumnNames = resultColumnCache.getUnmappedColumnNames(resultMap, null);
        foundValues = applyAutomaticMappings(rs, unmappedColumnNames, metaObject, null, resultColumnCache) || foundValues;
      }
      final List<String> mappedColumnNames = resultColumnCache.getMappedColumnNames(resultMap, null);
      foundValues = applyPropertyMappings(rs, resultMap, mappedColumnNames, metaObject, lazyLoader, null) || foundValues;
      foundValues = (lazyLoader != null && lazyLoader.size() > 0) || foundValues;
      resultObject = foundValues ? resultObject : null;
      return resultObject;
    }
    return resultObject;
}

根據ResultMap提供的相關引數（返回的型別等），構造一個空的物件，然後根據屬性名到ResultSet中獲取結果，再通過MetaObject給set進物件裡。

具體的取值是通過TypeHandler:

final Object value = typeHandler.getResult(rs, columnName);

每種型別的都對應一個TypeHandler的實現，以Integer型別的為例（IntegerTypeHandler）：

@Override
public Integer getNullableResult(ResultSet rs, String columnName)
  throws SQLException {
    return rs.getInt(columnName);
}

框架就是這樣，底層就是最基本的原理和最簡單的介面，而這些介面通常就是所謂的標準。它所做的事就是解放我們的雙手，把能省的都給省了，讓我們專注於業務程式碼的編寫。

但我們也應該知其所以然。一是出於好奇心，這是程式設計師的本能；二是為了學習其優秀的思想和設計理念，以後可以為我所用，這可稱之為野心吧。

相關推薦

Mybatis原始碼分析（6）—— 從JDBC看Mybatis的設計

Java資料庫連線，（Java Database Connectivity，簡稱JDBC）是Java語言中用來規範客戶端程式如何來訪問資料庫的應用程式介面，提供了諸如查詢和更新資料庫中資料的方法。 六步流程: 載入驅動（5.x驅動包不需要這步了） 建立

Mybatis原始碼分析（3）—— 從Mybatis的視角去看Bean的初始化流程

不涉及Spring完整的啟動流程，僅僅從Mybatis的視角去分析幾個關鍵的方法，找到Mybatis是如何通過這幾個擴充套件點植入進去的，反過來看Spring是如何設計，埋下這些伏筆，實現其可擴充套件性。 springContext-mybatis.xml的配置： <!--

Mybatis 原始碼分析（2）—— 引數處理

Mybatis對引數的處理是值得推敲的，不然在使用的過程中對發生的一系列錯誤直接懵逼了。 以前遇到引數繫結相關的錯誤我就是直接給加@param註解，也稀裡糊塗地解決了，但是後來遇到了一些問題推翻了我的假設：單個引數不需要使用 @param 。由此產生了一個疑問，Mybatis到底是怎

Mybatis 原始碼分析（9）—— 事物管理

Mybatis 提供了事物的頂層介面： public interface Transaction { /** * Retrieve inner database connection * @return DataBase connection * @throw

Mybatis 原始碼分析（8）—— 一二級快取

一級快取 其實關於 Mybatis 的一級快取是比較抽象的，並沒有什麼特別的配置，都是在程式碼中體現出來的。 當呼叫 Configuration 的 newExecutor 方法來建立 executor： public Executor newExecutor(Transac

Mybatis原始碼分析（7）—— 結果集處理

解析封裝 ResultMap 是和結果集相關的東西，最初在解析 XML 的時候，於 parseStatementNode 方法中，針對每一個 select 節點進行解析，轉換為 MappedStatement（類似 Spring 的 bean 配置和 BeanDefinition 的

Mybatis原始碼分析（5）—— 外掛的原理

MyBatis 允許你在已對映語句執行過程中的某一點進行攔截呼叫。 預設情況下，可以使用外掛來攔截的方法呼叫包括： Executor (update, query, flushStatements, commit, rollback, getTransaction, cl

Mybatis原始碼分析（4）—— Mapper的建立和獲取

Mybatis我們一般都是和Spring一起使用的，它們是怎麼融合到一起的，又各自發揮了什麼作用？ 就拿這個Mapper來說，我們定義了一個介面，聲明瞭一個方法，然後對應的xml寫了這個sql語句， 它怎麼就執行成功了？這傢伙是怎麼實現的，帶著這個好奇心，我一步步跟蹤，慢慢揭開了它的

Mybatis原始碼分析（1）—— Mapper檔案解析

感覺CSDN對markdown的支援不夠友好，總是伴隨各種問題，很惱火！ xxMapper.xml的解析主要由XMLMapperBuilder類完成，parse方法來完成解析： public void parse() { if (!configuration.isRes

Glide原始碼分析（二）——從用法來看之load&into方法

上一篇，我們分析了with方法，文章連結： https://blog.csdn.net/qq_36391075/article/details/82833260 在with方法中，進行了Glide的初始化，建立了RequesManger，並且綁定了生命週期，最終返回了一個Reques

Glide原始碼分析（一）從用法來看之with方法

繼續啃原始碼，用過Glide的人，肯定都覺得它好好用，我們一般只需要幾行程式碼，就可以達到我們想要的效果，可以在這個背後是什麼呢？就需要我們來看了。 我一般看原始碼，我喜歡先從用法來看，然後一步一步的再細扣，所以就先從用法來看Glide的整體流程。 用過Glide的人，用下面這段

springcloud feign原始碼分析（6）——關鍵元件！找一找Feign.Client用的是誰以及居然在這裡就跟ribbon關聯了！

分析完了底層的原始碼，就是用各種預設的bean、配置的bean、配置的引數，構造了一個Feign.Builder，接下來就是基於這個Feign.Builder，還得在這個Builder裡放一個Feign.Client進去。。。 如果你在@FeignClient上，沒有配置u

JDK原始碼分析（6）ConcurrentHashMap

JDK版本 ConcurrentHashMap原始碼分析 table：預設為null，初始化發生在第一次插入操作，預設大小為16的陣列，用來儲存Node節點資料，擴容時大小總是2的冪次方。 nextTable：預設為null，擴容時新生成的陣列，其大小為原陣列的兩倍。 sizeC

hbase 原始碼分析（6）get 過程 詳解

上一個章節將getregionLocator的客戶端分析完了，服務端就是一個scan方法，這個等到分析SCAN的時候再做說明。 這一章節將分析GET過程。 **GET過程， 1）找到zk，拿到MATA裡的RegionService地址。 2）訪問第一

HLS學習（七）HLSDownloader原始碼分析（6）下載TS檔案片段

下載TS檔案片段 處理完Master PlayList和Media PlayList之後就可以開始下載TS視訊片段了 下載的流程如下： 1、初始化本地的檔名 2、設定本地檔案的訪問許可權 3、建立任務佇列 4、建立PlayList更新執行緒，因為伺服器上的m3u8檔案

MyBatis原始碼分析（1）-MapConfig檔案的解析

1.簡述    MyBatis是一個優秀的輕ORM框架，由最初的iBatis演化而來，可以方便的完成sql語句的輸入輸出到java物件之間的相互對映，典型的MyBatis使用的方式如下： String resource = "org/mybatis/example/mybatis-config.xml";

libevent原始碼分析（6）－－2.1.8－－建立和釋放libevent控制代碼event_base的相關函式

一、event_base_new 建立預設的event_base ** * Create and return a new event_base to use with the rest of Libevent. * * @return a new event_ba

Kafka原始碼分析（6）

六  其他 1、Producer 首先來看org.apache.kafka.clients.producer中的KafkaProducer類實現，org.apache.kafka開頭的包全部是以java實現的，為使用者提供呼叫kafka元件的功能。該類程式碼如下： pub

mybatis 原始碼分析（一）框架結構概覽

本篇部落格將主要對 mybatis 整體介紹，包括 mybatis 的專案結構，執行的主要流程，初始化流程，API 等各模組進行簡單的串聯，讓你能夠對 mybatis 有一個整體的把握。另外在 mybatis 原始碼的閱讀過程中，如果不想寫 demo 可以直接使用專案中的單元測試； 一、mybatis 結構介

mybatis 原始碼分析（二）mapper 初始化

mybatis 的初始化還是相對比較複雜，但是作者在初始化過程中使用了多種設計模式，包括建造者、動態代理、策略、外觀等，使得程式碼的邏輯仍然非常清晰，這一點非常值得我們學習； 一、mapper 初始化主要流程 mybatis 初始化的過程中，主要是 XML 配置的解析，不同的部分又分別委託給了不同的解析器；