(八)MyBatis從入門到入土——自動(dòng)映射的使用

這是mybatis系列第8篇。沒(méi)看前文的建議先去【Java冢狐】公眾號(hào)中查看前文，方便理解和掌握。在上一篇中我們介紹了一些mybatis使用查詢的一些方式，特別是一對(duì)一查詢和一對(duì)多查詢進(jìn)行了重點(diǎn)介紹。沒(méi)看的推薦去公眾號(hào)進(jìn)行查看。

今天我們介紹一下我們一直在使用的但是沒(méi)有來(lái)得及做過(guò)多介紹的自動(dòng)映射。

什么是自動(dòng)映射？

介紹自動(dòng)映射之前先看一下手動(dòng)映射，如下：

<resultMap id="orderModelMap1" type="com.zhonghu.chat08.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
        orders 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結(jié)果的列和OrderModel對(duì)象中字段的映射關(guān)系。

大家有沒(méi)有注意到，映射規(guī)則中column和property元素的值都是一樣，mybatis中支持自動(dòng)映射配置，當(dāng)開(kāi)啟自動(dòng)映射之后，當(dāng)sql的列名和Model中的字段名稱是一樣的時(shí)候（不區(qū)分大小寫），mybatis內(nèi)部會(huì)進(jìn)行自動(dòng)映射，不需要我們手動(dòng)去寫上面的4行映射規(guī)則。

下面我們將上面的示例改成自動(dòng)映射的方式，如下：

<resultMap id="orderModelMap2" type="com.zhonghu.chat08.demo7.model.OrderModel" autoMapping="true">
</resultMap>
<select id="getById2" resultMap="orderModelMap2">
    <![CDATA[
    SELECT
        a.id,
        a.user_id userId,
        a.create_time createTime,
        a.up_time upTime
    FROM
        orders a
    WHERE
        a.id = #{value}
    ]]>
</select>

注意上面的resultMap中的autoMapping屬性，是否開(kāi)啟自動(dòng)映射，我們?cè)O(shè)置為true，這樣mybatis會(huì)自動(dòng)按照列名和Model中同名的字段進(jìn)行映射賦值。

上面兩個(gè)配置最后查詢結(jié)果是一樣的，都會(huì)將查詢結(jié)果對(duì)應(yīng)的4個(gè)字段的值自動(dòng)賦值給OrderModel中同名的屬性。

自動(dòng)映射開(kāi)關(guān)

mybatis中自動(dòng)映射主要有2種配置，一種是全局的配置，對(duì)應(yīng)用中所有的resultMap起效，這個(gè)是在mybatis配置文件中進(jìn)行設(shè)置的；另外一種是通過(guò)resultMap的autoMapping屬性進(jìn)行配置。

mybatis判斷某個(gè)resultMap是否開(kāi)啟自動(dòng)映射配置的時(shí)候，會(huì)先查找自身的autoMapping屬性，如果這個(gè)屬性設(shè)置值了，就直接用這個(gè)屬性的值，如果resultMap元素的autoMapping屬性沒(méi)有配置，則走全局配置的自動(dòng)映射規(guī)則。

下面我們來(lái)詳解介紹一下這款的內(nèi)容。

mybatis自動(dòng)映射全局配置

在mybatis全局配置文件中加入下面配置：

<settings>
    <setting name="autoMappingBehavior" value="自動(dòng)映射規(guī)則"/>
</settings>

主要有一下幾種：

  • NONE：關(guān)閉全局映射開(kāi)關(guān)
  • PARTIAL：對(duì)除在內(nèi)部定義了嵌套結(jié)果映射（也就是連接的屬性）以外的屬性進(jìn)行映射，這個(gè)也是默認(rèn)值。
  • FULL：自動(dòng)映射所有屬性。

NONE

當(dāng)mybatis全局配置中將autoMappingBehavior的值置為了NONE,表示全局自動(dòng)映射被關(guān)閉了，會(huì)導(dǎo)致sql實(shí)際上有返回結(jié)果，但是結(jié)果映射的時(shí)候不會(huì)自動(dòng)映射所以返回的時(shí)候是空

PARTIAL

會(huì)進(jìn)行自動(dòng)映射，但是有些復(fù)雜的查詢映射會(huì)在resultMap中嵌套一些映射（如：association，collection），當(dāng)使用PARTIAL的時(shí)候，如果有嵌套映射，則這個(gè)嵌套映射不會(huì)進(jìn)行自動(dòng)映射了。

FULL

自動(dòng)映射所有屬性。

autoMapping使用

上面我們有說(shuō)過(guò)，當(dāng)在resultMap中指定了autoMapping屬性之后，這個(gè)resultMap的自動(dòng)映射就受autoMapping屬性的控制，和mybatis中全局映射配置（autoMappingBehavior）行為無(wú)關(guān)了。

案例1

這個(gè)核心配置主要在sqlmap中，如下：
<resultMap id="orderModelMap7" type="com.zhonghu.chat08.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,
        a.user_id userId,
        a.create_time createTime,
        a.up_time upTime,
        b.id as user_id,
        b.name
    FROM
        orders a,user b
    WHERE
        a.user_id = b.id
        AND a.id = #{value}
    ]]>
</select>
對(duì)應(yīng)測(cè)試用例
com.zhonghu.chat08.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);
    }
}
運(yùn)行輸出
24:37.544 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById7 - ==>  Preparing: SELECT a.id, a.user_id userId, a.create_time createTime, a.up_time upTime, b.id as user_id, b.name FROM orders a,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, userId=1, createTime=1610803573, upTime=1610803573, userModel=UserModel(id=1, name=冢狐))

