【Mybatis系列】從原始碼角度理解Mybatis欄位對映-駝峰式命名

凱倫說_美團點評發表於2019-03-02
MyBatis原始碼

Mybatis在轉換Result到需要的Java業務物件時做的三件事，如下:

  1. 解決了資料庫列名到Java列名的對映。

  2. 解決了資料庫型別到Java型別的轉換工作。

  3. 在轉換過程中具備一定的容錯能力。

其實核心就是：

  1. 資料庫中的列名怎麼和物件中的欄位對應起來。
  2. 資料庫中的列的型別怎麼轉換到合適的Java型別，不引起轉換失敗。

今天我們先來看第一點，資料庫中的列名怎麼和物件中的欄位對應起來。首先是日常PO(Persistant Object) CityPO,裡面有五個欄位。

public class CityPO {
    Integer id;
    Long cityId;
    String cityName;
    String cityEnName;
    String cityPyName;複製程式碼

本次要查詢的資料庫中的列名如下所示。

mysql> mysql> desc SU_City;
+--------------+-------------+------+-----+-------------------+-----------------------------+
| Field        | Type        | Null | Key | Default           | Extra                       |
+--------------+-------------+------+-----+-------------------+-----------------------------+
| id           | int(11)     | NO   | PRI | NULL              | auto_increment              |
| city_id      | int(11)     | NO   | UNI | NULL              |                             |
| city_name    | varchar(20) | NO   |     |                   |                             |
| city_en_name | varchar(20) | NO   |     |                   |                             |
| city_py_name | varchar(50) | NO   |     |                   |                             |
| create_time  | datetime    | NO   |     | CURRENT_TIMESTAMP |                             |
| updatetime   | datetime    | NO   | MUL | CURRENT_TIMESTAMP | on update CURRENT_TIMESTAMP |
+--------------+-------------+------+-----+-------------------+-----------------------------+
7 rows in set (0.01 sec)複製程式碼

我們是按照駝峰式命名，把資料庫中的列名對應到了物件的欄位名。如下是Mybatis的介面類和對映檔案。

public interface CityMapper {

    CityPO selectCity(int id);
}複製程式碼
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="mapper.CityMapper">
    <select id="selectCity" resultType="po.CityPO">
        select id,city_id,city_name,city_en_name from SU_City where id = #{id}
    </select>
</mapper>複製程式碼

在上面的對映檔案中，namespace指定了這個介面類的全限定類名，緊隨其後的select代表是select語句，id是介面類中函式的名字，resultType代表了從這條語句中返回的期望型別的類的完全限定名或別名，在此例子中是我們的業務物件CityPO的類路徑。

主要有三種方案

  1. 駝峰式命名開關，或者不開，資料庫列和欄位名全一致。

  2. Select時指定AS。

  3. resultMap 最穩健。

這篇主要看一下第一種，附上示例和部分原始碼走讀。

  1. 駝峰命名開關。
    因為CityPO的列名是完全根據資料庫列名駝峰式命名後得到的，因此Mybatis提供了一個配置項。開啟開配置項後，在匹配時，能夠根據資料庫列名找到對應對應的駝峰式命名後的欄位。
<settings>
    <!-- 開啟駝峰，開啟後，只要資料庫欄位和物件屬性名字母相同，無論中間加多少下劃線都可以識別 -->
    <setting name="mapUnderscoreToCamelCase" value="true" />
</settings>複製程式碼

我們從原始碼角度解讀一下，Mybat處理ResultSet的對映預設都在DefaultResultSetHandler中完成。
處理行資料的時候的時候主要在下面?的函式裡進行，由於我們在對映檔案中沒有定義額外的ResultMap，因此會直接進入else分支的程式碼。

public void handleRowValues(ResultSetWrapper rsw, ResultMap resultMap, ResultHandler<?> resultHandler, RowBounds rowBounds, ResultMapping parentMapping) throws SQLException {
    if (resultMap.hasNestedResultMaps()) {
      ensureNoRowBounds();
      checkResultHandler();
      handleRowValuesForNestedResultMap(rsw, resultMap, resultHandler, rowBounds, parentMapping);
    } else {
      handleRowValuesForSimpleResultMap(rsw, resultMap, resultHandler, rowBounds, parentMapping);
    }
}複製程式碼

進入handleRowValuesForSimpleResultMap中，主要處理函式如下，在這裡完成了物件的生成及賦值。

Object rowValue = getRowValue(rsw, discriminatedResultMap);複製程式碼

在這裡先建立了物件的例項，然後獲取了物件的元資訊，為反射賦值做準備。

private Object getRowValue(ResultSetWrapper rsw, ResultMap resultMap) throws SQLException {
    final ResultLoaderMap lazyLoader = new ResultLoaderMap();
    Object rowValue = createResultObject(rsw, resultMap, lazyLoader, null);
    if (rowValue != null && !hasTypeHandlerForResultObject(rsw, resultMap.getType())) {
      final MetaObject metaObject = configuration.newMetaObject(rowValue);
      boolean foundValues = this.useConstructorMappings;
      if (shouldApplyAutomaticMappings(resultMap, false)) {
        foundValues = applyAutomaticMappings(rsw, resultMap, metaObject, null) || foundValues;
      }
      foundValues = applyPropertyMappings(rsw, resultMap, metaObject, lazyLoader, null) || foundValues;
      foundValues = lazyLoader.size() > 0 || foundValues;
      rowValue = (foundValues || configuration.isReturnInstanceForEmptyRow()) ? rowValue : null;
    }
    return rowValue;
  }複製程式碼

在applyAutomaticMappings完成了整個過程，我們進去探一探。

就是下面這個函式建立好了對映關係，這個函式的下半部分是完成賦值的，對映的部分下次會詳細分析。

List<UnMappedColumnAutoMapping> autoMapping = createAutomaticMappings(rsw, resultMap, metaObject, columnPrefix);複製程式碼

在這個方法裡，上半部分是生成了資料庫的列名，在這個函式中找到了對應的欄位名。

final String property = metaObject.findProperty(propertyName, configuration.isMapUnderscoreToCamelCase());複製程式碼

我們進去看一看，它傳進了生成好的資料庫列名，傳進了前面提到的是否根據駝峰式命名對映開關的值。

事實證明，真的很簡單，往下看，就是把下劃線都去了。

public String findProperty(String name, boolean useCamelCaseMapping) {
    if (useCamelCaseMapping) {
      name = name.replace("_", "");
    }
    return findProperty(name);
  }複製程式碼

隱隱覺得是不是大小寫不敏感啊，繼續往下看，這裡返回找到的欄位名。

 private StringBuilder buildProperty(String name, StringBuilder builder) {
      ..........
      String propertyName = reflector.findPropertyName(name);
      if (propertyName != null) {
        builder.append(propertyName);
      }
    }
    return builder;
  }複製程式碼

好了，真相大白，就是大小寫不敏感的。

public String findPropertyName(String name) {
    return caseInsensitivePropertyMap.get(name.toUpperCase(Locale.ENGLISH));
}複製程式碼

所以如果你資料庫裡欄位是city_id,city_Id,大寫I，那麼可能會有問題吧，不過仔細想想，誰會吃力不討好乾這種事情，硬要處理成標準的駝峰式命名也可以啦，不過感覺必要性不大。

經過若干次中途崩潰，我終於寫完了駝峰式命名開關下，我們是如何完成資料庫列和欄位名的對映的。後面的博文會繼續看看後續兩種方案以及DDL時物件欄位是如何賦值到Sql語句中。

相關文章