2. 程式人生 > >Mybatis 原始碼分析（2）—— 引數處理

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

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

Mybatis對引數的處理是值得推敲的，不然在使用的過程中對發生的一系列錯誤直接懵逼了。

以前遇到引數繫結相關的錯誤我就是直接給加@param註解，也稀裡糊塗地解決了，但是後來遇到了一些問題推翻了我的假設：單個引數不需要使用 @param 。由此產生了一個疑問，Mybatis到底是怎麼處理引數的？

幾種常見的情景：

  • 單個引數
    • 不使用註解，基於${}和#{}的引用，基本型別和自定義物件都可以
    • 不使用註解，基於foreach標籤的使用，list和array不可以
    • 不使用註解，基於if標籤的判斷，基本型別 boolean 也報錯

初步封裝

第一次處理是在MapperMethod中：

private Object getParam(Object[] args) {
    final int paramCount = paramPositions.size();
    if (args == null || paramCount == 0) {
      return null;
    } else if (!hasNamedParameters && paramCount == 1) {
      return args[paramPositions.get(0)];
    } else
 
 {
      Map<String, Object> param = new MapperParamMap<Object>();
      for (int i = 0; i < paramCount; i++) {
        param.put(paramNames.get(i), args[paramPositions.get(i)]);
      }
      // issue #71, add param names as param1, param2...but ensure backward compatibility
      for (int
 
 i = 0; i < paramCount; i++) {
        String genericParamName = "param" + String.valueOf(i + 1);
        if (!param.containsKey(genericParamName)) {
          param.put(genericParamName, args[paramPositions.get(i)]);
        }
      }
      return param;
    }
}

這裡會有三種可能：null，object[]，MapperParamMap，第三種可以構造出我們常見的param1、parm2……

AuthAdminUser findAuthAdminUserByUserId(@Param(“userId”) String userId);

當我們在Mapper介面中如此定義時，就會走上面的else程式碼塊，MapperParamMap將包含兩個元素，一個key為userId，另一個為param1。

第二次處理是在DefaultSqlSession中，呼叫executor的query方法時，將引數包裝成集合：

  private Object wrapCollection(final Object object) {
    if (object instanceof List) {
      StrictMap<Object> map = new StrictMap<Object>();
      map.put("list", object);
      return map;
    } else if (object != null && object.getClass().isArray()) {
      StrictMap<Object> map = new StrictMap<Object>();
      map.put("array", object);
      return map;
    }
    return object;
  }

這個時候會將其他兩種型別（list或array）也轉換為map集合，MapperParamMap和StrictMap都繼承了HashMap，只是將super.containsKey(key)為false的時候丟擲了一個異常。

例項呈現

當我們寫Mapper介面時，一個引數通常也不使用@param註解。

如果這個引數是 List 型別呢？

List<String> selectFeeItemTypeNameByIds(List<Integer> itemIds);

對應的mapper配置檔案：

<select id="selectFeeItemTypeNameByIds" parameterType="java.util.List" resultType="java.lang.String">
    SELECT fee_item_type_name
    FROM tb_uhome_fee_item_type
    WHERE fee_item_type_id IN
    <foreach collection="itemIds" item="itemId" open="(" close=")" separator="," >
        #{itemId}
    </foreach>
</select>

測試一下，直接報錯：

nested exception is org.apache.ibatis.binding.BindingException: Parameter ‘itemIds’ not found. Available parameters are [list]

然後把itemIds替換為list就好了：

<foreach collection="list" item="itemId" open="(" close=")" separator="," >
    #{itemId}
</foreach>

這個正是驗證了上述原始碼中的操作，在DefaultSqlSession的wrapCollection方法中：

if (object instanceof List) {
  StrictMap<Object> map = new StrictMap<Object>();
  map.put("list", object);
  return map;
}

如果這個引數用在 if 標籤中呢？

List<Map<String, Object>> selectPayMethodListByPlatform(boolean excludeInner);

