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

時間  2021-02-20
標籤 java sql 編程 mybatis app 測試 this code xml 對象 欄目 MyBatis 简体版
原文   原文鏈接

這是mybatis系列第8篇。沒看前文的建議先去【Java冢狐】公衆號中查看前文，方便理解和掌握。在上一篇中咱們介紹了一些mybatis使用查詢的一些方式，特別是一對一查詢和一對多查詢進行了重點介紹。沒看的推薦去公衆號進行查看。java

今天咱們介紹一下咱們一直在使用的可是沒有來得及作過多介紹的自動映射。sql

什麼是自動映射？

介紹自動映射以前先看一下手動映射，以下：編程

<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行配置，以下：mybatis

<id column="id" property="id"/>
<result column="userId" property="userId" />
<result column="createTime" property="createTime" />
<result column="upTime" property="upTime" />

這4行代碼用於配置sql結果的列和OrderModel對象中字段的映射關係。app

你們有沒有注意到，映射規則中column和property元素的值都是同樣，mybatis中支持自動映射配置，當開啓自動映射以後，當sql的列名和Model中的字段名稱是同樣的時候（不區分大小寫），mybatis內部會進行自動映射，不須要咱們手動去寫上面的4行映射規則。測試

下面咱們將上面的示例改爲自動映射的方式，以下：this

<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屬性，是否開啓自動映射，咱們設置爲true，這樣mybatis會自動按照列名和Model中同名的字段進行映射賦值。code

上面兩個配置最後查詢結果是同樣的，都會將查詢結果對應的4個字段的值自動賦值給OrderModel中同名的屬性。xml

自動映射開關

mybatis中自動映射主要有2種配置，一種是全局的配置，對應用中全部的resultMap起效，這個是在mybatis配置文件中進行設置的；另一種是經過resultMap的autoMapping屬性進行配置。對象

mybatis判斷某個resultMap是否開啓自動映射配置的時候，會先查找自身的autoMapping屬性，若是這個屬性設置值了，就直接用這個屬性的值，若是resultMap元素的autoMapping屬性沒有配置，則走全局配置的自動映射規則。

下面咱們來詳解介紹一下這款的內容。

mybatis自動映射全局配置

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

<settings>
    <setting name="autoMappingBehavior" value="自動映射規則"/>
</settings>

主要有一下幾種：

  • NONE：關閉全局映射開關
  • PARTIAL：對除在內部定義了嵌套結果映射（也就是鏈接的屬性）之外的屬性進行映射，這個也是默認值。
  • FULL：自動映射全部屬性。

NONE

當mybatis全局配置中將autoMappingBehavior的值置爲了NONE,表示全局自動映射被關閉了，會致使sql實際上有返回結果，可是結果映射的時候不會自動映射因此返回的時候是空

PARTIAL

會進行自動映射，可是有些複雜的查詢映射會在resultMap中嵌套一些映射（如：association，collection），當使用PARTIAL的時候，若是有嵌套映射，則這個嵌套映射不會進行自動映射了。

FULL

自動映射全部屬性。

autoMapping使用

上面咱們有說過，當在resultMap中指定了autoMapping屬性以後，這個resultMap的自動映射就受autoMapping屬性的控制，和mybatis中全局映射配置（autoMappingBehavior）行爲無關了。

案例1

這個核心配置主要在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>
對應測試用例
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);
    }
}
運行輸出
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中全部屬性都自動映射成功。

自動裝配並非那麼好玩，玩不轉可能帶來一些隱患，咱們看一個案例，見下面的示例2。

示例2

根據訂單編號，查詢出訂單信息，順便查詢出訂單明細列表。這個咱們使用mybatis中的一對多查詢。

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>

這個能夠根據訂單的id，查詢出訂單關聯的明細列表。

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>
測試用例
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);
    }
}
運行輸出
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值？主要是下面這行配置致使的

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

上面這個配置中有個column屬性，指定的是id，此時mybatis認爲你對id字段手動指定了映射關係，就跳過了對id字段到OrderModel.id屬性的自動映射，因此致使OrderModel對象的id屬性沒有賦值，此時須要咱們在orderModelMap8手動指定id的映射規則，以下：

<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>

再去運行測試用例就正常了。

總結一下

對於我們開發來講，自動映射確實能夠幫助咱們節省一些代碼，不過也存在一些隱患，咱們但願本身開發的系統是健壯的，建議你們寫mapper xml的時候，仍是花點時間將映射的配置都給寫上去，這樣可以杜絕一些隱患，使咱們的系統更穩定。

最後

  • 若是以爲看完有收穫，但願能關注一下，順便給我點個贊，這將會是我更新的最大動力，感謝各位的支持
  • 歡迎各位關注個人公衆號【java冢狐】，專一於java和計算機基礎知識，保證讓你看完有所收穫，不信你打我
  • 求一鍵三連：點贊、轉發、在看。
  • 若是看完有不一樣的意見或者建議，歡迎多多評論一塊兒交流。感謝各位的支持以及厚愛。

——我是冢狐，和你同樣熱愛編程。

歡迎關注公衆號「Java冢狐」獲取最新消息

相關文章
相關標籤/搜索
每日一句
    每一个你不满意的现在，都有一个你没有努力的曾经。
本站公眾號
   歡迎關注本站公眾號,獲取更多信息
聯繫我們 最近搜索 最新文章 沪ICP备13005482号-10 MyBatis教程 SQL 教程 MySQL教程 Java 教程 Thymeleaf 教程 Hibernate教程 Spring教程 Redis教程