MyBatis通用的10種寫法總結(jié)大全

更新時間：2021年04月01日 15:08:42 作者：琪琪

這篇文章主要給大家介紹了關(guān)于MyBatis通用的10種寫法，文中通過示例代碼介紹的非常詳細(xì)，對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

前言

MyBatis 是一款優(yōu)秀的持久層框架，它支持定制化 SQL、存儲過程以及高級映射。MyBatis 避免了幾乎所有的 JDBC 代碼和手動設(shè)置參數(shù)以及獲取結(jié)果集。MyBatis 可以使用簡單的 XML 或注解來配置和映射原生信息，將接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java對象)映射成數(shù)據(jù)庫中的記錄。

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

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

● item：集合中元素迭代時的別名，

● index：集合中元素迭代時的索引

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

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

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

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

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

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

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

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

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

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

//mapper中我們要為這個方法傳遞的是一個容器,將容器中的元素一個一個的
//拼接到xml的方法中就要使用這個forEach這個標(biāo)簽了
public List<Entity> queryById(List<String> userids);

//對應(yīng)的xml中如下
<select id="queryById" resultMap="BaseReslutMap" >
select * FROM entity
where id in
<foreach collection="userids" item="userid" index="index" open="(" separator="," close=")">
#{userid}
</foreach>
</select>

concat模糊查詢

//比如說我們想要進(jìn)行條件查詢,但是幾個條件不是每次都要使用,那么我們就可以
//通過判斷是否拼接到sql中
<select id="queryById" resultMap="BascResultMap" parameterType="entity">
SELECT * from entity
<where>
<if test="name!=null">
name like concat('%',concat(#{name},'%'))
</if>
</where>
</select>

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

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

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

<!-- choose(判斷參數(shù)) - 按順序?qū)?shí)體類 User 第一個不為空的屬性作為：where條件 -->
<select id="getUserList_choose" resultMap="resultMap_user" parameterType="com.yiibai.pojo.User">
SELECT *
FROM User u
<where>
<choose>
<when test="username !=null ">
u.username LIKE CONCAT(CONCAT('%', #{username, jdbcType=VARCHAR}),'%')
</when >
<when test="sex != null and sex != '' ">
AND u.sex = #{sex, jdbcType=INTEGER}
</when >
<when test="birthday != null ">
AND u.birthday = #{birthday, jdbcType=DATE}
</when >
<otherwise>
</otherwise>
</choose>
</where>
</select>

selectKey 標(biāo)簽

在insert語句中，在Oracle經(jīng)常使用序列、在MySQL中使用函數(shù)來自動生成插入表的主鍵，而且需要方法能返回這個生成主鍵。使用myBatis的selectKey標(biāo)簽可以實(shí)現(xiàn)這個效果。

下面例子，使用mysql數(shù)據(jù)庫自定義函數(shù)nextval('student')，用來生成一個key，并把他設(shè)置到傳入的實(shí)體類中的studentId屬性上。所以在執(zhí)行完此方法后，邊可以通過這個實(shí)體類獲取生成的key。

<!-- 插入學(xué)生 自動主鍵-->
<insert id="createStudentAutoKey" parameterType="liming.student.manager.data.model.StudentEntity" keyProperty="studentId">
<selectKey keyProperty="studentId" resultType="String" order="BEFORE">
select nextval('student')
</selectKey>
INSERT INTO STUDENT_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})
</insert>

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

StudentEntity entity = new StudentEntity();
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)槔Ｊ紫瓤匆粋€很普通的查詢：

<!-- 查詢學(xué)生list，like姓名 -->
<select id="getStudentListLikeName" parameterType="StudentEntity" resultMap="studentResultMap">
SELECT * from STUDENT_TBL ST
WHERE ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName}),'%')
</select>

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

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

<!-- 2 if(判斷參數(shù)) - 將實(shí)體類不為空的屬性作為where條件 -->
<select id="getStudentList_if" resultMap="resultMap_studentEntity" parameterType="liming.student.manager.data.model.StudentEntity">
SELECT ST.STUDENT_ID,
ST.STUDENT_NAME,
ST.STUDENT_SEX,
ST.STUDENT_BIRTHDAY,
ST.STUDENT_PHOTO,
ST.CLASS_ID,
ST.PLACE_ID
FROM STUDENT_TBL ST
WHERE
<if test="studentName !=null ">
ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')
</if>
<if test="studentSex != null and studentSex != '' ">
AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}
</if>
<if test="studentBirthday != null ">
AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}
</if>
<if test="classId != null and classId!= '' ">
AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}
</if>
<if test="classEntity != null and classEntity.classId !=null and classEntity.classId !=' ' ">
AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}
</if>
<if test="placeId != null and placeId != '' ">
AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}
</if>
<if test="placeEntity != null and placeEntity.placeId != null and placeEntity.placeId != '' ">
AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}
</if>
<if test="studentId != null and studentId != '' ">
AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}
</if>
</select>

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

