今天我們介紹一下我們一直在使用的但是沒有來得及做過多介紹的自動映射。
介紹自動映射之前先看一下手動映射,如下:
<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對象中字段的映射關(guān)系。
大家有沒有注意到,映射規(guī)則中column和property元素的值都是一樣,mybatis中支持自動映射配置,當(dāng)開啟自動映射之后,當(dāng)sql的列名和Model中的字段名稱是一樣的時候(不區(qū)分大小寫),mybatis內(nèi)部會進(jìn)行自動映射,不需要我們手動去寫上面的4行映射規(guī)則。
下面我們將上面的示例改成自動映射的方式,如下:
<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屬性,是否開啟自動映射,我們設(shè)置為true,這樣mybatis會自動按照列名和Model中同名的字段進(jìn)行映射賦值。
上面兩個配置最后查詢結(jié)果是一樣的,都會將查詢結(jié)果對應(yīng)的4個字段的值自動賦值給OrderModel中同名的屬性。
mybatis中自動映射主要有2種配置,一種是全局的配置,對應(yīng)用中所有的resultMap起效,這個是在mybatis配置文件中進(jìn)行設(shè)置的;另外一種是通過resultMap的autoMapping屬性進(jìn)行配置。
mybatis判斷某個resultMap是否開啟自動映射配置的時候,會先查找自身的autoMapping屬性,如果這個屬性設(shè)置值了,就直接用這個屬性的值,如果resultMap元素的autoMapping屬性沒有配置,則走全局配置的自動映射規(guī)則。
下面我們來詳解介紹一下這款的內(nèi)容。
在mybatis全局配置文件中加入下面配置:
<settings> <setting name="autoMappingBehavior" value="自動映射規(guī)則"/></settings>
主要有一下幾種:
NONE:關(guān)閉全局映射開關(guān)
PARTIAL:對除在內(nèi)部定義了嵌套結(jié)果映射(也就是連接的屬性)以外的屬性進(jìn)行映射,這個也是默認(rèn)值。
FULL:自動映射所有屬性。
當(dāng)mybatis全局配置中將autoMappingBehavior的值置為了NONE,表示全局自動映射被關(guān)閉了,會導(dǎo)致sql實際上有返回結(jié)果,但是結(jié)果映射的時候不會自動映射所以返回的時候是空
會進(jìn)行自動映射,但是有些復(fù)雜的查詢映射會在resultMap中嵌套一些映射(如:association,collection),當(dāng)使用PARTIAL的時候,如果有嵌套映射,則這個嵌套映射不會進(jìn)行自動映射了。
自動映射所有屬性。
上面我們有說過,當(dāng)在resultMap中指定了autoMapping屬性之后,這個resultMap的自動映射就受autoMapping屬性的控制,和mybatis中全局映射配置(autoMappingBehavior)行為無關(guān)了。
<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@Testpublic 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: 124:37.610 [main] INFO c.j.chat05.demo7.Demo7Test - OrderModel(id=2, userId=1, createTime=1610803573, upTime=1610803573, userModel=UserModel(id=1, name=冢狐))
OrderModel中所有屬性都自動映射成功。
自動裝配并不是那么好玩,玩不轉(zhuǎn)可能帶來一些隱患,我們看一個案例,見下面的示例2。
根據(jù)訂單編號,查詢出訂單信息,順便查詢出訂單明細(xì)列表。這個我們使用mybatis中的一對多查詢。
<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>
這個可以根據(jù)訂單的id,查詢出訂單關(guān)聯(lián)的明細(xì)列表。
<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@Testpublic 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: 211:06.256 [main] DEBUG c.j.c.d.mapper.OrderMapper.getById8 - <== Total: 111: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"/>
上面這個配置中有個column屬性,指定的是id,此時mybatis認(rèn)為你對id字段手動指定了映射關(guān)系,就跳過了對id字段到OrderModel.id屬性的自動映射,所以導(dǎo)致OrderModel對象的id屬性沒有賦值,此時需要我們在orderModelMap8手動指定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>
再去運行測試用例就正常了。
對于咱們開發(fā)來說,自動映射確實可以幫助我們節(jié)省一些代碼,不過也存在一些隱患,我們希望自己開發(fā)的系統(tǒng)是健壯的,建議大家寫mapper xml的時候,還是花點時間將映射的配置都給寫上去,這樣能夠杜絕一些隱患,使我們的系統(tǒng)更穩(wěn)定。