Mapper XML 文件

MyBatis 的真正強大在於它的映射語句，也是它的魔力所在。由於它的異常強大，映射器的 XML 文件就顯得相對簡單。如果拿它跟具有相同功能的 JDBC 代碼進行對比，你會立即發現省掉了將近 95% 的代碼。MyBatis 就是針對 SQL 構建的，並且比普通的方法做的更好。

同樣需要介紹定級元素:

mapper

• cache – 給定命名空間的緩存配置。
• cache-ref – 其他命名空間緩存配置的引用。
• resultMap – 是最復雜也是最強大的元素，用來描述如何從數據庫結果集中來加載對象。
• parameterMap – 已廢棄！老式風格的參數映射。內聯參數是首選,這個元素可能在將來被移除，這裏不會記錄。
• sql – 可被其他語句引用的可重用語句塊。
• insert – 映射插入語句
• update – 映射更新語句
• delete – 映射刪除語句
• select – 映射查詢語句

1.mapper 根節點

有且必須只有一個屬性值:namespace, 建議設置為Mapper接口的全限定名

<mapper namespace="com.baoxian.dao.UserInfoMapper">
    ...
</mapper>

2.select 元素

2.1 簡單的select語句

<select id="selectPerson" parameterType
 
="int" resultType="hashmap">
  SELECT * FROM PERSON WHERE ID = #{id}
</select>

解釋一下上面配置:

這個語句被稱作 selectPerson，接受一個 int（或 Integer）類型的參數，並返回一個 HashMap 類型的對象，其中的鍵是列名，值便是結果行中的對應值。

假如調用該條SQL傳入的 參數為 1,selectPerson(1)
原來的sql語句經過處理後相當於 SELECT * FROM PERSON WHERE ID = ?  
?相當於參數的占位符
調用時傳入的 參數值 將會被替換
 

2.2 select元素中的所有屬性

<select
  id="selectPerson"　　　　　　#必須
  parameterType="int"  　　　 #可選,寫出來會更加直觀
  parameterMap="deprecated"　#已不使用
  resultType="hashmap"　　　　#必須指定
  resultMap="personResultMap"#自定義結果集的映射
  flushCache="false"         #調用該語句是否刷新緩存,一般insert update delete 會配置成true
  useCache="true"            #
  timeout="10000"            # 語句最大等待時間 10S
  fetchSize="256"　　　　　　  # 
  statementType="PREPARED"
  resultSetType="FORWARD_ONLY">

2.3 insert ,update,delete

<insert
  id="insertAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  keyProperty=""      #將JDBC生成的主鍵值 賦值給keyProperty對應的屬性名
  keyColumn=""
  useGeneratedKeys="" #取出JDBC生成的主鍵
  timeout="20">

<update
  id="updateAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  timeout="20">

<delete
  id="deleteAuthor"
  parameterType="domain.blog.Author"
  flushCache="true"
  statementType="PREPARED"
  timeout="20">

insert,update,delete語句實例:

