Mybatis在轉換Result到需要的Java業務對象時做的三件事,如下:
-
解決了數據庫列名到Java列名的映射。
-
解決了數據庫類型到Java類型的轉換工作。
-
在轉換過程中具備一定的容錯能力。
其實核心就是:
- 數據庫中的列名怎麼和對象中的字段對應起來。
- 數據庫中的列的類型怎麼轉換到合適的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的類路徑。
主要有三種方案
-
駝峯式命名開關,或者不開,數據庫列和字段名全一致。
-
Select時指定AS。
-
resultMap 最穩健。
這篇主要看一下第一種,附上示例和部分源碼走讀。
- 駝峯命名開關。
因爲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,那麼可能會有問題吧,不過仔細想想,誰會吃力不討好幹這種事情,硬要處理成標準的駝峯式命名也可以啦,不過感覺必要性不大。
經過若干次中途崩潰,我終於寫完了駝峯式命名開關下,我們是如何完成數據庫列和字段名的映射的。