public void select_test_2_1() {
StudentEntity entity = new StudentEntity();
entity.setStudentName("");
entity.setStudentSex(1);
entity.setStudentBirthday(DateUtil.parse("1985-05-28"));
entity.setClassId("20000001");
//entity.setPlaceId("70000001");
List<StudentEntity> list = this.dynamicSqlMapper.getStudentList_if(entity);
for (StudentEntity e : list) {
System.out.println(e.toString());
}
}

if + where 的條件判斷

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

@Test
public void select_test_2_1() {
StudentEntity entity = new StudentEntity();
entity.setStudentName(null);
entity.setStudentSex(1);
List<StudentEntity> list = this.dynamicSqlMapper.getStudentList_if(entity);
for (StudentEntity e : list) {
System.out.println(e.toString());
}
}

如果上面例子，參數(shù)studentName為null，將不會進(jìn)行STUDENT_NAME列的判斷，則會直接導(dǎo)“WHERE AND”關(guān)鍵字多余的錯誤SQL。

這時我們可以使用where動態(tài)語句來解決。這個“where”標(biāo)簽會知道如果它包含的標(biāo)簽中有返回值的話，它就插入一個‘where'。此外，如果標(biāo)簽返回的內(nèi)容是以AND 或OR 開頭的，則它會剔除掉。

上面例子修改為：

<!-- 3 select - where/if(判斷參數(shù)) - 將實(shí)體類不為空的屬性作為where條件 -->
<select id="getStudentList_whereIf" resultMap="resultMap_studentEntity" parameterType="liming.student.manager.data.model.StudentEntity">
SELECT ST.STUDENT_ID,
ST.STUDENT_NAME,
ST.STUDENT_SEX,
ST.STUDENT_BIRTHDAY,
ST.STUDENT_PHOTO,
ST.CLASS_ID,
ST.PLACE_ID
FROM STUDENT_TBL ST
<where>
<if test="studentName !=null ">
ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')
</if>
<if test="studentSex != null and studentSex != '' ">
AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}
</if>
<if test="studentBirthday != null ">
AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}
</if>
<if test="classId != null and classId!= '' ">
AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}
</if>
<if test="classEntity != null and classEntity.classId !=null and classEntity.classId !=' ' ">
AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}
</if>
<if test="placeId != null and placeId != '' ">
AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}
</if>
<if test="placeEntity != null and placeEntity.placeId != null and placeEntity.placeId != '' ">
AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}
</if>
<if test="studentId != null and studentId != '' ">
AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}
</if>
</where>
</select>

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

當(dāng)update語句中沒有使用if標(biāo)簽時，如果有一個參數(shù)為null，都會導(dǎo)致錯誤。

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

<!-- 4 if/set(判斷參數(shù)) - 將實(shí)體類不為空的屬性更新 -->
<update id="updateStudent_if_set" parameterType="liming.student.manager.data.model.StudentEntity">
UPDATE STUDENT_TBL
<set>
<if test="studentName != null and studentName != '' ">
STUDENT_TBL.STUDENT_NAME = #{studentName},
</if>
<if test="studentSex != null and studentSex != '' ">
STUDENT_TBL.STUDENT_SEX = #{studentSex},
</if>
<if test="studentBirthday != null ">
STUDENT_TBL.STUDENT_BIRTHDAY = #{studentBirthday},
</if>
<if test="studentPhoto != null ">
STUDENT_TBL.STUDENT_PHOTO = #{studentPhoto, javaType=byte[], jdbcType=BLOB, typeHandler=org.apache.ibatis.type.BlobTypeHandler},
</if>
<if test="classId != '' ">
STUDENT_TBL.CLASS_ID = #{classId}
</if>
<if test="placeId != '' ">
STUDENT_TBL.PLACE_ID = #{placeId}
</if>
</set>
WHERE STUDENT_TBL.STUDENT_ID = #{studentId};
</update>

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

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

trim代替where

