mapper

Mapper映射文件是一個xml格式文件,必須遵循相應的dtd文件規範,如ibatis-3-mapper.dtd。我們先大體上看看支持哪些配置?如下所示,從Eclipse裏截了個屏:


從上圖可以看出,映射文件是以<mapper>作爲根節點,在根節點中支持9個元素,分別爲insert、update、delete、select(增刪改查);cache、cache-ref、resultMap、parameterMap、sql。


下文中,我們將首先對增刪改進行描述,然後對查進行詳細說明,最後對其他五個元素進行簡單說明。

(1)insert、update、delete

我們先從配置文件看起:

[html] view plain copy
  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;"><?xml version="1.0" encoding="UTF-8" ?>     
  2. <!DOCTYPE mapper     
  3. PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"    
  4. "http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">   
  5.   
  6. <!-- mapper 爲根元素節點, 一個namespace對應一個dao -->  
  7. <mapper namespace="com.dy.dao.UserDao">  
  8.   
  9.     <insert  
  10.       <!-- 1. id (必須配置)  
  11.         id是命名空間中的唯一標識符,可被用來代表這條語句。   
  12.         一個命名空間(namespace) 對應一個dao接口,   
  13.         這個id也應該對應dao裏面的某個方法(相當於方法的實現),因此id 應該與方法名一致 -->  
  14.         
  15.       id="addUser"  
  16.         
  17.       <!-- 2. parameterType (可選配置, 默認爲mybatis自動選擇處理)  
  18.         將要傳入語句的參數的完全限定類名或別名, 如果不配置,mybatis會通過ParameterHandler 根據參數類型默認選擇合適的typeHandler進行處理  
  19.         parameterType 主要指定參數類型,可以是int, short, long, string等類型,也可以是複雜類型(如對象) -->  
  20.         
  21.       parameterType="user"  
  22.         
  23.       <!-- 3. flushCache (可選配置,默認配置爲true)  
  24.         將其設置爲 true,任何時候只要語句被調用,都會導致本地緩存和二級緩存都會被清空,默認值:true(對應插入、更新和刪除語句) -->  
  25.         
  26.       flushCache="true"  
  27.         
  28.       <!-- 4. statementType (可選配置,默認配置爲PREPARED)  
  29.         STATEMENT,PREPARED 或 CALLABLE 的一個。這會讓 MyBatis 分別使用 Statement,PreparedStatement 或 CallableStatement,默認值:PREPARED。 -->  
  30.         
  31.       statementType="PREPARED"  
  32.         
  33.       <!-- 5. keyProperty (可選配置, 默認爲unset)  
  34.         (僅對 insert 和 update 有用)唯一標記一個屬性,MyBatis 會通過 getGeneratedKeys 的返回值或者通過 insert 語句的 selectKey 子元素設置它的鍵值,默認:unset。如果希望得到多個生成的列,也可以是逗號分隔的屬性名稱列表。 -->  
  35.         
  36.       keyProperty=""  
  37.         
  38.       <!-- 6. keyColumn     (可選配置)  
  39.         (僅對 insert 和 update 有用)通過生成的鍵值設置表中的列名,這個設置僅在某些數據庫(像 PostgreSQL)是必須的,當主鍵列不是表中的第一列的時候需要設置。如果希望得到多個生成的列,也可以是逗號分隔的屬性名稱列表。 -->  
  40.         
  41.       keyColumn=""  
  42.         
  43.       <!-- 7. useGeneratedKeys (可選配置, 默認爲false)  
  44.         (僅對 insert 和 update 有用)這會令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法來取出由數據庫內部生成的主鍵(比如:像 MySQL 和 SQL Server 這樣的關係數據庫管理系統的自動遞增字段),默認值:false。  -->  
  45.         
  46.       useGeneratedKeys="false"  
  47.         
  48.       <!-- 8. timeout  (可選配置, 默認爲unset, 依賴驅動)  
  49.         這個設置是在拋出異常之前,驅動程序等待數據庫返回請求結果的秒數。默認值爲 unset(依賴驅動)。 -->  
  50.       timeout="20">  
  51.   
  52.     <update  
  53.       id="updateUser"  
  54.       parameterType="user"  
  55.       flushCache="true"  
  56.       statementType="PREPARED"  
  57.       timeout="20">  
  58.   
  59.     <delete  
  60.       id="deleteUser"  
  61.       parameterType="user"  
  62.       flushCache="true"  
  63.       statementType="PREPARED"  
  64.       timeout="20">  
  65. </mapper></span>  

