目錄

• • ParameterHandler 簡介
  • ParameterHandler 建立
  • ParameterHandler 中的引數從何而來
  • ParameterHandler 解析

MyBatis 四大核心元件我們已經瞭解到了兩種，一個是 Executor ，它是MyBatis 解析SQL請求首先會經過的第一道關卡，它的主要作用在於建立快取，管理 StatementHandler 的呼叫，為 StatementHandler 提供 Configuration 環境等。StatementHandler 元件最主要的作用在於建立 Statement 物件與資料庫進行交流，還會使用 ParameterHandler 進行引數配置，使用 ResultSetHandler 把查詢結果與實體類進行繫結。那麼本篇就來了解一下第三個元件 ParameterHandler。

ParameterHandler 簡介

ParameterHandler 相比於其他的元件就簡單很多了，ParameterHandler 譯為引數處理器，負責為 PreparedStatement 的 sql 語句引數動態賦值，這個介面很簡單隻有兩個方法

/**
 * A parameter handler sets the parameters of the {@code PreparedStatement}
 * 引數處理器為 PreparedStatement 設定引數
 */
public interface ParameterHandler {

  Object getParameterObject();

  void setParameters(PreparedStatement ps)
      throws SQLException;

}
 

ParameterHandler 只有一個實現類 DefaultParameterHandler ， 它實現了這兩個方法。

• getParameterObject： 用於讀取引數
• setParameters: 用於對 PreparedStatement 的引數賦值

ParameterHandler 建立

引數處理器物件是在建立 StatementHandler 物件的同時被建立的，由 Configuration 物件負責建立

BaseStatementHandler.java

protected BaseStatementHandler(Executor executor, MappedStatement mappedStatement, Object parameterObject, RowBounds rowBounds, ResultHandler resultHandler, BoundSql boundSql) {
  this.configuration = mappedStatement.getConfiguration();
  this.executor = executor;
  this.mappedStatement = mappedStatement;
  this.rowBounds = rowBounds;

  this.typeHandlerRegistry = configuration.getTypeHandlerRegistry();
  this.objectFactory = configuration.getObjectFactory();

  if (boundSql == null) { // issue #435, get the key before calculating the statement
    generateKeys(parameterObject);
    boundSql = mappedStatement.getBoundSql(parameterObject);
  }

  this.boundSql = boundSql;

  // 建立引數處理器
  this.parameterHandler = configuration.newParameterHandler(mappedStatement, parameterObject, boundSql);
  // 建立結果對映器
  this.resultSetHandler = configuration.newResultSetHandler(executor, mappedStatement, rowBounds, parameterHandler, resultHandler, boundSql);
}
 

在建立 ParameterHandler 時，需要傳入SQL的mappedStatement 物件，讀取的引數和SQL語句

注意：一個 BoundSql 物件，就代表了一次sql語句的實際執行，而 SqlSource 物件的責任，就是根據傳入的引數物件，動態計算這個 BoundSql， 也就是 Mapper 檔案中節點的計算，是由 SqlSource 完成的，SqlSource 最常用的實現類是 DynamicSqlSource

Configuration.java

public ParameterHandler newParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
  // 建立ParameterHandler
  ParameterHandler parameterHandler = mappedStatement.getLang().createParameterHandler(mappedStatement, parameterObject, boundSql);
  parameterHandler = (ParameterHandler) interceptorChain.pluginAll(parameterHandler);
  return parameterHandler;
}

上面是 Configuration 建立 ParameterHandler 的過程，它實際上是交由 LanguageDriver 來建立具體的引數處理器，LanguageDriver 預設的實現類是 XMLLanguageDriver，由它呼叫 DefaultParameterHandler 中的構造方法完成 ParameterHandler 的建立工作

public ParameterHandler createParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
  return new DefaultParameterHandler(mappedStatement, parameterObject, boundSql);
}

public DefaultParameterHandler(MappedStatement mappedStatement, Object parameterObject, BoundSql boundSql) {
  this.mappedStatement = mappedStatement;
  this.configuration = mappedStatement.getConfiguration();
  // 獲取 TypeHandlerRegistry 註冊
  this.typeHandlerRegistry = mappedStatement.getConfiguration().getTypeHandlerRegistry();
  this.parameterObject = parameterObject;
  this.boundSql = boundSql;
}

上面的流程是建立 ParameterHandler 的過程，建立完成之後，該進行具體的解析工作，那麼 ParameterHandler 如何解析SQL中的引數呢？SQL中的引數從哪裡來的？

ParameterHandler 中的引數從何而來

