Mybatis常用

zhangyf1121發表於2024-07-06

Mybatis

1.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 例項將會以“list”作為鍵,而陣列例項的鍵將是“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>

基於 Spring Boot + MyBatis Plus + Vue & Element 實現的後臺管理系統 + 使用者小程式,支援 RBAC 動態許可權、多租戶、資料許可權、工作流、三方登入、支付、簡訊、商城等功能

  • 專案地址:https://github.com/YunaiV/ruoyi-vue-pro
  • 影片教程:https://doc.iocoder.cn/video/

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

基於 Spring Cloud Alibaba + Gateway + Nacos + RocketMQ + Vue & Element 實現的後臺管理系統 + 使用者小程式,支援 RBAC 動態許可權、多租戶、資料許可權、工作流、三方登入、支付、簡訊、商城等功能

  • 專案地址:https://github.com/YunaiV/yudao-cloud
  • 影片教程:https://doc.iocoder.cn/video/

3.choose (when, otherwise)標籤

choose標籤是按順序判斷其內部when標籤中的test條件出否成立,如果有一個成立,則 choose 結束。當 choose 中所有 when 的條件都不滿則時,則執行 otherwise 中的sql。類似於Java 的 switch 語句,choose 為 switch,when 為 case,otherwise 則為 default。

例如下面例子,同樣把所有可以限制的條件都寫上,方面使用。choose會從上到下選擇一個when標籤的test為true的sql執行。安全考慮,我們使用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>

4.selectKey 標籤

在insert語句中,在Oracle經常使用序列、在MySQL中使用函式來自動生成插入表的主鍵,而且需要方法能返回這個生成主鍵。使用myBatis的selectKey標籤可以實現這個效果。 下面例子,使用mysql資料庫自定義函式nextval('student'),用來生成一個key,並把他設定到傳入的實體類中的studentId屬性上。所以在執行完此方法後,邊可以透過這個實體類獲取生成的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());

5.if標籤

if標籤可用在許多型別的sql語句中,我們以查詢為例。首先看一個很普通的查詢:

<!-- 查詢學生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動態sql語句先進行判斷,如果值為null或等於空字串,我們就不進行此條件的判斷,增加靈活性。

引數為實體類StudentEntity。將實體類中所有的屬性均進行判斷,如果不為空則執行判斷條件。

<!-- 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());
    }
}

6.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動態語句來解決。這個“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>

7.if + set實現修改語句

當update語句中沒有使用if標籤時,如果有一個引數為null,都會導致錯誤。 當在update語句中使用if標籤時,如果前面的if沒有執行,則或導致逗號多餘錯誤。使用set標籤可以將動態的配置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>

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

9.foreach

對於動態SQL 非常必須的,主是要迭代一個集合,通常是用於IN 條件。List 例項將使用“list”做為鍵,陣列例項以“array” 做為鍵。

foreach元素是非常強大的,它允許你指定一個集合,宣告集合項和索引變數,它們可以用在元素體內。它也允許你指定開放和關閉的字串,在迭代之間放置分隔符。這個元素是很智慧的,它不會偶然地附加多餘的分隔符。

注意:你可以傳遞一個List例項或者陣列作為引數物件傳給MyBatis。當你這麼做的時候,MyBatis會自動將它包裝在一個Map中,用名稱在作為鍵。List例項將會以“list”作為鍵,而陣列例項將會以“array”作為鍵。

這個部分是對關於XML配置檔案和XML對映檔案的而討論的。下一部分將詳細討論Java API,所以你可以得到你已經建立的最有效的對映。

引數為array示例的寫法

介面的方法宣告:

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

動態SQL語句:

<!— 7.1 foreach(迴圈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);

動態SQL語句:

<!-- 7.2 foreach(迴圈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語句片段,在執行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>

10.分步查詢

定義:需要根據使用者id去查詢角色表對應的資訊,一種做法是直接用關聯查詢,另一種就分步查詢,先查詢

到使用者資訊。然後再把使用者資訊中的id取出來作為條件去角色表查出對應的角色資訊。

1.查詢User

public interface UserDao {
	// 根據使用者名稱查詢使用者,並且要求把該使用者所具有的角色資訊也查詢出來
    User findByUserName(String username);    
}
<resultMap id="userMap" type="User">
    <id column="id" property="id"></id>
    <result column="username" property="username"></result>
    <result column="age" property="age"></result>
    <result column="address" property="address"></result>
</resultMap>

<resultMap id="UserRoleMapBySelect" type="User" extends="userMap">
    <connection property="roles"
                ofType="Role"
                <!-- 查詢roles的資料(呼叫哪個方法)-->
                select="包名+介面名+方法名(findRoleByUserId)"
    			<!-- 把當前結果集的哪個資料作為引數傳遞過去 -->
                column="id"> <!-- 這邊的id就對應下面select中的id -->
    </connection>
</resultMap>

<!-- 根據使用者名稱查詢使用者,並且要求把該使用者所具有的角色資訊也查詢出來 -->
<select id="findByUserName" resultMap="UserRoleMapBySelect">
	select id, username, age, address from user where username= #{username}
</select>

2.根據user_id查詢Role

public interface RoleDao{
    // 根據userId查詢所有的角色
    List<Role> findRoleByUserId(Integer userId);
}
<!-- 根據userId查詢所有的角色 -->
<select id="findRoleByUserId" resultType="Role">
    select r.id, r.name, r.desc from role r, user_role ur
    where
    ur.role_id = r.id
    and ur.user_id = #{ userId }
</select>

3.獲取到之前查詢到userId傳入到上面的#{ userId }中

相關文章