上面給出了一個比較全面的配置說明,但是在實際使用過程中並不需要都進行配置,可根據自己的需要刪除部分配置項。

在這裏,我列舉出我自己的配置文件,精簡之後是這樣的:

[html] view plain copy
  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;"><?xml version="1.0" encoding="UTF-8" ?>     
  2. <!DOCTYPE mapper     
  3. PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"    
  4. "http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">  
  5. <mapper namespace="com.majing.learning.mybatis.dao.UserDao">  
  6.       
  7.     <insert id="addUser" parameterType="user" useGeneratedKeys="true" keyProperty="id">  
  8.         insert into user(name,password,age) values(#{name},#{password},#{age})  
  9.     </insert>  
  10.       
  11.     <delete id="deleteUser" parameterType="int">  
  12.         delete from user where id = #{id}  
  13.     </delete>  
  14.       
  15.     <update id="updateUser" parameterType="user" >  
  16.         update user set name = #{name}, password = #{password}, age = #{age} where id = #{id}  
  17.     </update>  
  18.       
  19.       
  20.   
  21. </mapper></span>  

這裏的parameterType設置成user是因爲如果不設置的情況下,會自動將類名首字母小寫後的名稱,原來的類名爲User。不過,建議大家還是使用typeAlias進行配置吧。唯一需要說明的就是<insert>元素裏面的useGeneratedKeys和keyProperties屬性,這兩個屬性是用來獲取數據庫中的主鍵的。


在數據庫裏面經常性的會給數據庫表設置一個自增長的列作爲主鍵,如果我們操作數據庫後希望能夠獲取這個主鍵該怎麼弄呢?正如上面所述,如果是支持自增長的數據庫,如mysql數據庫,那麼只需要設置useGeneratedKeys和keyProperties屬性便可以了,但是對於不支持自增長的數據庫(如oracle)該怎麼辦呢?


mybatis裏面在<insert>元素下面提供了<selectKey>子元素用於幫助解決這個問題。來看下配置:

[html] view plain copy
  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;"><selectKey  
  2.         <!-- selectKey 語句結果應該被設置的目標屬性。如果希望得到多個生成的列,也可以是逗號分隔的屬性名稱列表。 -->  
  3.         keyProperty="id"  
  4.         <!-- 結果的類型。MyBatis 通常可以推算出來,但是爲了更加確定寫上也不會有什麼問題。MyBatis 允許任何簡單類型用作主鍵的類型,包括字符串。如果希望作用於多個生成的列,則可以使用一個包含期望屬性的 Object 或一個 Map。 -->  
  5.         resultType="int"  
  6.         <!-- 這可以被設置爲 BEFORE 或 AFTER。如果設置爲 BEFORE,那麼它會首先選擇主鍵,設置 keyProperty 然後執行插入語句。如果設置爲 AFTER,那麼先執行插入語句,然後是 selectKey 元素 - 這和像 Oracle 的數據庫相似,在插入語句內部可能有嵌入索引調用。 -->  
  7.         order="BEFORE"  
  8.         <!-- 與前面相同,MyBatis 支持 STATEMENT,PREPARED 和 CALLABLE 語句的映射類型,分別代表 PreparedStatement 和 CallableStatement 類型。 -->  
  9.         statementType="PREPARED">  
  10. </selectKey>  
  11. </span>  

針對不能使用自增長特性的數據庫,可以使用下面的配置來實現相同的功能:

[html] view plain copy
  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;"><insert id="insertUser" parameterType="com.dy.entity.User">  
  2.            <!-- oracle等不支持id自增長的,可根據其id生成策略,先獲取id -->  
  3.              
  4.         <selectKey resultType="int" order="BEFORE" keyProperty="id">  
  5.               select seq_user_id.nextval as id from dual  
  6.         </selectKey>  
  7.     
  8.            insert into user(id, name, password, age, deleteFlag)   
  9.                values(#{id}, #{name}, #{password}, #{age}, #{deleteFlag})  
  10.    </insert></span>  

講完了insert、update、delete,接下來我們看看用的比較多的select。


(2)select、resultType、resultMap

我們先來看看select元素都有哪些配置可以設置:

[html] view plain copy
  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;"><select  
  2.         <!--  1. id (必須配置)  
  3.         id是命名空間中的唯一標識符,可被用來代表這條語句。   
  4.         一個命名空間(namespace) 對應一個dao接口,   
  5.         這個id也應該對應dao裏面的某個方法(相當於方法的實現),因此id 應該與方法名一致  -->  
  6.        
  7.      id="findUserById"  
  8.        
  9.      <!-- 2. parameterType (可選配置, 默認爲mybatis自動選擇處理)  
  10.         將要傳入語句的參數的完全限定類名或別名, 如果不配置,mybatis會通過ParameterHandler 根據參數類型默認選擇合適的typeHandler進行處理  
  11.         parameterType 主要指定參數類型,可以是int, short, long, string等類型,也可以是複雜類型(如對象) -->  
  12.      parameterType="int"  
  13.        
  14.      <!-- 3. resultType (resultType 與 resultMap 二選一配置)  
  15.          resultType用以指定返回類型,指定的類型可以是基本類型,可以是java容器,也可以是javabean -->  
  16.      resultType="User"  
  17.        
  18.      <!-- 4. resultMap (resultType 與 resultMap 二選一配置)  
  19.          resultMap用於引用我們通過 resultMap標籤定義的映射類型,這也是mybatis組件高級複雜映射的關鍵 -->  
  20.      resultMap="userResultMap"  
  21.        
  22.      <!-- 5. flushCache (可選配置)  
  23.          將其設置爲 true,任何時候只要語句被調用,都會導致本地緩存和二級緩存都會被清空,默認值:false -->  
  24.      flushCache="false"  
  25.        
  26.      <!-- 6. useCache (可選配置)  
  27.          將其設置爲 true,將會導致本條語句的結果被二級緩存,默認值:對 select 元素爲 true -->  
  28.      useCache="true"  
  29.        
  30.      <!-- 7. timeout (可選配置)   
  31.          這個設置是在拋出異常之前,驅動程序等待數據庫返回請求結果的秒數。默認值爲 unset(依賴驅動)-->  
  32.      timeout="10000"  
  33.        
  34.      <!-- 8. fetchSize (可選配置)   
  35.          這是嘗試影響驅動程序每次批量返回的結果行數和這個設置值相等。默認值爲 unset(依賴驅動)-->  
  36.      fetchSize="256"  
  37.        
  38.      <!-- 9. statementType (可選配置)   
  39.          STATEMENT,PREPARED 或 CALLABLE 的一個。這會讓 MyBatis 分別使用 Statement,PreparedStatement 或 CallableStatement,默認值:PREPARED-->  
  40.      statementType="PREPARED"  
  41.        
  42.      <!-- 10. resultSetType (可選配置)   
  43.          FORWARD_ONLY,SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 中的一個,默認值爲 unset (依賴驅動)-->  
  44.      resultSetType="FORWARD_ONLY"></span>  

我們還是從具體的示例來看看,
[html] view plain copy
  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;"><select id="findUserById" resultType="User">  
  2.     select * from user where id = #{id}  
  3. </select></span>  

這裏我們根據用戶id去查詢這個用戶的信息,resultType=User是一個別名,如果我們接觸到的是這種一對一的問題,那麼可以簡單的定義一個實體,這個實體代表數據庫表中的一條記錄即可。但是如果我們遇到一對多的問題呢,就拿這裏的查詢用戶信息來說,如果每個用戶有各種興趣,需要維護每個用戶的興趣信息,那麼我們可能就存在下面的數據表結構:

[javascript] view plain copy
  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;">CREATE TABLE `user` (  
  2.   `id` int(11) NOT NULL AUTO_INCREMENT,  
  3.   `name` varchar(255) NOT NULL,  
  4.   `password` varchar(255) NOT NULL,  
  5.   `age` int(3) DEFAULT NULL,  
  6.   PRIMARY KEY (`id`)  
  7. ) ENGINE=InnoDB AUTO_INCREMENT=15 DEFAULT CHARSET=utf8;  
  8.   
  9. CREATE TABLE `userinterests` (  
  10.   `userid` int(11) DEFAULT NULL,  
  11.   `interestid` int(11) DEFAULT NULL  
  12. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;  
  13.   
  14. CREATE TABLE `interests` (  
  15.   `interestid` int(11) NOT NULL,  
  16.   `interestname` varchar(255) DEFAULT NULL,  
  17.   PRIMARY KEY (`interestid`)  
  18. ) ENGINE=InnoDB DEFAULT CHARSET=utf8;</span>  

其中user表用於記錄用戶信息,interests表用於維護所有的興趣標籤,而userinterests用於維護每個用戶的興趣情況。

這時候,如果我們需要根據用戶id去查詢用戶的信息和興趣信息該怎麼做呢?這時候我們就要用到<select>中的另一個重要屬性了,那就是resultMap。

在配置查詢的返回結果時,resultType和resultMap是二選一的操作。對於比較複雜的查詢結果,一般都會設置成resultMap。

resultMap該怎麼配置呢?又支持哪些配置呢?我們看看下面:

[html] view plain copy
  1. <span style="font-family:'KaiTi_GB2312';font-size:18px;"><resultMap type="" id="">  
  2.       
  3.         <!-- id, 唯一性,注意啦,這個id用於標示這個javabean對象的唯一性, 不一定會是數據庫的主鍵(不要把它理解爲數據庫對應表的主鍵)   
  4.             property屬性對應javabean的屬性名,column對應數據庫表的列名  
  5.             (這樣,當javabean的屬性與數據庫對應表的列名不一致的時候,就能通過指定這個保持正常映射了)  
  6.         -->  
  7.         <id property="" column=""/>  
  8.           
  9.         <!-- result與id相比, 對應普通屬性 -->      
  10.         <result property="" column=""/>  
  11.           
  12.         <!--  
  13.             constructor對應javabean中的構造方法 
  14.          -->  
  15.         <constructor>  
  16.             <!-- idArg 對應構造方法中的id參數 -->  
  17.             <idArg column=""/>  
  18.             <!-- arg 對應構造方法中的普通參數 -->  
  19.             <arg column=""/>  
  20.         </constructor>  
  21.           
  22.         <!--   
  23.             collection,對應javabean中容器類型, 是實現一對多的關鍵   
  24.             property 爲javabean中容器對應字段名  
  25.             column 爲體現在數據庫中列名  
  26.             ofType 就是指定javabean中容器指定的類型  
  27.         -->  
  28.         <collection property="" column="" ofType=""></collection>  
  29.           
  30.         <!--   
  31.             association 爲關聯關係,是實現N對一的關鍵。  
  32.             property 爲javabean中容器對應字段名  
  33.             column 爲體現在數據庫中列名  
  34.             javaType 指定關聯的類型  
  35.          -->  
  36.         <association property="" column="" javaType=""></association>  
  37. </resultMap></span>  
  38. 1  更新單條記錄 

    UPDATE course SET name = 'course1' WHEREid= 'id1';

    2  更新多條記錄的同一個字段爲同一個值

     UPDATEcourseSETname='course1'WHEREidin('id1','id2','id3);

    3  更新多條記錄爲多個字段爲不同的值

    比較普通的寫法,是通過循環,依次執行update語句。

    Mybatis寫法如下: 

    <update id="updateBatch"  parameterType="java.util.List">  
        <foreach collection="list" item="item" index="index" open="" close="" separator=";">
            update course
            <set>
                name=${item.name}
            </set>
            where id = ${item.id}
        </foreach>      
    </update>

    一條記錄update一次,性能比較差,容易造成阻塞

    MySQL沒有提供直接的方法來實現批量更新,但可以使用case when語法來實現這個功能。

     UPDATE course
        SET name = CASE id 
            WHEN 1 THEN 'name1'
            WHEN 2 THEN 'name2'
            WHEN 3 THEN 'name3'
        END, 
        title = CASE id 
            WHEN 1 THEN 'New Title 1'
            WHEN 2 THEN 'New Title 2'
            WHEN 3 THEN 'New Title 3'
        END
    WHERE id IN (1,2,3)

    這條sql的意思是,如果id爲1,則name的值爲name1,title的值爲New Title1;依此類推。

    在Mybatis中的配置則如下:

     <updateid="updateBatch"parameterType="list">

                update course
                <trim prefix="set" suffixOverrides=",">
                 <trim prefix="name=case" suffix="end,">
                     <foreach collection="list" item="item" index="index">
                             <if test="item.name!=null">
                              when id=#{item.id} then #{item.name}
                             </if>
                     </foreach>
                  </trim>
                  <trim prefix="title =case" suffix="end,">
                     <foreach collection="list" item="item" index="index">
                             <if test="item.title!=null">
                              when id=#{item.id} then #{item.title}
                             </if>
                     </foreach>
                  </trim>
                 </trim>
                where
                <foreach collection="list" separator="or" item="item" index="index">
                  id=#{item.id}
              </foreach>
    </update>
    <trim>屬性說明 
    1.prefix,suffix 表示在trim標籤包裹的部分的前面或者後面添加內容 
    2.如果同時有prefixOverrides,suffixOverrides 表示會用prefix,suffix覆蓋Overrides中的內容。 
    3.如果只有prefixOverrides,suffixOverrides 表示刪除開頭的或結尾的xxxOverides指定的內容。
    4  sql批量更新   
         看另外一個示例:
         <updateid="updateBatch"parameterType="java.util.List">
        update mydata_table 
        set  status=
        <foreach collection="list" item="item" index="index" 
            separator=" " open="case ID" close="end">
            when #{item.id} then #{item.status}
        </foreach>
        where id in
        <foreach collection="list" index="index" item="item" 
            separator="," open="(" close=")">
            #{item.id,jdbcType=BIGINT}
        </foreach>
     </update>
         其中when...then...sql中的"switch" 語法。這裏藉助mybatis<foreach>語法來拼湊成了批量更新的sql,上面的意思就是批量更新idupdateBatch參數所傳遞List中的數據的status字段。還可以使用<trim>實現同樣的功能,代碼如下:
    <update id="updateBatch" parameterType="java.util.List">
            update mydata_table
            <trim prefix="set" suffixOverrides=",">
                <trim prefix="status =case" suffix="end,">
                    <foreach collection="list" item="item" index="index">
                         when id=#{item.id} then #{item.status}
                    </foreach>
                </trim>
            </trim>
            where id in
            <foreach collection="list" index="index" item="item" separator="," open="(" close=")">
                #{item.id,jdbcType=BIGINT}
            </foreach>
    </update>
    其結構如下:
        update mydata_table 
        set status = 
        case
            when id = #{item.id} then #{item.status}//此處應該是<foreach>展開值
            ...
        end
        where id in (...);
    如果對要更新的數據進行判斷,只有符合條件的數據才能進行更新,這種情況可以這麼做:
    <trim prefix="status =case" suffix="end,">
         <foreach collection="list" item="item" index="index">
             <if test="item.status !=null and item.status != -1">
                 when id=#{item.id} then #{item.status}
             </if>
         </foreach>
    </trim>
    這樣的話只有要更新的liststatus != null && status != -1的數據才能進行status更新.其他的將使用默認值更新,而不會保持原數據不變.如果要保持原數據不變呢?即滿足條件的更新,不滿足條件的保持原數據不變,簡單的來做就是再加一個<if>,因爲mybatis中沒有if...else...語法,但可以通過多個<if>實現同樣的效果,如下:
    <trim prefix="status =case" suffix="end,">
         <foreach collection="list" item="item" index="index">
             <if test="item.status !=null and item.status != -1">
                 when id=#{item.id} then #{item.status}
             </if>
             <if test="item.status == null or item.status == -1">
                 when id=#{item.id} then mydata_table.status      //這裏就是原數據
             </if>
         </foreach>
    </trim>
    整體批量更新的寫法如下:
    <updateid="updateBatch"parameterType="java.util.List">
            update mydata_table
            <trim prefix="set" suffixOverrides=",">
                <trim prefix="status =case" suffix="end,">
                     <foreach collection="list" item="item" index="index">
                         <if test="item.status !=null and item.status != -1">
                             when id=#{item.id} then #{item.status}
                         </if>
                         <if test="item.status == null or item.status == -1">
                             when id=#{item.id} then mydata_table.status//原數據
                         </if>
                     </foreach>
                </trim>
            </trim>
            where id in
            <foreach collection="list" index="index" item="item" separator="," open="(" close=")">
                #{item.id,jdbcType=BIGINT}
            </foreach>
    </update>
發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章