xml中這樣使用：

<select id="selectPayMethodListByPlatform" resultType="java.util.HashMap" parameterType="boolean">
    select a.`NAME`as payMethodName, a.`VALUE` as payMethod
    from tb_fcs_dictionary a
    where a.`CODE` = 'PAY_METHOD'
    and a.`STATUS` = 1
    and a.TYPE = 'PLATFORM'
    <if test="excludeInner">
        and a.value not in (14,98)
    </if>
</select>

直接報如下錯誤：

There is no getter for property named ‘excludeInner’ in ‘class java.lang.Boolean’

跟蹤下DynamicContext的內部類ContextAccessor的getProperty方法：
image

那我們加上註解@Param(“excludeInner”) 再看看：
image

沒有使用註解，儲存的就是一個Boolean型別的值，返回null。使用了註解，這個值有名稱且存放在MapperParamMap中，直接可以根據名稱取到。

檢視呼叫棧

在ForEachSqlNode中會呼叫ExpressionEvaluator的evaluateIterable方法來獲取迭代器物件：

public Iterable<?> evaluateIterable(String expression, Object parameterObject) {
    try {
      Object value = OgnlCache.getValue(expression, parameterObject);
      if (value == null) throw new SqlMapperException("The expression '" + expression + "' evaluated to a null value.");
      if (value instanceof Iterable) return (Iterable<?>) value;
      if (value.getClass().isArray()) {
          // the array may be primitive, so Arrays.asList() may throw 
          // a ClassCastException (issue 209).  Do the work manually
          // Curse primitives! :) (JGB)
          int size = Array.getLength(value);
          List<Object> answer = new ArrayList<Object>();
          for (int i = 0; i < size; i++) {
              Object o = Array.get(value, i);
              answer.add(o);
          }

          return answer;
      }
      throw new BuilderException("Error evaluating expression '" + expression + "'.  Return value (" + value + ") was not iterable.");
    } catch (OgnlException e) {
      throw new BuilderException("Error evaluating expression '" + expression + "'. Cause: " + e, e);
    }
}

IfSqlNode中也會呼叫ExpressionEvaluator的evaluateBoolean方法來檢測表示式正確與否：

public boolean evaluateBoolean(String expression, Object parameterObject) {
    try {
      Object value = OgnlCache.getValue(expression, parameterObject);
      if (value instanceof Boolean) return (Boolean) value;
      if (value instanceof Number) return !new BigDecimal(String.valueOf(value)).equals(BigDecimal.ZERO);
      return value != null;
    } catch (OgnlException e) {
      throw new BuilderException("Error evaluating expression '" + expression + "'. Cause: " + e, e);
    }
}

兩者都會使用Ognl來獲取表示式的值：

Object value = OgnlCache.getValue(expression, parameterObject);

實際處理

在DynamicSqlSource的getBoundSql方法中：

  • 引數繫結
    DynamicContext context = new DynamicContext(configuration, parameterObject); 
  public DynamicContext(Configuration configuration, Object parameterObject) {
    if (parameterObject != null && !(parameterObject instanceof Map)) {
      MetaObject metaObject = configuration.newMetaObject(parameterObject);
      bindings = new ContextMap(metaObject);
    } else {
      bindings = new ContextMap(null);
    }
    bindings.put(PARAMETER_OBJECT_KEY, parameterObject);
    bindings.put(DATABASE_ID_KEY, configuration.getDatabaseId());
  }
  • Node逐級處理（各種標籤和${}的處理）

rootSqlNode.apply(context);

這個就是處理動態sql的關鍵，將if、choose和foreach等剝離出來，使用ognl的表示式來獲取相關屬性的值，例如上面提到的foreach和if標籤。

然後將其轉換成簡單的text，在TextSqlNode中最終處理${param}，將其替換為實際引數值。

替換方式如下：