<insert id="insertAuthor">
  insert into Author (id,username,password,email,bio)
  values (#{id},#{username},#{password},#{email},#{bio})
</insert>

<update id="updateAuthor">
  update Author set
    username = #{username},
    password = #{password},
    email = #{email},
    bio = #{bio}
  where id = #{id}
</update>

<delete id="deleteAuthor">
  delete from Author where id = #{id}
</delete>

如果設置了主鍵自增,則上述insert語句可以更改為:

<insert id="insertAuthor" useGeneratedKeys="true"
    keyProperty="id">
  insert into Author (username,password,email,bio)
  values (#{username},#{password},#{email},#{bio})
</insert>

如果數據庫支持多行插入(例如MySQL數據庫),則insert語句可以修改為:

<insert id="insertAuthor" useGeneratedKeys="true"
    keyProperty="id">
  insert into Author (username, password, email, bio) values
  <foreach item="item" collection="list" separator=",">
    (#{item.username}, #{item.password}, #{item.email}, #{item.bio})
  </foreach>
</insert>

其中foreach 會對集合進行叠代 , item 表示集合中每個元素,collection 表示集合的類型, separator表示分隔符,並且智能的在最後一個元素後去除分隔符

如果數據庫不支持自動生成主鍵,則可以使用另外一種 MyBatis提供的方式

<insert id="insertAuthor">
  <selectKey keyProperty="id" resultType="int" order="BEFORE">
    select CAST(RANDOM()*1000000 as INTEGER) a from SYSIBM.SYSDUMMY1
  </selectKey>
  insert into Author
    (id, username, password, email,bio, favourite_section)
  values
    (#{id}, #{username}, #{password}, #{email}, #{bio}, #{favouriteSection,jdbcType=VARCHAR})
</insert>

上述語句的執行順序是,先執行自動生成隨機ID的語句, 並將隨機生成的值轉成int類型 再通過set方法 設置到Author的id屬性中,從而執行插入時,id屬性值將對應數據庫的id列,插入到數據庫中

selectKey 的重要屬性如下:

<selectKey
  keyProperty="id"
  resultType="int"
  order="BEFORE" 
  statementType="PREPARED">

2.4 sql

sql元素可以用來定義可復用的sql代碼:

<sql id="fromClause">
    /*通過${}取調用者傳遞的屬性值*/
    from ${tableName}
</sql>

使用<include>元素調用定義的sql元素,以下是簡單的實現了復用的效果,往往實際中會更加復雜:

<!--通過ID查找用戶-->
  <select id="selectUserById" resultMap="BaseResultMap" parameterType="java.lang.Long" >
    select id,userName,age
    /*通過property屬性 向sql元素動態傳遞參數值,兩邊規定好property的屬性名稱即可*/
    <include refid="fromClause">
      <property name="tableName" value="userinfo"/>
    </include>
    where id = #{id}
  </select>

  <!--查詢出所有用戶-->
  <select id="selectAll" resultMap="BaseResultMap" >
    select id, username,age
    <include refid="fromClause">
      <property name="tableName" value="userinfo"/>
    </include>
  </select>

此外,調用者傳遞過的屬性值,同樣也可以使用在include 元素的 refid,例如:

<sql id="sometable">
  ${prefix}Table
</sql>

<sql id="someinclude">
  from
    <include refid="${include_target}"/>
</sql>

<select id="select" resultType="map">
  select
    field1, field2, field3
  <include refid="someinclude">
    <property name="prefix" value="Some"/>
    <property name="include_target" value="sometable"/>
  </include>
</select>

2.5 參數 parameters

sql語句接收的參數有兩種類型,一種是基本類型,另一種是復雜的對象類型

如果sql語句 接收的參數是一個對象.那麽傳遞過來的對象要提供相應的getter方法,此時mybatis才能正確的取出屬性值

例如:

<!--通過ID更新用戶-->
  <update id="updateByPrimaryKey" parameterType="com.baoxian.domain.UserInfo" >
    update UserInfo
    set username = #{userName},age = #{age}
    where id = #{id}
  </update>

每一個參數都支持為其指定特殊的類型

格式如下:

<!--通過ID更新用戶-->
  <update id="updateByPrimaryKey" parameterType="com.baoxian.domain.UserInfo" >
    update UserInfo
    set username = #{userName},age = #{age,javaType=int,jdbcType=NUMERIC}
    where id = #{id}
  </update>

其中age參數,指明java類型是int , jdbcType是NUMERIC

如果傳遞一個為null的參數值到數據庫中,並且該列允許為null,那麽必須為該參數指定javaType

除了javaType,與 jdbcType之外,還可以指定以下:

typeHandler: 需要特殊類型處理器處理參數的映射 (幾乎不用這麽做)

numericScale:如果參數值是一個小數,希望保存進數據庫的值 保留小數點後兩位 ,則可以通這樣實現: #{salary,javaType=double,jdbcType=NUMERIC,numericScale=2}

mode:該屬性有三個可選值,IN,OUT,及INOUT;如果參數為 OUT 或 INOUT，參數對象屬性的真實值將會被改變，就像你在獲取輸出參數時所期望的那樣。

如果 mode 為 OUT（或 INOUT），而且 jdbcType 為 CURSOR(也就是 Oracle 的 REFCURSOR)，你必須指定一個 resultMap 來映射結果集 ResultMap 到參數類型。
要註意這裏的 javaType 屬性是可選的，如果留空並且 jdbcType 是 CURSOR，它會被自動地被設為 ResultMap。

說了那麽多,其實更多時候,我們90%的情況是不需要為參數指定什麽額外屬性,MyBatis已經幫你做好該做的

最多在java參數為null時,指定javaType即可

2.6 字符串替換

使用#{} 會生成一個預處理參數,提高了SQL的安全性, 但有時不希望對參數值進行轉義,保持參數原本的值,則可以使用 ${}進行取值

MyBatis框架淺析之 Mapper.xml 映射文件