你可能知道 Parameter 中的引數是怎麼來的，無非就是從 Mapper 配置檔案中對映過去的啊，就比如如下例子

引數肯定就是圖中標紅的 1 ，然後再傳到XML對應的 SQL 語句中，用 #{} 或者 ${} 來進行賦值啊，

嗯，你講的沒錯，可是你知道這個引數是如何對映過來的嗎？或者說你知道 Parameter 的解析過程嗎？或許你不是很清晰了，我們下面就來探討一下 ParameterHandler 對引數的解析，這其中涉及到 MyBatis 中的動態代理模式

在MyBatis 中，當 deptDao.findByDeptNo(1) 將要執行的時候，會被 JVM 進行攔截，交給 MyBatis 中的代理實現類 MapperProxy 的 invoke 方法中，這也是執行 SQL 語句的主流程。

然後交給 Executor 、StatementHandler進行對應的引數解析和執行，因為是帶引數的 SQL 語句，最終會建立 PreparedStatement 物件並建立引數解析器進行引數解析

SimpleExecutor.java

handler.parameterize(stmt) 最終會呼叫到 DefaultParameterHandler 中的 setParameters 方法，我在原始碼上做了註釋，為了方便拷貝，我沒有采用截圖的形式

public void setParameters(PreparedStatement ps) {
  ErrorContext.instance().activity("setting parameters").object(mappedStatement.getParameterMap().getId());
  // parameterMappings 就是對 #{} 或者 ${} 裡面引數的封裝
  List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
  if (parameterMappings != null) {
    // 如果是引數化的SQL，便需要迴圈取出並設定引數的值
    for (int i = 0; i < parameterMappings.size(); i++) {
      ParameterMapping parameterMapping = parameterMappings.get(i);
      // 如果引數型別不是 OUT ，這個型別與 CallableStatementHandler 有關
      // 因為儲存過程不存在輸出引數，所以引數不是輸出引數的時候，就需要設定。
      if (parameterMapping.getMode() != ParameterMode.OUT) {
        Object value;
        // 得到#{}  中的屬性名
        String propertyName = parameterMapping.getProperty();
        // 如果 propertyName 是 Map 中的key
        if (boundSql.hasAdditionalParameter(propertyName)) { // issue #448 ask first for additional params
          // 通過key 來得到 additionalParameter 中的value值
          value = boundSql.getAdditionalParameter(propertyName);
        }
        // 如果不是 additionalParameters 中的key，而且傳入引數是 null， 則value 就是null
        else if (parameterObject == null) {
          value = null;
        }
        // 如果 typeHandlerRegistry 中已經註冊了這個引數的 Class物件，即它是Primitive 或者是String 的話
        else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
          value = parameterObject;
        } else {
          // 否則就是 Map
          MetaObject metaObject = configuration.newMetaObject(parameterObject);
          value = metaObject.getValue(propertyName);
        }
        // 在通過SqlSource 的parse 方法得到parameterMappings 的具體實現中，我們會得到parameterMappings的typeHandler
        TypeHandler typeHandler = parameterMapping.getTypeHandler();
        // 獲取typeHandler 的jdbc type
        JdbcType jdbcType = parameterMapping.getJdbcType();
        if (value == null && jdbcType == null) {
          jdbcType = configuration.getJdbcTypeForNull();
        }
        try {
          typeHandler.setParameter(ps, i + 1, value, jdbcType);
        } catch (TypeException e) {
          throw new TypeException("Could not set parameters for mapping: " + parameterMapping + ". Cause: " + e, e);
        } catch (SQLException e) {
          throw new TypeException("Could not set parameters for mapping: " + parameterMapping + ". Cause: " + e, e);
        }
      }
    }
  }
}

ParameterHandler 解析

我們在 MyBatis 核心配置綜述之 StatementHandler 一文中瞭解到 Executor 管理的是 StatementHandler 物件的建立以及引數賦值，那麼我們的主要入口還是 Executor 執行器

下面用一個流程圖表示一下 ParameterHandler 的解析過程，以簡單執行器為例

像是 doQuery,doUpdate,doQueryCursor等方法都會先呼叫到

// 生成 preparedStatement 並呼叫 prepare 方法，併為引數賦值
private Statement prepareStatement(StatementHandler handler, Log statementLog) throws SQLException {
  Statement stmt;
  Connection connection = getConnection(statementLog);
  stmt = handler.prepare(connection, transaction.getTimeout());
  handler.parameterize(stmt);
  return stmt;
}

然後在生成 preparedStatement 呼叫DefaultParameterHandler進行引數賦值。

公眾號提供 優質Java資料 以及CSDN免費下載 許可權，歡迎你關注我

相關推薦