OrderModel中所有屬性都自動(dòng)映射成功。

自動(dòng)裝配并不是那么好玩，玩不轉(zhuǎn)可能帶來(lái)一些隱患，我們看一個(gè)案例，見(jiàn)下面的示例2。

示例2

根據(jù)訂單編號(hào)，查詢出訂單信息，順便查詢出訂單明細(xì)列表。這個(gè)我們使用mybatis中的一對(duì)多查詢。

OrderDetaiMapper.xml加入
<select id="getListByOrderId1" resultType="com.zhonghu.chat08.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
        order_detail a
    WHERE
        a.order_id = #{value}
    ]]>
</select>

這個(gè)可以根據(jù)訂單的id，查詢出訂單關(guān)聯(lián)的明細(xì)列表。

OrderMapper.xml加入
<resultMap id="orderModelMap8" type="com.zhonghu.chat08.demo7.model.OrderModel" autoMapping="true">
    <collection property="orderDetailModelList" select="com.zhonghu.chat08.demo7.mapper.OrderDetailMapper.getListByOrderId1" column="id"/>
</resultMap>
<select id="getById8" resultMap="orderModelMap8">
    <![CDATA[
    SELECT
        a.id,
        a.user_id userId,
        a.create_time createTime,
        a.up_time upTime
    FROM
        orders a
    WHERE a.id = #{value}
    ]]>
</select>
測(cè)試用例
com.zhonghu.chat08.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);
    }
}
運(yùn)行輸出
11:06.193 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById8 - ==>  Preparing: SELECT a.id, a.user_id userId, a.create_time createTime, a.up_time upTime FROM orders 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.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 = ? 
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, createTime=1610803573, upTime=1610803573, userModel=null, orderDetailModelList=[OrderDetailModel(id=1, orderId=1, goodsId=1, num=2, totalPrice=16.00), OrderDetailModel(id=2, orderId=1, goodsId=1, num=1, totalPrice=16.00)])

注意輸出中OrderModel的id屬性，怎么是null值？主要是下面這行配置導(dǎo)致的

<collection property="orderDetailModelList" select="com.zhonghu.chat08.demo7.mapper.OrderDetailMapper.getListByOrderId1" column="id"/>

上面這個(gè)配置中有個(gè)column屬性，指定的是id，此時(shí)mybatis認(rèn)為你對(duì)id字段手動(dòng)指定了映射關(guān)系，就跳過(guò)了對(duì)id字段到OrderModel.id屬性的自動(dòng)映射，所以導(dǎo)致OrderModel對(duì)象的id屬性沒(méi)有賦值，此時(shí)需要我們?cè)趏rderModelMap8手動(dòng)指定id的映射規(guī)則，如下：

<resultMap id="orderModelMap8" type="com.zhonghu.chat08.demo7.model.OrderModel" autoMapping="true">
    <id column="id" property="id" />
    <collection property="orderDetailModelList" select="com.zhonghu.chat08.demo7.mapper.OrderDetailMapper.getListByOrderId1" column="id"/>
</resultMap>

再去運(yùn)行測(cè)試用例就正常了。

總結(jié)一下

對(duì)于咱們開(kāi)發(fā)來(lái)說(shuō)，自動(dòng)映射確實(shí)可以幫助我們節(jié)省一些代碼，不過(guò)也存在一些隱患，我們希望自己開(kāi)發(fā)的系統(tǒng)是健壯的，建議大家寫mapper xml的時(shí)候，還是花點(diǎn)時(shí)間將映射的配置都給寫上去，這樣能夠杜絕一些隱患，使我們的系統(tǒng)更穩(wěn)定。

最后

  • 如果覺(jué)得看完有收獲，希望能關(guān)注一下，順便給我點(diǎn)個(gè)贊，這將會(huì)是我更新的最大動(dòng)力，感謝各位的支持
  • 歡迎各位關(guān)注我的公眾號(hào)【java冢狐】，專注于java和計(jì)算機(jī)基礎(chǔ)知識(shí)，保證讓你看完有所收獲，不信你打我
  • 求一鍵三連：點(diǎn)贊、轉(zhuǎn)發(fā)、在看。
  • 如果看完有不同的意見(jiàn)或者建議，歡迎多多評(píng)論一起交流。感謝各位的支持以及厚愛(ài)。

——我是冢狐，和你一樣熱愛(ài)編程。

歡迎關(guān)注公眾號(hào)“ Java冢狐”，獲取最新消息

?著作權(quán)歸作者所有,轉(zhuǎn)載或內(nèi)容合作請(qǐng)聯(lián)系作者
【社區(qū)內(nèi)容提示】社區(qū)部分內(nèi)容疑似由AI輔助生成，瀏覽時(shí)請(qǐng)結(jié)合常識(shí)與多方信息審慎甄別。
平臺(tái)聲明：文章內(nèi)容（如有圖片或視頻亦包括在內(nèi)）由作者上傳并發(fā)布，文章內(nèi)容僅代表作者本人觀點(diǎn)，簡(jiǎn)書系信息發(fā)布平臺(tái)，僅提供信息存儲(chǔ)服務(wù)。

相關(guān)閱讀更多精彩內(nèi)容

友情鏈接更多精彩內(nèi)容