MyBatis的10種精妙用法

用來循環(huán)容器的標(biāo)簽forEach,查看例子

concat模糊查詢

choose （when, otherwise）標(biāo)簽

selectKey 標(biāo)簽

if標(biāo)簽

if + where 的條件判斷

if + set實(shí)現(xiàn)修改語句

if + trim代替where/set標(biāo)簽

foreach

用來循環(huán)容器的標(biāo)簽forEach,查看例子

foreach元素的屬性主要有item，index，collection，open，separator，close。

item：集合中元素迭代時(shí)的別名，

index：集合中元素迭代時(shí)的索引

open：常用語where語句中，表示以什么開始，比如以'('開始

separator：表示在每次進(jìn)行迭代時(shí)的分隔符，

close 常用語where語句中，表示以什么結(jié)束，

在使用foreach的時(shí)候最關(guān)鍵的也是最容易出錯(cuò)的就是collection屬性，該屬性是必須指定的，但是在不同情況下，該屬性的值是不一樣的，主要有一下3種情況：

如果傳入的是單參數(shù)且參數(shù)類型是一個(gè)List的時(shí)候，collection屬性值為list .

如果傳入的是單參數(shù)且參數(shù)類型是一個(gè)array數(shù)組的時(shí)候，collection的屬性值為array .

如果傳入的參數(shù)是多個(gè)的時(shí)候，我們就需要把它們封裝成一個(gè)Map了，當(dāng)然單參數(shù)也可以封裝成map，實(shí)際上如果你在傳入?yún)?shù)的時(shí)候，在MyBatis里面也是會(huì)把它封裝成一個(gè)Map的，map的key就是參數(shù)名，所以這個(gè)時(shí)候collection屬性值就是傳入的List或array對象在自己封裝的map里面的key.

針對最后一條，我們來看一下官方說法：

注意 你可以將一個(gè) List 實(shí)例或者數(shù)組作為參數(shù)對象傳給 MyBatis，當(dāng)你這么做的時(shí)候，MyBatis 會(huì)自動(dòng)將它包裝在一個(gè) Map 中并以名稱為鍵。List 實(shí)例將會(huì)以“l(fā)ist”作為鍵，而數(shù)組實(shí)例的鍵將是“array”。

所以，不管是多參數(shù)還是單參數(shù)的list,array類型，都可以封裝為map進(jìn)行傳遞。如果傳遞的是一個(gè)List，則mybatis會(huì)封裝為一個(gè)list為key，list值為object的map，如果是array，則封裝成一個(gè)array為key，array的值為object的map，如果自己封裝呢，則colloection里放的是自己封裝的map里的key值

//mapper中我們要為這個(gè)方法傳遞的是一個(gè)容器,將容器中的元素一個(gè)一個(gè)的
//拼接到xml的方法中就要使用這個(gè)forEach這個(gè)標(biāo)簽了
publicListqueryById(Listuserids);

//對應(yīng)的xml中如下

select*FROMentity
whereidin

#{userid}

基于 Spring Boot + MyBatis Plus + Vue & Element 實(shí)現(xiàn)的后臺管理系統(tǒng) + 用戶小程序，支持 RBAC 動(dòng)態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

項(xiàng)目地址：https://github.com/YunaiV/ruoyi-vue-pro

視頻教程：https://doc.iocoder.cn/video/

concat模糊查詢

//比如說我們想要進(jìn)行條件查詢,但是幾個(gè)條件不是每次都要使用,那么我們就可以
//通過判斷是否拼接到sql中

SELECT*fromentity


namelikeconcat('%',concat(#{name},'%'))

基于 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 實(shí)現(xiàn)的后臺管理系統(tǒng) + 用戶小程序，支持 RBAC 動(dòng)態(tài)權(quán)限、多租戶、數(shù)據(jù)權(quán)限、工作流、三方登錄、支付、短信、商城等功能

項(xiàng)目地址：https://github.com/YunaiV/yudao-cloud

視頻教程：https://doc.iocoder.cn/video/

choose (when, otherwise)標(biāo)簽

choose標(biāo)簽是按順序判斷其內(nèi)部when標(biāo)簽中的test條件出否成立，如果有一個(gè)成立，則 choose 結(jié)束。當(dāng) choose 中所有 when 的條件都不滿則時(shí)，則執(zhí)行 otherwise 中的sql。類似于Java 的 switch 語句，choose 為 switch，when 為 case，otherwise 則為 default。

例如下面例子，同樣把所有可以限制的條件都寫上，方面使用。choose會(huì)從上到下選擇一個(gè)when標(biāo)簽的test為true的sql執(zhí)行。安全考慮，我們使用where將choose包起來，放置關(guān)鍵字多于錯(cuò)誤。

 

SELECT*
FROMUseru



u.usernameLIKECONCAT(CONCAT('%',#{username,jdbcType=VARCHAR}),'%')


ANDu.sex=#{sex,jdbcType=INTEGER}


ANDu.birthday=#{birthday,jdbcType=DATE}

selectKey 標(biāo)簽

在insert語句中，在Oracle經(jīng)常使用序列、在MySQL中使用函數(shù)來自動(dòng)生成插入表的主鍵，而且需要方法能返回這個(gè)生成主鍵。使用myBatis的selectKey標(biāo)簽可以實(shí)現(xiàn)這個(gè)效果。 下面例子，使用mysql數(shù)據(jù)庫自定義函數(shù)nextval('student')，用來生成一個(gè)key，并把他設(shè)置到傳入的實(shí)體類中的studentId屬性上。所以在執(zhí)行完此方法后，邊可以通過這個(gè)實(shí)體類獲取生成的key。

 


selectnextval('student')

INSERTINTOSTUDENT_TBL(STUDENT_ID,
STUDENT_NAME,
STUDENT_SEX,
STUDENT_BIRTHDAY,
STUDENT_PHOTO,
CLASS_ID,
PLACE_ID)
VALUES(#{studentId},
#{studentName},
#{studentSex},
#{studentBirthday},
#{studentPhoto,javaType=byte[],jdbcType=BLOB,typeHandler=org.apache.ibatis.type.BlobTypeHandler},
#{classId},
#{placeId})

調(diào)用接口方法，和獲取自動(dòng)生成key

StudentEntityentity=newStudentEntity();
entity.setStudentName("黎明你好");
entity.setStudentSex(1);
entity.setStudentBirthday(DateUtil.parse("1985-05-28"));
entity.setClassId("20000001");
entity.setPlaceId("70000001");
this.dynamicSqlMapper.createStudentAutoKey(entity);
System.out.println("新增學(xué)生ID:"+entity.getStudentId());

if標(biāo)簽

if標(biāo)簽可用在許多類型的sql語句中，我們以查詢?yōu)槔?。首先看一個(gè)很普通的查詢：

 

SELECT*fromSTUDENT_TBLST
WHEREST.STUDENT_NAMELIKECONCAT(CONCAT('%',#{studentName}),'%')

但是此時(shí)如果studentName為null，此語句很可能報(bào)錯(cuò)或查詢結(jié)果為空。此時(shí)我們使用if動(dòng)態(tài)sql語句先進(jìn)行判斷，如果值為null或等于空字符串，我們就不進(jìn)行此條件的判斷，增加靈活性。

參數(shù)為實(shí)體類StudentEntity。將實(shí)體類中所有的屬性均進(jìn)行判斷，如果不為空則執(zhí)行判斷條件。

 

SELECTST.STUDENT_ID,
ST.STUDENT_NAME,
ST.STUDENT_SEX,
ST.STUDENT_BIRTHDAY,
ST.STUDENT_PHOTO,
ST.CLASS_ID,
ST.PLACE_ID
FROMSTUDENT_TBLST
WHERE

ST.STUDENT_NAMELIKECONCAT(CONCAT('%',#{studentName,jdbcType=VARCHAR}),'%')


ANDST.STUDENT_SEX=#{studentSex,jdbcType=INTEGER}


ANDST.STUDENT_BIRTHDAY=#{studentBirthday,jdbcType=DATE}


ANDST.CLASS_ID=#{classId,jdbcType=VARCHAR}


ANDST.CLASS_ID=#{classEntity.classId,jdbcType=VARCHAR}


ANDST.PLACE_ID=#{placeId,jdbcType=VARCHAR}


ANDST.PLACE_ID=#{placeEntity.placeId,jdbcType=VARCHAR}


ANDST.STUDENT_ID=#{studentId,jdbcType=VARCHAR}

使用時(shí)比較靈活， new一個(gè)這樣的實(shí)體類，我們需要限制那個(gè)條件，只需要附上相應(yīng)的值就會(huì)where這個(gè)條件，相反不去賦值就可以不在where中判斷。

publicvoidselect_test_2_1(){
StudentEntityentity=newStudentEntity();
entity.setStudentName("");
entity.setStudentSex(1);
entity.setStudentBirthday(DateUtil.parse("1985-05-28"));
entity.setClassId("20000001");
//entity.setPlaceId("70000001");
Listlist=this.dynamicSqlMapper.getStudentList_if(entity);
for(StudentEntitye:list){
System.out.println(e.toString());
}
}

if + where 的條件判斷

當(dāng)where中的條件使用的if標(biāo)簽較多時(shí)，這樣的組合可能會(huì)導(dǎo)致錯(cuò)誤。我們以在3.1中的查詢語句為例子，當(dāng)java代碼按如下方法調(diào)用時(shí)：

@Test
publicvoidselect_test_2_1(){
StudentEntityentity=newStudentEntity();
entity.setStudentName(null);
entity.setStudentSex(1);
Listlist=this.dynamicSqlMapper.getStudentList_if(entity);
for(StudentEntitye:list){
System.out.println(e.toString());
}
}

如果上面例子，參數(shù)studentName為null，將不會(huì)進(jìn)行STUDENT_NAME列的判斷，則會(huì)直接導(dǎo)“WHERE AND”關(guān)鍵字多余的錯(cuò)誤SQL。 這時(shí)我們可以使用where動(dòng)態(tài)語句來解決。這個(gè)“where”標(biāo)簽會(huì)知道如果它包含的標(biāo)簽中有返回值的話，它就插入一個(gè)‘where’。此外，如果標(biāo)簽返回的內(nèi)容是以AND 或OR 開頭的，則它會(huì)剔除掉。 上面例子修改為：

 

SELECTST.STUDENT_ID,
ST.STUDENT_NAME,
ST.STUDENT_SEX,
ST.STUDENT_BIRTHDAY,
ST.STUDENT_PHOTO,
ST.CLASS_ID,
ST.PLACE_ID
FROMSTUDENT_TBLST


ST.STUDENT_NAMELIKECONCAT(CONCAT('%',#{studentName,jdbcType=VARCHAR}),'%')


ANDST.STUDENT_SEX=#{studentSex,jdbcType=INTEGER}


ANDST.STUDENT_BIRTHDAY=#{studentBirthday,jdbcType=DATE}


ANDST.CLASS_ID=#{classId,jdbcType=VARCHAR}


ANDST.CLASS_ID=#{classEntity.classId,jdbcType=VARCHAR}


ANDST.PLACE_ID=#{placeId,jdbcType=VARCHAR}


ANDST.PLACE_ID=#{placeEntity.placeId,jdbcType=VARCHAR}


ANDST.STUDENT_ID=#{studentId,jdbcType=VARCHAR}

if + set實(shí)現(xiàn)修改語句

當(dāng)update語句中沒有使用if標(biāo)簽時(shí)，如果有一個(gè)參數(shù)為null，都會(huì)導(dǎo)致錯(cuò)誤。 當(dāng)在update語句中使用if標(biāo)簽時(shí)，如果前面的if沒有執(zhí)行，則或?qū)е露禾柖嘤噱e(cuò)誤。使用set標(biāo)簽可以將動(dòng)態(tài)的配置SET 關(guān)鍵字，和剔除追加到條件末尾的任何不相關(guān)的逗號。使用if+set標(biāo)簽修改后，如果某項(xiàng)為null則不進(jìn)行更新，而是保持?jǐn)?shù)據(jù)庫原值。如下示例：

 

UPDATESTUDENT_TBL


STUDENT_TBL.STUDENT_NAME=#{studentName},


STUDENT_TBL.STUDENT_SEX=#{studentSex},


STUDENT_TBL.STUDENT_BIRTHDAY=#{studentBirthday},


STUDENT_TBL.STUDENT_PHOTO=#{studentPhoto,javaType=byte[],jdbcType=BLOB,typeHandler=org.apache.ibatis.type.BlobTypeHandler},


STUDENT_TBL.CLASS_ID=#{classId}


STUDENT_TBL.PLACE_ID=#{placeId}


WHERESTUDENT_TBL.STUDENT_ID=#{studentId};

if + trim代替where/set標(biāo)簽

trim是更靈活的去處多余關(guān)鍵字的標(biāo)簽，他可以實(shí)踐where和set的效果。

trim代替where

 

SELECTST.STUDENT_ID,
ST.STUDENT_NAME,
ST.STUDENT_SEX,
ST.STUDENT_BIRTHDAY,
ST.STUDENT_PHOTO,
ST.CLASS_ID,
ST.PLACE_ID
FROMSTUDENT_TBLST


ST.STUDENT_NAMELIKECONCAT(CONCAT('%',#{studentName,jdbcType=VARCHAR}),'%')


ANDST.STUDENT_SEX=#{studentSex,jdbcType=INTEGER}


ANDST.STUDENT_BIRTHDAY=#{studentBirthday,jdbcType=DATE}


ANDST.CLASS_ID=#{classId,jdbcType=VARCHAR}


ANDST.CLASS_ID=#{classEntity.classId,jdbcType=VARCHAR}


ANDST.PLACE_ID=#{placeId,jdbcType=VARCHAR}


ANDST.PLACE_ID=#{placeEntity.placeId,jdbcType=VARCHAR}


ANDST.STUDENT_ID=#{studentId,jdbcType=VARCHAR}

trim代替set

 

UPDATESTUDENT_TBL


STUDENT_TBL.STUDENT_NAME=#{studentName},


STUDENT_TBL.STUDENT_SEX=#{studentSex},


STUDENT_TBL.STUDENT_BIRTHDAY=#{studentBirthday},


STUDENT_TBL.STUDENT_PHOTO=#{studentPhoto,javaType=byte[],jdbcType=BLOB,typeHandler=org.apache.ibatis.type.BlobTypeHandler},


STUDENT_TBL.CLASS_ID=#{classId},


STUDENT_TBL.PLACE_ID=#{placeId}


WHERESTUDENT_TBL.STUDENT_ID=#{studentId}

foreach

對于動(dòng)態(tài)SQL 非常必須的，主是要迭代一個(gè)集合，通常是用于IN 條件。List 實(shí)例將使用“l(fā)ist”做為鍵，數(shù)組實(shí)例以“array” 做為鍵。

foreach元素是非常強(qiáng)大的，它允許你指定一個(gè)集合，聲明集合項(xiàng)和索引變量，它們可以用在元素體內(nèi)。它也允許你指定開放和關(guān)閉的字符串，在迭代之間放置分隔符。這個(gè)元素是很智能的，它不會(huì)偶然地附加多余的分隔符。

注意：你可以傳遞一個(gè)List實(shí)例或者數(shù)組作為參數(shù)對象傳給MyBatis。當(dāng)你這么做的時(shí)候，MyBatis會(huì)自動(dòng)將它包裝在一個(gè)Map中，用名稱在作為鍵。List實(shí)例將會(huì)以“l(fā)ist”作為鍵，而數(shù)組實(shí)例將會(huì)以“array”作為鍵。

這個(gè)部分是對關(guān)于XML配置文件和XML映射文件的而討論的。下一部分將詳細(xì)討論Java API，所以你可以得到你已經(jīng)創(chuàng)建的最有效的映射。

參數(shù)為array示例的寫法

接口的方法聲明：

publicListgetStudentListByClassIds_foreach_array(String[]classIds);

動(dòng)態(tài)SQL語句：

SELECTST.STUDENT_ID,
ST.STUDENT_NAME,
ST.STUDENT_SEX,
ST.STUDENT_BIRTHDAY,
ST.STUDENT_PHOTO,
ST.CLASS_ID,
ST.PLACE_ID
FROMSTUDENT_TBLST
WHEREST.CLASS_IDIN

#{classIds}

測試代碼，查詢學(xué)生中，在20000001、20000002這兩個(gè)班級的學(xué)生：

@Testpublicvoidtest7_foreach(){String[]classIds={"20000001","20000002"};Listlist=this.dynamicSqlMapper.getStudentListByClassIds_foreach_array(classIds);for(StudentEntitye:list){System.out.println(e.toString());}}

2參數(shù)為list示例的寫法 接口的方法聲明：

publicListgetStudentListByClassIds_foreach_list(ListclassIdList);

動(dòng)態(tài)SQL語句：

 

SELECTST.STUDENT_ID,
ST.STUDENT_NAME,
ST.STUDENT_SEX,
ST.STUDENT_BIRTHDAY,
ST.STUDENT_PHOTO,
ST.CLASS_ID,
ST.PLACE_ID
FROMSTUDENT_TBLST
WHEREST.CLASS_IDIN

#{classIdList}

測試代碼，查詢學(xué)生中，在20000001、20000002這兩個(gè)班級的學(xué)生：

@Test
publicvoidtest7_2_foreach(){
ArrayListclassIdList=newArrayList();
classIdList.add("20000001");
classIdList.add("20000002");
Listlist=this.dynamicSqlMapper.getStudentListByClassIds_foreach_list(classIdList);
for(StudentEntitye:list){
System.out.println(e.toString());
}

sql片段標(biāo)簽：通過該標(biāo)簽可定義能復(fù)用的sql語句片段，在執(zhí)行sql語句標(biāo)簽中直接引用即可。這樣既可以提高編碼效率，還能有效簡化代碼，提高可讀性

需要配置的屬性：id="" >>>表示需要改sql語句片段的唯一標(biāo)識

引用：通過標(biāo)簽引用，refid="" 中的值指向需要引用的中的id=“”屬性

 

o.order_id,o.cid,o.address,o.create_date,o.orderitem_id,i.orderitem_id,i.product_id,i.count



select
 

fromordertableo
joinorderitemiono.orderitem_id=i.orderitem_id
whereo.order_id=#{orderId}