<!-- 5.1if/trim代替where(判斷參數(shù)) -將實(shí)體類不為空的屬性作為where條件-->
<select id="getStudentList_if_trim" resultMap="resultMap_studentEntity">
SELECT ST.STUDENT_ID,
ST.STUDENT_NAME,
ST.STUDENT_SEX,
ST.STUDENT_BIRTHDAY,
ST.STUDENT_PHOTO,
ST.CLASS_ID,
ST.PLACE_ID
FROM STUDENT_TBL ST
<trim prefix="WHERE" prefixOverrides="AND|OR">
<if test="studentName !=null ">
ST.STUDENT_NAME LIKE CONCAT(CONCAT('%', #{studentName, jdbcType=VARCHAR}),'%')
</if>
<if test="studentSex != null and studentSex != '' ">
AND ST.STUDENT_SEX = #{studentSex, jdbcType=INTEGER}
</if>
<if test="studentBirthday != null ">
AND ST.STUDENT_BIRTHDAY = #{studentBirthday, jdbcType=DATE}
</if>
<if test="classId != null and classId!= '' ">
AND ST.CLASS_ID = #{classId, jdbcType=VARCHAR}
</if>
<if test="classEntity != null and classEntity.classId !=null and classEntity.classId !=' ' ">
AND ST.CLASS_ID = #{classEntity.classId, jdbcType=VARCHAR}
</if>
<if test="placeId != null and placeId != '' ">
AND ST.PLACE_ID = #{placeId, jdbcType=VARCHAR}
</if>
<if test="placeEntity != null and placeEntity.placeId != null and placeEntity.placeId != '' ">
AND ST.PLACE_ID = #{placeEntity.placeId, jdbcType=VARCHAR}
</if>
<if test="studentId != null and studentId != '' ">
AND ST.STUDENT_ID = #{studentId, jdbcType=VARCHAR}
</if>
</trim>
</select>

trim代替set

<!-- 5.2 if/trim代替set(判斷參數(shù)) - 將實(shí)體類不為空的屬性更新 -->
<update id="updateStudent_if_trim" parameterType="liming.student.manager.data.model.StudentEntity">
UPDATE STUDENT_TBL
<trim prefix="SET" suffixOverrides=",">
<if test="studentName != null and studentName != '' ">
STUDENT_TBL.STUDENT_NAME = #{studentName},
</if>
<if test="studentSex != null and studentSex != '' ">
STUDENT_TBL.STUDENT_SEX = #{studentSex},
</if>
<if test="studentBirthday != null ">
STUDENT_TBL.STUDENT_BIRTHDAY = #{studentBirthday},
</if>
<if test="studentPhoto != null ">
STUDENT_TBL.STUDENT_PHOTO = #{studentPhoto, javaType=byte[], jdbcType=BLOB, typeHandler=org.apache.ibatis.type.BlobTypeHandler},
</if>
<if test="classId != '' ">
STUDENT_TBL.CLASS_ID = #{classId},
</if>
<if test="placeId != '' ">
STUDENT_TBL.PLACE_ID = #{placeId}
</if>
</trim>
WHERE STUDENT_TBL.STUDENT_ID = #{studentId}
</update>

foreach

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

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

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

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

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

接口的方法聲明：

public List<StudentEntity> getStudentListByClassIds_foreach_array(String[] classIds);

動態(tài)SQL語句：

<!— 7.1 foreach(循環(huán)array參數(shù)) - 作為where中in的條件 -->
<select id="getStudentListByClassIds_foreach_array" resultMap="resultMap_studentEntity">
SELECT ST.STUDENT_ID,
ST.STUDENT_NAME,
ST.STUDENT_SEX,
ST.STUDENT_BIRTHDAY,
ST.STUDENT_PHOTO,
ST.CLASS_ID,
ST.PLACE_ID
FROM STUDENT_TBL ST
WHERE ST.CLASS_ID IN
<foreach collection="array" item="classIds" open="(" separator="," close=")">
#{classIds}
</foreach>
</select>

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

@Test
public void test7_foreach() {
String[] classIds = { "20000001", "20000002" };
List<StudentEntity> list = this.dynamicSqlMapper.getStudentListByClassIds_foreach_array(classIds);
for (StudentEntity e : list) {
System.out.println(e.toString());
}
}

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

接口的方法聲明：

public List<StudentEntity> getStudentListByClassIds_foreach_list(List<String> classIdList);

動態(tài)SQL語句：

<!-- 7.2 foreach(循環(huán)List<String>參數(shù)) - 作為where中in的條件 -->
<select id="getStudentListByClassIds_foreach_list" resultMap="resultMap_studentEntity">
SELECT ST.STUDENT_ID,
ST.STUDENT_NAME,
ST.STUDENT_SEX,
ST.STUDENT_BIRTHDAY,
ST.STUDENT_PHOTO,
ST.CLASS_ID,
ST.PLACE_ID
FROM STUDENT_TBL ST
WHERE ST.CLASS_ID IN
<foreach collection="list" item="classIdList" open="(" separator="," close=")">
#{classIdList}
</foreach>
</select>

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

@Test
public void test7_2_foreach() {
ArrayList<String> classIdList = new ArrayList<String>();
classIdList.add("20000001");
classIdList.add("20000002");
List<StudentEntity> list = this.dynamicSqlMapper.getStudentListByClassIds_foreach_list(classIdList);
for (StudentEntity e : 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=“”屬性

<!--定義sql片段-->
<sql id="orderAndItem">
o.order_id,o.cid,o.address,o.create_date,o.orderitem_id,i.orderitem_id,i.product_id,i.count
</sql>

<select id="findOrderAndItemsByOid" parameterType="java.lang.String" resultMap="BaseResultMap">
select
<!--引用sql片段-->
<include refid="orderAndItem" />
from ordertable o
join orderitem i on o.orderitem_id = i.orderitem_id
where o.order_id = #{orderId}
</select>

總結(jié)

以上就是這篇文章的全部內(nèi)容了，希望本文的內(nèi)容對大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價值，如果有疑問大家可以留言交流，謝謝大家對腳本之家的支持。

您可能感興趣的文章: