Mybatis 自動對映(使用需謹慎)
什麼是自動對映？
介紹自動對映之前先看一下手動對映，如下：
<resultMap id="orderModelMap1" type="com.javacode2018.chat05.demo7.model.OrderModel">
<id column="id" property="id"/>
<result column="userId" property="userId" />
<result column="createTime" property="createTime" />
<result column="upTime" property="upTime" />
</resultMap>
<select id="getById1" resultMap="orderModelMap1">
<![CDATA[
SELECT
a.id,a.user_id userId,a.create_time createTime,a.up_time upTime
FROM
t_order a
WHERE
a.id = #{value}
]]>
</select>
注意上面的resultMap元素中有4行配置，如下：
<id column="id" property="id"/> <result column="userId" property="userId" /> <result column="createTime" property="createTime" /> <result column="upTime" property="upTime" />
這4行程式碼用於配置sql結果的列和OrderModel物件中欄位的對映關係。
大家有沒有注意到，對映規則中column和property元素的值都是一樣，mybatis中支援自動對映配置，當開啟自動對映之後，當sql的列名和Model中的欄位名稱是一樣的時候（不區分大小寫），mybatis內部會進行自動對映，不需要我們手動去寫上面的4行對映規則。
下面我們將上面的示例改成自動對映的方式，如下：
<resultMap id="orderModelMap2" type="com.javacode2018.chat05.demo7.model.OrderModel" autoMapping="true">
</resultMap>
<select id="getById2" resultMap="orderModelMap2">
<![CDATA[
SELECT
a.id,a.up_time upTime
FROM
t_order a
WHERE
a.id = #{value}
]]>
</select>
注意上面的resultMap中的autoMapping屬性，是否開啟自動對映，我們設定為true，這樣mybatis會自動按照列名和Model中同名的欄位進行對映賦值。
上面兩個配置最後查詢結果是一樣的，都會將查詢結果對應的4個欄位的值自動賦值給OrderModel中同名的屬性。
自動對映開關
mybatis中自動對映主要有2種配置，一種是全域性的配置，對應用中所有的resultMap起效，這個是在mybatis配置檔案中進行設定的；另外一種是通過resultMap的autoMapping屬性進行配置。
mybatis判斷某個resultMap是否開啟自動對映配置的時候，會先查詢自身的autoMapping屬性，如果這個屬性設定值了，就直接用這個屬性的值，如果resultMap元素的autoMapping屬性沒有配置，則走全域性配置的自動對映規則。
下面我們來詳解介紹一下這款的內容。
mybatis自動對映全域性配置
在mybatis全域性配置檔案中加入下面配置：
<settings> <setting name="autoMappingBehavior" value="自動對映規則"/> </settings>
autoMappingBehavior值來源於列舉：org.apache.ibatis.session.AutoMappingBehavior，原始碼：
public enum AutoMappingBehavior {
/**
* Disables auto-mapping.
*/
NONE,/**
* Will only auto-map results with no nested result mappings defined inside.
*/
PARTIAL,/**
* Will auto-map result mappings of any complexity (containing nested or otherwise).
*/
FULL
}
- NONE：關閉全域性對映開關
- PARTIAL：對除在內部定義了巢狀結果對映（也就是連線的屬性）以外的屬性進行對映，這個也是預設值。
- FULL：自動對映所有屬性。
小提示：settings元素中有很多配置，這些配置最後都會被解析成org.apache.ibatis.session.Configuration的屬性，原始碼位於org.apache.ibatis.builder.xml.XMLConfigBuilder#settingsElement方法中。
下面我們來演示一下autoMappingBehavior每種配置的效果。
NONE
mybatis-config.xml加入配置
<settings> <!-- 關閉自動對映開關 --> <setting name="autoMappingBehavior" value="NONE"/> </settings>
OrderMapper.xml
<resultMap id="orderModelMap4" type="com.javacode2018.chat05.demo7.model.OrderModel">
</resultMap>
<select id="getById4" resultMap="orderModelMap4">
<![CDATA[
SELECT
a.id,a.up_time upTime
FROM
t_order a
WHERE
a.id = #{value}
]]>
</select>
OrderMapper.java加入
OrderModel getById4(int id);
測試用例
com.javacode2018.chat05.demo7.Demo7Test#getById4
@Test
public void getById4() throws IOException {
this.before("demo7/mybatis-config1.xml");
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
OrderMapper mapper = sqlSession.getMapper(OrderMapper.class);
OrderModel orderModel = mapper.getById4(2);
log.info("{}",orderModel);
}
}
執行結果
21:58.821 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById4 - ==> Preparing: SELECT a.id,a.up_time upTime FROM t_order a WHERE a.id = ?
21:58.850 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById4 - ==> Parameters: 2(Integer)
21:58.868 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById4 - <== Total: 1
21:58.868 [main] INFO c.j.chat05.demo7.Demo7Test - null
從輸出中可以看到最後一樣輸出結果為null，sql實際上返回的是有結果的，但是結果對映的時候返回的是空。
結果解釋
由於mybatis全域性配置中將autoMappingBehavior的值置為了NONE,表示全域性自動對映被關閉了，而resultMapper中的orderModelMap4沒有配置autoMapping屬性，所以最終這個查詢結果不會自動對映，所以最後查詢結果為null。
PARTIAL
對除在內部定義了巢狀結果對映（也就是連線的屬性）以外的屬性進行對映，這個也是autoMappingBehavior的預設值。
mybatis-config.xml加入配置
<settings> <!-- 對除在內部定義了巢狀結果對映（也就是連線的屬性）以外的屬性進行對映，這個也是autoMappingBehavior的預設值。 --> <setting name="autoMappingBehavior" value="PARTIAL"/> </settings>
OrderMapper.xml
<resultMap id="orderModelMap5" type="com.javacode2018.chat05.demo7.model.OrderModel">
</resultMap>
<select id="getById5" resultMap="orderModelMap5">
<![CDATA[
SELECT
a.id,a.up_time upTime
FROM
t_order a
WHERE
a.id = #{value}
]]>
</select>
OrderMapper.java加入
OrderModel getById5(int id);
測試用例
com.javacode2018.chat05.demo7.Demo7Test#getById5
@Test
public void getById5() throws IOException {
this.before("demo7/mybatis-config2.xml");
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
OrderMapper mapper = sqlSession.getMapper(OrderMapper.class);
OrderModel orderModel = mapper.getById5(2);
log.info("{}",orderModel);
}
}
執行結果
28:32.612 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById5 - ==> Preparing: SELECT a.id,a.up_time upTime FROM t_order a WHERE a.id = ?
28:32.648 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById5 - ==> Parameters: 2(Integer)
28:32.664 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById5 - <== Total: 1
28:32.665 [main] INFO c.j.chat05.demo7.Demo7Test - OrderModel(id=2,userId=1,createTime=1577947790,upTime=1577947790,userModel=null)
OrderModel中的4個屬性被自動對映成功了。
結果解釋
orderModelMap5中沒有指定autoMapping屬性，所以自動對映會走全域性配置的規則，即PARTIAL，會進行自動對映。
我們再來看看PARTIAL的解釋：對除在內部定義了巢狀結果對映（也就是連線的屬性）以外的屬性進行對映。這句話是什麼意思？
有些複雜的查詢對映會在resultMap中巢狀一些對映（如：association，collection），當使用PARTIAL的時候，如果有巢狀對映，則這個巢狀對映不會進行自動映射了。
通過訂單id查詢出訂單以及訂單使用者的資訊，sqlmap如下：
<resultMap id="orderModelMap6" type="com.javacode2018.chat05.demo7.model.OrderModel">
<association property="userModel">
</association>
</resultMap>
<select id="getById6" resultMap="orderModelMap6">
<![CDATA[
SELECT
a.id,a.up_time upTime
b.id as user_id,b.name
FROM
t_order a,t_user b
WHERE
a.user_id = b.id
AND a.id = #{value}
]]>
</select>
OrderModel.java
package com.javacode2018.chat05.demo7.model;
import lombok.*;
import java.util.List;
@Getter
@Setter
@Builder
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class OrderModel {
private Integer id;
private Integer userId;
private Long createTime;
private Long upTime;
private UserModel userModel;
}
內部有個userModel屬性引用使用者物件。
UserModel.java
package com.javacode2018.chat05.demo7.model;
import lombok.*;
@Getter
@Setter
@Builder
@ToString
@NoArgsConstructor
@AllArgsConstructor
public class UserModel {
private Integer id;
private String name;
}
OrderMapper.java中加入
OrderModel getById6(int id);
測試用例
com.javacode2018.chat05.demo7.Demo7Test#getById6
@Test
public void getById6() throws IOException {
this.before("demo7/mybatis-config2.xml");
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
OrderMapper mapper = sqlSession.getMapper(OrderMapper.class);
OrderModel orderModel = mapper.getById6(2);
log.info("{}",orderModel);
}
}
執行輸出
52:49.037 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById6 - ==> Preparing: SELECT a.id,a.up_time upTime,b.id as user_id,b.name FROM t_order a,t_user b WHERE a.user_id = b.id AND a.id = ?
52:49.066 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById6 - ==> Parameters: 2(Integer)
52:49.087 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById6 - <== Total: 1
52:49.088 [main] INFO c.j.chat05.demo7.Demo7Test - null
sql查詢實際上是有一條記錄的，但是最後返回的是null，說明沒有進行自動對映。
FULL
自動對映所有屬性。
這次Mapper我們不動，還是下面這樣，沒有手動指定對映規則。
<resultMap id="orderModelMap6" type="com.javacode2018.chat05.demo7.model.OrderModel">
<association property="userModel">
</association>
</resultMap>
<select id="getById6" resultMap="orderModelMap6">
<![CDATA[
SELECT
a.id,t_user b
WHERE
a.user_id = b.id
AND a.id = #{value}
]]>
</select>
修改一下autoMappingBehavior的值為FULL，看看效果。
mybatis配置
<settings> <!-- 自動對映所有屬性 --> <setting name="autoMappingBehavior" value="FULL"/> </settings>
測試用例
com.javacode2018.chat05.demo7.Demo7Test#getById6_0
@Test
public void getById6_0() throws IOException {
this.before("demo7/mybatis-config3.xml");
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
OrderMapper mapper = sqlSession.getMapper(OrderMapper.class);
OrderModel orderModel = mapper.getById6(2);
log.info("{}",orderModel);
}
}
執行輸出
56:05.127 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById6 - ==> Preparing: SELECT a.id,t_user b WHERE a.user_id = b.id AND a.id = ?
56:05.155 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById6 - ==> Parameters: 2(Integer)
56:05.186 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById6 - <== Total: 1
56:05.186 [main] INFO c.j.chat05.demo7.Demo7Test - OrderModel(id=2,userModel=UserModel(id=2,name=張學友))
輸出中可以看到OrderModel所有屬性都是有值的，userModel的2個屬性也有值，userModel.id是2，我們執行一下sql看看，使用者id是多少，如下：
mysql> SELECT a.id,t_user b WHERE a.user_id = b.id AND a.id = 2; +----+--------+------------+------------+---------+-----------+ | id | userId | createTime | upTime | user_id | name | +----+--------+------------+------------+---------+-----------+ | 2 | 1 | 1577947790 | 1577947790 | 1 | 張學友 | +----+--------+------------+------------+---------+-----------+ 1 row in set (0.00 sec)
user_id實際上是1，mybatis中按照sql欄位和model結果欄位同名進行自動對映，所以將訂單的id賦值給userModel的id屬性了。
此時需要我們orderModelMap6的配置，手動指定一下user_id和userModel.id的對映規則，如下：
<resultMap id="orderModelMap6" type="com.javacode2018.chat05.demo7.model.OrderModel">
<association property="userModel">
<id column="user_id" property="id"/>
</association>
</resultMap>
再次執行測試用例
com.javacode2018.chat05.demo7.Demo7Test#getById6_0
輸出
15:02.751 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById6 - ==> Preparing: SELECT a.id,t_user b WHERE a.user_id = b.id AND a.id = ?
15:02.783 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById6 - ==> Parameters: 2(Integer)
15:02.801 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById6 - <== Total: 1
15:02.801 [main] INFO c.j.chat05.demo7.Demo7Test - OrderModel(id=2,userModel=UserModel(id=1,name=張學友))
這次userModel中的id正確了。
autoMapping使用
上面我們有說過，當在resultMap中指定了autoMapping屬性之後，這個resultMap的自動對映就受autoMapping屬性的控制，和mybatis中全域性對映配置（autoMappingBehavior）行為無關了。
案例1
這個核心配置主要在sqlmap中，如下：
<resultMap id="orderModelMap7" type="com.javacode2018.chat05.demo7.model.OrderModel" autoMapping="true">
<association property="userModel" autoMapping="true">
<id column="user_id" property="id"/>
</association>
</resultMap>
<select id="getById7" resultMap="orderModelMap7">
<![CDATA[
SELECT
a.id,t_user b
WHERE
a.user_id = b.id
AND a.id = #{value}
]]>
</select>
對應測試用例
com.javacode2018.chat05.demo7.Demo7Test#getById7
@Test
public void getById7() throws IOException {
this.before("demo7/mybatis-config1.xml");
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
OrderMapper mapper = sqlSession.getMapper(OrderMapper.class);
OrderModel orderModel = mapper.getById7(2);
log.info("{}",orderModel);
}
}
執行輸出
24:37.544 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById7 - ==> Preparing: SELECT a.id,t_user b WHERE a.user_id = b.id AND a.id = ?
24:37.589 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById7 - ==> Parameters: 2(Integer)
24:37.610 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById7 - <== Total: 1
24:37.610 [main] INFO c.j.chat05.demo7.Demo7Test - OrderModel(id=2,name=張學友))
OrderModel中所有屬性都自動對映成功。
自動裝配並不是那麼好玩，玩不轉可能帶來一些隱患，我們看一個案例，見下面的示例2。
示例2
根據訂單編號，查詢出訂單資訊，順便查詢出訂單明細列表。這個我們使用mybatis中的一對多查詢。
OrderDetaiMapper.xml加入
<select id="getListByOrderId1" resultType="com.javacode2018.chat05.demo7.model.OrderDetailModel">
<![CDATA[
SELECT
a.id,a.order_id AS orderId,a.goods_id AS goodsId,a.num,a.total_price AS totalPrice
FROM
t_order_detail a
WHERE
a.order_id = #{value}
]]>
</select>
這個可以根據訂單的id，查詢出訂單關聯的明細列表。
OrderMapper.xml加入
<resultMap id="orderModelMap8" type="com.javacode2018.chat05.demo7.model.OrderModel" autoMapping="true">
<collection property="orderDetailModelList" select="com.javacode2018.chat05.demo7.mapper.OrderDetailMapper.getListByOrderId1" column="id"/>
</resultMap>
<select id="getById8" resultMap="orderModelMap8">
<![CDATA[
SELECT
a.id,a.up_time upTime
FROM
t_order a
WHERE a.id = #{value}
]]>
</select>
測試用例
com.javacode2018.chat05.demo7.Demo7Test#getById8
@Test
public void getById8() throws IOException {
this.before("demo7/mybatis-config.xml");
try (SqlSession sqlSession = this.sqlSessionFactory.openSession(true);) {
OrderMapper mapper = sqlSession.getMapper(OrderMapper.class);
OrderModel orderModel = mapper.getById8(1);
log.info("{}",orderModel);
}
}
執行輸出
11:06.193 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById8 - ==> Preparing: SELECT a.id,a.up_time upTime FROM t_order a WHERE a.id = ?
11:06.229 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById8 - ==> Parameters: 1(Integer)
11:06.250 [main] DEBUG c.j.c.d.m.O.getListByOrderId1 - ====> Preparing: SELECT a.id,a.total_price AS totalPrice FROM t_order_detail a WHERE a.order_id = ?
11:06.251 [main] DEBUG c.j.c.d.m.O.getListByOrderId1 - ====> Parameters: 1(Integer)
11:06.255 [main] DEBUG c.j.c.d.m.O.getListByOrderId1 - <==== Total: 2
11:06.256 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById8 - <== Total: 1
11:06.256 [main] INFO c.j.chat05.demo7.Demo7Test - OrderModel(id=null,userId=2,userModel=null,orderDetailModelList=[OrderDetailModel(id=1,orderId=1,goodsId=1,num=2,totalPrice=17.76),OrderDetailModel(id=2,num=1,totalPrice=16.66)])
注意輸出中OrderModel的id屬性，怎麼是null值？主要是下面這行配置導致的
<collection property="orderDetailModelList" select="com.javacode2018.chat05.demo7.mapper.OrderDetailMapper.getListByOrderId1" column="id"/>
上面這個配置中有個column屬性，指定的是id，此時mybatis認為你對id欄位手動指定了對映關係，就跳過了對id欄位到OrderModel.id屬性的自動對映，所以導致OrderModel物件的id屬性沒有賦值，此時需要我們在orderModelMap8手動指定id的對映規則，如下：
<resultMap id="orderModelMap8" type="com.javacode2018.chat05.demo7.model.OrderModel" autoMapping="true"> <id column="id" property="id" /> <collection property="orderDetailModelList" select="com.javacode2018.chat05.demo7.mapper.OrderDetailMapper.getListByOrderId1" column="id"/> </resultMap>
再去執行測試用例就正常了。
總結一下
對於咱們開發來說，自動對映確實可以幫助我們節省一些程式碼，不過也存在一些隱患，我們希望自己開發的系統是健壯的，建議大家寫mapper xml的時候，還是花點時間將對映的配置都給寫上去，這樣能夠杜絕一些隱患，使我們的系統更穩定。
到此這篇關於Mybatis 自動對映(使用需謹慎)的文章就介紹到這了,更多相關Mybatis 自動對映內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們！