MyBatis通用的10種寫法總結大全
前言
MyBatis 是一款優(yōu)秀的持久層框架，它支持定制化 SQL、存儲過程以及高級映射。MyBatis 避免了幾乎所有的 JDBC 代碼和手動設置參數以及獲取結果集。MyBatis 可以使用簡單的 XML 或注解來配置和映射原生信息，將接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java對象)映射成數據庫中的記錄。
用來循環(huán)容器的標簽forEach,查看例子
foreach元素的屬性主要有item，index，collection，open，separator，close。
● item：集合中元素迭代時的別名，
● index：集合中元素迭代時的索引
● open：常用語where語句中，表示以什么開始，比如以'('開始
● separator：表示在每次進行迭代時的分隔符，
● close 常用語where語句中，表示以什么結束，
在使用foreach的時候最關鍵的也是最容易出錯的就是collection屬性，該屬性是必須指定的，但是在不同情況下，該屬性的值是不一樣的，主要有一下3種情況：
● 如果傳入的是單參數且參數類型是一個List的時候，collection屬性值為list .
● 如果傳入的是單參數且參數類型是一個array數組的時候，collection的屬性值為array .
● 如果傳入的參數是多個的時候，我們就需要把它們封裝成一個Map了，當然單參數也可以封裝成map，實際上如果你在傳入參數的時候，在MyBatis里面也是會把它封裝成一個Map的，map的key就是參數名，所以這個時候collection屬性值就是傳入的List或array對象在自己封裝的map里面的key.
針對最后一條，我們來看一下官方說法：
注意 你可以將一個 List 實例或者數組作為參數對象傳給 MyBatis，當你這么做的時候，MyBatis 會自動將它包裝在一個 Map 中并以名稱為鍵。List 實例將會以“l(fā)ist”作為鍵，而數組實例的鍵將是“array”。
所以，不管是多參數還是單參數的list,array類型，都可以封裝為map進行傳遞。如果傳遞的是一個List，則mybatis會封裝為一個list為key，list值為object的map，如果是array，則封裝成一個array為key，array的值為object的map，如果自己封裝呢，則colloection里放的是自己封裝的map里的key值
//mapper中我們要為這個方法傳遞的是一個容器,將容器中的元素一個一個的
//拼接到xml的方法中就要使用這個forEach這個標簽了
public List<Entity> queryById(List<String> userids);
//對應的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模糊查詢
//比如說我們想要進行條件查詢,但是幾個條件不是每次都要使用,那么我們就可以
//通過判斷是否拼接到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)標簽
choose標簽是按順序判斷其內部when標簽中的test條件出否成立，如果有一個成立，則 choose 結束。當 choose 中所有 when 的條件都不滿則時，則執(zhí)行 otherwise 中的sql。類似于Java 的 switch 語句，choose 為 switch，when 為 case，otherwise 則為 default。
例如下面例子，同樣把所有可以限制的條件都寫上，方面使用。choose會從上到下選擇一個when標簽的test為true的sql執(zhí)行。安全考慮，我們使用where將choose包起來，放置關鍵字多于錯誤。
<!-- choose(判斷參數) - 按順序將實體類 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 標簽
在insert語句中，在Oracle經常使用序列、在MySQL中使用函數來自動生成插入表的主鍵，而且需要方法能返回這個生成主鍵。使用myBatis的selectKey標簽可以實現這個效果。
下面例子，使用mysql數據庫自定義函數nextval('student')，用來生成一個key，并把他設置到傳入的實體類中的studentId屬性上。所以在執(zhí)行完此方法后，邊可以通過這個實體類獲取生成的key。
<!-- 插入學生 自動主鍵-->
<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>
調用接口方法，和獲取自動生成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("新增學生ID: " + entity.getStudentId());
if標簽
if標簽可用在許多類型的sql語句中，我們以查詢?yōu)槔Ｊ紫瓤匆粋€很普通的查詢：
<!-- 查詢學生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，此語句很可能報錯或查詢結果為空。此時我們使用if動態(tài)sql語句先進行判斷，如果值為null或等于空字符串，我們就不進行此條件的判斷，增加靈活性。
參數為實體類StudentEntity。將實體類中所有的屬性均進行判斷，如果不為空則執(zhí)行判斷條件。
<!-- 2 if(判斷參數) - 將實體類不為空的屬性作為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一個這樣的實體類，我們需要限制那個條件，只需要附上相應的值就會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 的條件判斷
當where中的條件使用的if標簽較多時，這樣的組合可能會導致錯誤。我們以在3.1中的查詢語句為例子，當java代碼按如下方法調用時：
@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());
}
}
如果上面例子，參數studentName為null，將不會進行STUDENT_NAME列的判斷，則會直接導“WHERE AND”關鍵字多余的錯誤SQL。
這時我們可以使用where動態(tài)語句來解決。這個“where”標簽會知道如果它包含的標簽中有返回值的話，它就插入一個‘where'。此外，如果標簽返回的內容是以AND 或OR 開頭的，則它會剔除掉。
上面例子修改為：
<!-- 3 select - where/if(判斷參數) - 將實體類不為空的屬性作為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實現修改語句
當update語句中沒有使用if標簽時，如果有一個參數為null，都會導致錯誤。
當在update語句中使用if標簽時，如果前面的if沒有執(zhí)行，則或導致逗號多余錯誤。使用set標簽可以將動態(tài)的配置SET 關鍵字，和剔除追加到條件末尾的任何不相關的逗號。使用if+set標簽修改后，如果某項為null則不進行更新，而是保持數據庫原值。如下示例：
<!-- 4 if/set(判斷參數) - 將實體類不為空的屬性更新 -->
<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標簽
trim是更靈活的去處多余關鍵字的標簽，他可以實踐where和set的效果。
trim代替where
<!-- 5.1if/trim代替where(判斷參數) -將實體類不為空的屬性作為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(判斷參數) - 將實體類不為空的屬性更新 -->
<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 實例將使用“l(fā)ist”做為鍵，數組實例以“array” 做為鍵。
foreach元素是非常強大的，它允許你指定一個集合，聲明集合項和索引變量，它們可以用在元素體內。它也允許你指定開放和關閉的字符串，在迭代之間放置分隔符。這個元素是很智能的，它不會偶然地附加多余的分隔符。
注意：你可以傳遞一個List實例或者數組作為參數對象傳給MyBatis。當你這么做的時候，MyBatis會自動將它包裝在一個Map中，用名稱在作為鍵。List實例將會以“l(fā)ist”作為鍵，而數組實例將會以“array”作為鍵。
這個部分是對關于XML配置文件和XML映射文件的而討論的。下一部分將詳細討論Java API，所以你可以得到你已經創(chuàng)建的最有效的映射。
1參數為array示例的寫法
接口的方法聲明：
public List<StudentEntity> getStudentListByClassIds_foreach_array(String[] classIds);
動態(tài)SQL語句：
<!— 7.1 foreach(循環(huán)array參數) - 作為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>
測試代碼，查詢學生中，在20000001、20000002這兩個班級的學生：
@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參數為list示例的寫法
接口的方法聲明：
public List<StudentEntity> getStudentListByClassIds_foreach_list(List<String> classIdList);
動態(tài)SQL語句：
<!-- 7.2 foreach(循環(huán)List<String>參數) - 作為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>
測試代碼，查詢學生中，在20000001、20000002這兩個班級的學生：
@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片段標簽：通過該標簽可定義能復用的sql語句片段，在執(zhí)行sql語句標簽中直接引用即可。這樣既可以提高編碼效率，還能有效簡化代碼，提高可讀性
需要配置的屬性：id="" >>>表示需要改sql語句片段的唯一標識
引用：通過標簽引用，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>
總結
以上就是這篇文章的全部內容了，希望本文的內容對大家的學習或者工作具有一定的參考學習價值，如果有疑問大家可以留言交流，謝謝大家對腳本之家的支持。
相關文章
剛學完javaweb,對自己的Dao層代碼很不滿意的話,可得來學學MyBatis.學習MyBatis既可以改進JDBC的使用,實現Dao層也會變得很簡便,下面我將介紹IDEA中maven配置MyBatis簡單流程,需要的朋友可以參考下2021-06-06
這篇文章主要為大家介紹了使用DevOps開源利器開發(fā)部署Hygieia平臺的實現，有需要的朋友可以借鑒參考下，希望能夠有所幫助，祝大家多多進步早日升職?加薪2022-03-03
這篇文章主要介紹了一文詳解Java抽象類到底有多抽象，抽象方法所在的類必須是抽象類，子類若繼承了一個抽象類，就必須覆寫父類的所有抽象方法，這里的子類是普通類，是強制要求覆寫所有抽象方法，但是如果子類也是一個抽象類，那么就可以不覆寫2022-06-06
SpringBoot整合RabbitMQ實現六種工作模式的示例
這篇文章主要介紹了SpringBoot整合RabbitMQ實現六種工作模式,本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2022-07-07
idea +junit單元測試獲取不到bean注入的解決方式
這篇文章主要介紹了idea +junit單元測試獲取不到bean注入的解決方式，具有很好的參考價值，希望對大家有所幫助。一起跟隨小編過來看看吧2020-08-08
這篇文章主要介紹了JAVA項目常用異常處理匯總,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-11-11
單例模式是一種常用的軟件設計模式,它確保一個類只有一個實例,并提供一個全局訪問點,在多線程環(huán)境下,確保單例模式的線程安全性是非常重要的,因為多個線程可能會同時嘗試創(chuàng)建實例,導致實例不唯一的問題,本文介紹了在Java中實現線程安全的單例模式有幾種常見的方式2024-09-09
Intellij IDEA基于Springboot的遠程調試(圖文)
這篇文章主要介紹了Intellij IDEA基于Springboot的遠程調試(圖文)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-10-10
Java調用ChatGPT(基于SpringBoot和Vue)實現可連續(xù)對話和流式輸出的ChatGPT API
這篇文章主要介紹了Java調用ChatGPT（基于SpringBoot和Vue），實現可連續(xù)對話和流式輸出的ChatGPT API（可自定義實現AI助手），文中代碼示例介紹的非常詳細，感興趣的朋友可以參考下2023-04-04
解決Springboot配置excludePathPatterns不生效的問題
這篇文章主要介紹了解決Springboot配置excludePathPatterns不生效的問題，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2022-10-10