public String handleToken(String content) {
  try {
    Object parameter = context.getBindings().get("_parameter");
    if (parameter == null) {
      context.getBindings().put("value", null);
    } else if (SimpleTypeRegistry.isSimpleType(parameter.getClass())) {
      context.getBindings().put("value", parameter);
    }
    Object value = OgnlCache.getValue(content, context.getBindings());
    return (value == null ? "" : String.valueOf(value)); // issue #274 return "" instead of "null"
  } catch (OgnlException e) {
    throw new BuilderException("Error evaluating expression '" + content + "'. Cause: " + e, e);
  }
}
  • 引數解析（#{}的處理）

SqlSource sqlSource = sqlSourceParser.parse(context.getSql(), parameterType);

SqlSourceBuilder#parse:

public SqlSource parse(String originalSql, Class<?> parameterType) {
    ParameterMappingTokenHandler handler = new ParameterMappingTokenHandler(configuration, parameterType);
    GenericTokenParser parser = new GenericTokenParser("#{", "}", handler);
    String sql = parser.parse(originalSql);
    return new StaticSqlSource(configuration, sql, handler.getParameterMappings());
}

GenericTokenParser的parse方法將#{xx}替換為 ? ，如下面的sql語句：

SELECT DISTINCT
    A.ORGAN_ID as organId,
    CONCAT(A. NAME, ' [', IFNULL(A.PY_NAME, ''), ']') as organName
FROM
    ORGAN A,
    ORGAN_REL B,
    V_USER_ORGAN C
WHERE
    A.ORGAN_ID = B.ORGAN_ID
AND B.ORGAN_CODE LIKE CONCAT(LEFT(C.ORGAN_CODE, 8), '%')
AND B.PAR_ID = 1
AND A.STATUS = 1
AND C.USER_ID = #{userId}

替換後為：

SELECT DISTINCT
    A.ORGAN_ID as organId,
    CONCAT(A. NAME, ' [', IFNULL(A.PY_NAME, ''), ']') as organName
FROM
    ORGAN A,
    ORGAN_REL B,
    V_USER_ORGAN C
WHERE
    A.ORGAN_ID = B.ORGAN_ID
AND B.ORGAN_CODE LIKE CONCAT(LEFT(C.ORGAN_CODE, 8), '%')
AND B.PAR_ID = 1
AND A.STATUS = 1
AND C.USER_ID = ?

然後構造一個StaticSqlSource：

new StaticSqlSource(configuration, sql, handler.getParameterMappings());

這個就跟我們直接使用JDBC一樣，使用?作為佔位符。

最終在DefaultParameterHandler中給設定進引數：

public void setParameters(PreparedStatement ps)
      throws SQLException {
    ErrorContext.instance().activity("setting parameters").object(mappedStatement.getParameterMap().getId());
    List<ParameterMapping> parameterMappings = boundSql.getParameterMappings();
    if (parameterMappings != null) {
      MetaObject metaObject = parameterObject == null ? null : configuration.newMetaObject(parameterObject);
      for (int i = 0; i < parameterMappings.size(); i++) {
        ParameterMapping parameterMapping = parameterMappings.get(i);
        if (parameterMapping.getMode() != ParameterMode.OUT) {
          Object value;
          String propertyName = parameterMapping.getProperty();
          PropertyTokenizer prop = new PropertyTokenizer(propertyName);
          if (parameterObject == null) {
            value = null;
          } else if (typeHandlerRegistry.hasTypeHandler(parameterObject.getClass())) {
            value = parameterObject;
          } else if (boundSql.hasAdditionalParameter(propertyName)) {
            value = boundSql.getAdditionalParameter(propertyName);
          } else if (propertyName.startsWith(ForEachSqlNode.ITEM_PREFIX)
              && boundSql.hasAdditionalParameter(prop.getName())) {
            value = boundSql.getAdditionalParameter(prop.getName());
            if (value != null) {
              value = configuration.newMetaObject(value).getValue(propertyName.substring(prop.getName().length()));
            }
          } else {
            value = metaObject == null ? null : metaObject.getValue(propertyName);
          }
          TypeHandler typeHandler = parameterMapping.getTypeHandler();
          if (typeHandler == null) {
            throw new ExecutorException("There was no TypeHandler found for parameter " + propertyName + " of statement " + mappedStatement.getId());
          }
          JdbcType jdbcType = parameterMapping.getJdbcType();
          if (value == null && jdbcType == null) jdbcType = configuration.getJdbcTypeForNull();
          typeHandler.setParameter(ps, i + 1, value, jdbcType);
        }
      }
    }
  }

這裡分為五種情況（高版本合併了第三和第四種）：

  • parameterObject為null，value直接為null
  • parameterObject型別為typeHandlerRegistry中匹配型別value直接賦值為parameterObject
  • 引數是動態引數，通過動態引數取值
  • 引數是動態引數而且是foreach中的（字首為frch），也是通過動態引數取值
  • 複雜物件或者map型別，通過反射取值

總結

像 if 和 foreach 這種標籤都是直接通過Ognl來取值。

“${}” 的處理在TextSqlNode中，使用OGNL方式取值，當場替換為實際引數值。

“#{}” 的處理在SqlSourceBuilder的parse中，使用佔位符（?）替換，最後在設定引數的時候使用Mybatis的MetaObject取值。

當我們使用單個引數未用註解時：
- 用在形如foreach和if的標籤中（針對上面兩個例項）

List<String> selectFeeItemTypeNameByIds(List<Integer> itemIds);

List<Map<String, Object>> selectPayMethodListByPlatform(boolean excludeInner);

MapperMethod的getParam方法將返回這兩個引數本身。

DefaultSqlSession的wrapCollection方法將把list放到一個key為 “list”的map中，boolean型別的還是返回本身。

這樣在DynamicSqlSource的getBoundSql方法中構造DynamicContext時：

public DynamicContext(Configuration configuration, Object parameterObject) {
    if (parameterObject != null && !(parameterObject instanceof Map)) {
      MetaObject metaObject = configuration.newMetaObject(parameterObject);
      bindings = new ContextMap(metaObject);
    } else {
      bindings = new ContextMap(null);
    }
    bindings.put(PARAMETER_OBJECT_KEY, parameterObject);
    bindings.put(DATABASE_ID_KEY, configuration.getDatabaseId());
}

list型別的由於被包裝了一下，將走else。而boolean型別直接建立一個包含metaObject的ContextMap。

不管怎樣，“itemIds”走到這裡已經丟了，後面解析表示式的時候根據這個名字是肯定拿不到的。

而boolean型別的 “excludeInner” 將在ContextMap中如此出現（僅僅有個值key卻為“_parameter”）：

key: "_parameter"  value: true
key: "_databaseId"  value: "MySQL"

不過它持有的MetaObject型別的parameterMetaObject物件卻不為null。

看下ContextMap中的重寫的get方法：

public Object get(Object key) {
      String strKey = (String) key;
      if (super.containsKey(strKey)) {
        return super.get(strKey);
      }

      if (parameterMetaObject != null) {
        Object object = parameterMetaObject.getValue(strKey);
        if (object != null) {
          super.put(strKey, object);
        }

        return object;
      }

      return null;
}

當父類中沒有時（這個肯定沒有），它將去parameterMetaObject中拿，這一拿就拿出問題來了：

There is no getter for property named ‘excludeInner’ in ‘class java.lang.Boolean’

一路跟到MetaObject的getValue方法，又到BeanWrapper的get方法，然後就把它當做一個普通的物件，用反射去調它的get方法：

private Object getBeanProperty(PropertyTokenizer prop, Object object) {
    try {
      Invoker method = metaClass.getGetInvoker(prop.getName());
      try {
        return method.invoke(object, NO_ARGUMENTS);
      } catch (Throwable t) {
        throw ExceptionUtil.unwrapThrowable(t);
      }
    } catch (RuntimeException e) {
      // 進了這個執行時異常：說它沒的get方法，哈哈
      throw e;
    } catch (Throwable t) {
      throw new ReflectionException("Could not get property '" + prop.getName() + "' from " + object.getClass() + ".  Cause: " + t.toString(), t);
    }
}

