Mybatis SQL映射文件講解

SQL 映射文件有很少的幾個頂級元素(按照它們應該被定義的順序):

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

select

查詢語句是使用 MyBatis 時最常用的元素之一，對簡單類別的查詢元素是非常簡單的。比如:

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

這個語句被稱作 selectPerson, 使用一個 int (或 Integer) 類型的參數, 並返回一個 HashMap 類型的對象,其中的鍵是列名,值是列對應的值。

這就告訴 MyBatis 創建一個預處理語句參數。使用 JDBC, 這樣的一個參數在 SQL 中會由一個“?”來標識,並被傳遞到一個新的預處理語句中,就像這樣:

// Similar JDBC code, NOT MyBatis…
String selectPerson = "SELECT * FROM PERSON WHERE ID=?";
PreparedStatement ps = conn.prepareStatement(selectPerson);
ps.setInt(1,id);

默認情況下,使用#{}格式的語法會導致 MyBatis 創建預處理語句屬性並以它爲背景設置安全的值(比如?) 。這樣做很安全,很迅速也是首選做法,有時你只是想直接在 SQL 語句中插入一個不改變的字符串。比如,像 ORDER BY,你可以這樣來使用:

ORDER BY ${columnName}

這裏 MyBatis 不會修改或轉義字符串，接受從用戶輸出的內容並提供給語句中不變的字符串,這樣做是不安全的。這會導致潛在的 SQL 注入攻擊,因此你不應該允許用戶輸入這些字段,或者通常自行轉義並檢查。

select 元素有很多屬性允許你配置,來決定每條語句的作用細節。

id
在命名空間中唯一的標識符,可以被用來引用這條語句。
parameterType
將會傳入這條語句的參數類的完全限定名或別名,參數可以是基本數據類型，也可以是一個對象。
parameterMap
這是引用外部 parameterMap 的已經被廢棄的方法。使用內聯參數映射和 parameterType 屬性。
resultType
從這條語句中返回的期望類型的類的完全限定名或別名。注意集合情形,那應該是集合可以包含的類型,而不能是集合本身。使用 resultType 或 resultMap,但不能同時使用。
resultMap
命名引用外部的 resultMap。返回 map 是 MyBatis 最具力量的特性, 對其有一個很好的理解的話, 許多複雜映射的情形就能被解決了。通俗來講pojo屬性與表中列名不區分大小寫情況下相同使用resultType，不同使用resultMap。
flushCache
將其設置爲 true,不論語句什麼時候被調用,都會導致緩存被清空。默認值:false。
useCache
將其設置爲 true, 將會導致本條語句的結果被緩存。默認值: true。
timeout
這個設置驅動程序等待數據庫返回請求結果,並拋出異常時間的最大等待值。默認不設置(驅動自行處理)
fetchSize
這是暗示驅動程序每次批量返回的結果行數。默認不設置(驅動自行處理)。
statementType
STATEMENT,PREPARED 或 CALLABLE 的一種。這會讓 MyBatis 使用選擇使用 Statement,PreparedStatement 或 CallableStatement。默認值:PREPARED。

insert, update and delete

數據變更語句 insert,update 和 delete 在它們的實現中非常相似:

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

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

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

sql

這個元素可以被用來定義可重用的 SQL 代碼段,可以包含在其他語句中。比如:

<sql id="userColumns"> 
  id,username,password
</sql>

這個 SQL 片段可以被包含在其他語句中,例如:

<select id="selectUsers" parameterType="int" resultType="hashmap">
  select <include refid="userColumns"/>
  from some_table
  where id = #{id}
</select>

ResultMap

<resultMap id="userResultMap" type="User">
  <id property="id" column="user_id" />
  <result property="username" column="username"/>
  <result property="password" column="password"/>
</resultMap>

引用它的語句使用 resultMap 屬性就行了(注意我們去掉了 resultType 屬性)。比如:

<select id="selectUsers" parameterType="int" resultMap="userResultMap">
  select user_id, user_name, hashed_password
  from some_table
  where id = #{id}
</select>

ResultMap功能是非常強大的，裏面還涉及到各種嵌套查詢，這塊會單獨討論。

緩存

MyBatis 包含一個非常強大的查詢緩存特性,它可以非常方便地配置和定製。MyBatis 3 中的緩存實現的很多改進都已經實現了,使得它更加強大而且易於配置。

默認情況下是沒有開啓緩存的,除了局部的 session 緩存,可以增強變現而且處理循環依賴也是必須的。要開啓二級緩存,你需要在你的 SQL 映射文件中添加一行:

<cache/>

字面上看就是這樣。這個簡單語句的效果如下:

•映射語句文件中的所有 select 語句將會被緩存。
•映射語句文件中的所有 insert,update 和 delete 語句會刷新緩存。
•緩存會使用 Least Recently Used(LRU,最近最少使用的)算法來收回。
•根據時間表(比如 no Flush Interval,沒有刷新間隔), 緩存不會以任何時間順序來刷新。
•緩存會存儲列表集合或對象(無論查詢方法返回什麼)的 1024 個引用。
•緩存會被視爲是 read/write(可讀/可寫)的緩存,意味着對象檢索不是共享的,而且可以安全地被調用者修改,而不干擾其他調用者或線程所做的潛在修改。

所有的這些屬性都可以通過緩存元素的屬性來修改。比如:

<cache
  eviction="FIFO"
  flushInterval="60000"
  size="512"
  readOnly="true"/>

這個更高級的配置創建了一個 FIFO 緩存,並每隔 60 秒刷新,存數結果對象或列表的 512 個引用,而且返回的對象被認爲是隻讀的,因此在不同線程中的調用者之間修改它們會導致衝突。

可用的收回策略有:

•LRU – 最近最少使用的:移除最長時間不被使用的對象。
•FIFO – 先進先出:按對象進入緩存的順序來移除它們。
•SOFT – 軟引用:移除基於垃圾回收器狀態和軟引用規則的對象。
•WEAK – 弱引用:更積極地移除基於垃圾收集器狀態和弱引用規則的對象。
默認的是 LRU。

flushInterval(刷新間隔)可以被設置爲任意的正整數,而且它們代表一個合理的毫秒形式的時間段。默認情況是不設置,也就是沒有刷新間隔,緩存僅僅調用語句時刷新。

size(引用數目)可以被設置爲任意正整數,要記住你緩存的對象數目和你運行環境的可用內存資源數目。默認值是 1024。

readOnly(只讀)屬性可以被設置爲 true 或 false。只讀的緩存會給所有調用者返回緩存對象的相同實例。因此這些對象不能被修改。這提供了很重要的性能優勢。可讀寫的緩存會返回緩存對象的拷貝(通過序列化) 。這會慢一些,但是安全,因此默認是 false。

參照緩存

這個特殊命名空間的唯一緩存會被使用或者刷新相同命名空間內的語句。也許將來的某個時候,你會想在命名空間中共享相同的緩存配置和實例。在這樣的情況下你可以使用 cache-ref 元素來引用另外一個緩存。

<cache-ref namespace="com.someone.application.data.SomeMapper"/>

Mybatis SQL映射文件講解