這個excludeInner本來就是一個boolean型別的引數，哪有什麼get方法，能調到才怪！

針對上面兩個例項的分析就結束了，從這裡也大致知道了Mybatis是如何處理引數的。總的來說，不管一個引數還是幾個引數，加@param註解是沒錯的！加了就會給你統統放map裡，然後到ContextMap中取整個map，由於是map型別，將繼續到map裡取具體的物件。

從這裡可以看出來，如果我們在介面中宣告時就只用一個map來裝所有引數，key為引數名，value為引數值，然後不使用註解，效果也是一樣的。

有問題歡迎討論，可以留言也可以加本人QQ: 646653132

關於引數繫結的詳細解讀：http://blog.csdn.net/isea533/article/details/44002219

相關推薦

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

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

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

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

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原始碼分析（6）—— 從JDBC看Mybatis的設計

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

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

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

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

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

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

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

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

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

PackageManagerService 原始碼分析（2）

  一.scanPackageLI PKMS 中呼叫scanDirLI來分析APK 檔案，如果目錄下的是apk檔案或者是目錄，會繼續呼叫scanPackageLI函式： private PackageParser.Package scanPackageLI(File s

Android進階3：Activity原始碼分析（2） —— Activity啟動和銷燬流程（8.0）

上篇文章講述了app從啟動建立Activity呼叫onCreate，onStart, onResume方法，這篇文章講述一下Activity啟動的另一個切入點：startActivity方法，啟動Activity。 通過上一篇文章，我們總結一下： 1：A

tensorflowV1.11-原始碼分析（2）

通過前面的run_shell函式，執行python指令碼，並返回python庫的路徑。 def get_python_path(environ_cp, python_bin_path): """Get the python site package paths.""" python_paths = [

Django rest framework原始碼分析（2）----許可權

目錄 新增許可權 （1）API/utils資料夾下新建premission.py檔案，程式碼如下： message是當沒有許可權時，提示的資訊 # utils/permission.py class SVIPPremission(object): message =

【原創】docker原始碼分析（2）---docker server

上一節，分析了Engine和job。那這一節就開始講下docker server。 1、docker server 1.1 主體流程 我們從main函式開始，看看docker server

Android init原始碼分析（2）init.rc解析

action_for_each_trigger("early-init", action_add_queue_tail); queue_builtin_action(wait_for_coldboot_done_action, "wait_for_coldboot_done"); q

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

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

nginx原始碼分析（7）——請求處理

        在建立連線過程中，對於nginx監聽到的每個客戶端連線，都會將它的讀事件的handler設定為ngx_http_init_request函式，這個函式就是請求處理的入口。在處理請求時，主要就是要解析http請求，比如：uri，請求行等，然後再根據請求生成響應

HDFS原始碼分析（2）----HDFS原始碼結構

BlockPlacementPolicy.java----抽象類：這個介面用於選擇放置塊副本的目標磁碟的所需的數目； BlockPlacementPolicyDefault.java----繼承實現類：這個類實現了選擇放置塊副本的目標磁碟的所需的數目； BlockPlacementPolicyWithNode

Hadoop原始碼分析（2）————MapReduce之MapTask

MapTask（Hadoop2.7.3） MapTask.java繼承於Task，是hadoop中Map節點主要所做的主要流程。 一般被jvmtask初始化或者在MapTaskAttemptImpl被初始化。其主要流程寫在run()方法中。 run()方法

U-Boot啟動過程原始碼分析（2）-第二階段

先總述：第一階段cpu/arm920t/start.S和board/smdk2410/lowlevel_init.S進行初始化，再跳到第二階段的入口點lib_arm/board.c中的start_armboot函式。 第二階段start_armboot函式需