SQL 映射文件只有很少的幾個(gè)頂級(jí)元素（按照應(yīng)被定義的順序列出）：

• cache – 對(duì)給定命名空間的緩存配置。
• cache-ref – 對(duì)其他命名空間緩存配置的引用。
• resultMap – 是最復(fù)雜也是最強(qiáng)大的元素，用來(lái)描述如何從數(shù)據(jù)庫(kù)結(jié)果集中來(lái)加載對(duì)象。
• parameterMap – 已被廢棄！老式風(fēng)格的參數(shù)映射。更好的辦法是使用內(nèi)聯(lián)參數(shù)，此元素可能在將來(lái)被移除。
• sql – 可被其他語(yǔ)句引用的可重用語(yǔ)句塊。
• insert – 映射插入語(yǔ)句
• update – 映射更新語(yǔ)句
• delete – 映射刪除語(yǔ)句
• select – 映射查詢語(yǔ)句

select

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

這個(gè)語(yǔ)句被稱作 selectPerson，接受一個(gè) int（或 Integer）類型的參數(shù)，并返回一個(gè) HashMap 類型的對(duì)象，其中的鍵是列名，值便是結(jié)果行中的對(duì)應(yīng)值。

注意參數(shù)符號(hào)：#{id}

這就告訴 MyBatis 創(chuàng)建一個(gè)預(yù)處理語(yǔ)句（PreparedStatement）參數(shù)，在 JDBC 中，這樣的一個(gè)參數(shù)在 SQL 中會(huì)由一個(gè)“?”來(lái)標(biāo)識(shí)，并被傳遞到一個(gè)新的預(yù)處理語(yǔ)句中，就像這樣：

// 近似的 JDBC 代碼，非 MyBatis 代碼...
 String selectPerson = "SELECT * FROM PERSON WHERE ID=?";
 PreparedStatement ps = conn.prepareStatement(selectPerson);
 ps.setInt(1,id);
 <select
   id="selectPerson"
   parameterType="int"
   parameterMap="deprecated"
   resultType="hashmap"
   resultMap="personResultMap"
   flushCache="false"
   useCache="true"
   timeout="10"
   fetchSize="256"
   statementType="PREPARED"
   resultSetType="FORWARD_ONLY">

insert, update 和 delete

數(shù)據(jù)變更語(yǔ)句 insert，update 和 delete 的實(shí)現(xiàn)非常接近：

<insert
   id="insertAuthor"
   parameterType="domain.blog.Author"
   flushCache="true"
   statementType="PREPARED"
   keyProperty=""
   keyColumn=""
   useGeneratedKeys=""
   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">

生成主鍵

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

 <selectKey resultType="java.lang.Long" order="AFTER" keyProperty="id">
   SELECT LAST_INSERT_ID() AS id
 </selectKey>

sql

這個(gè)元素可以被用來(lái)定義可重用的 SQL 代碼段，這些 SQL 代碼可以被包含在其他語(yǔ)句中。它可以（在加載的時(shí)候）被靜態(tài)地設(shè)置參數(shù)。 在不同的包含語(yǔ)句中可以設(shè)置不同的值到參數(shù)占位符上。比如：

<sql id="userColumns"> ${alias}.id,${alias}.username,${alias}.password </sql>
 <select id="selectUsers" resultType="map">
   select
     <include refid="userColumns"><property name="alias" value="t1"/></include>,
     <include refid="userColumns"><property name="alias" value="t2"/></include>
   from some_table t1
     cross join some_table t2
 </select>

結(jié)果映射

resultMap 元素是 MyBatis 中最重要最強(qiáng)大的元素，在一些情形下允許你進(jìn)行一些 JDBC 不支持的操作。實(shí)際上，在為一些比如連接的復(fù)雜語(yǔ)句編寫(xiě)映射代碼的時(shí)候，一份 resultMap 能夠代替實(shí)現(xiàn)同等功能的長(zhǎng)達(dá)數(shù)千行的代碼。ResultMap 的設(shè)計(jì)思想是，對(duì)于簡(jiǎn)單的語(yǔ)句根本不需要配置顯式的結(jié)果映射，而對(duì)于復(fù)雜一點(diǎn)的語(yǔ)句只需要描述它們的關(guān)系就行了。

在JavaBean中定義一個(gè)有 3 個(gè)屬性：id，username 和 hashedPassword的類，然后在mapper.xml中，這些屬性會(huì)對(duì)應(yīng)到 select 語(yǔ)句中的列名，這樣的一個(gè) JavaBean 可以被映射到 ResultSet，就像映射到 HashMap 一樣簡(jiǎn)單。

<select id="selectUsers" resultType="com.someapp.model.User">
   select id, username, hashedPassword
   from some_table
   where id = #{id}
 </select>

像第三中的第三個(gè)例子，也可以定義外部resultMap，這也是解決列名不匹配的另外一種方式。

 <resultMap id="userResultMap" type="User">
   <id property="id" column="user_id" />
   <result property="username" column="user_name"/>
   <result property="password" column="hashed_password"/>
 </resultMap>
 ​
 <select id="selectUsers" resultMap="userResultMap">
   select user_id, user_name, hashed_password
   from some_table
   where id = #{id}
 </select>

結(jié)果映射（resultMap）

• constructor-用于在實(shí)例化類時(shí)，注入結(jié)果到構(gòu)造方法中
• idArg - ID 參數(shù)；標(biāo)記出作為 ID 的結(jié)果可以幫助提高整體性能
• arg - 將被注入到構(gòu)造方法的一個(gè)普通結(jié)果
• id – 一個(gè) ID 結(jié)果；標(biāo)記出作為 ID 的結(jié)果可以幫助提高整體性能
• result – 注入到字段或 JavaBean 屬性的普通結(jié)果
• association– 一個(gè)復(fù)雜類型的關(guān)聯(lián)；許多結(jié)果將包裝成這種類型
• 嵌套結(jié)果映射 – 關(guān)聯(lián)本身可以是一個(gè) resultMap 元素，或者從別處引用一個(gè)
• collection– 一個(gè)復(fù)雜類型的集合
• 嵌套結(jié)果映射 – 集合本身可以是一個(gè) resultMap 元素，或者從別處引用一個(gè)
• discriminator– 使用結(jié)果值來(lái)決定使用哪個(gè)resultMap
• case– 基于某些值的結(jié)果映射
• 嵌套結(jié)果映射 – case 本身可以是一個(gè) resultMap 元素，因此可以具有相同的結(jié)構(gòu)和元素，或者從別處引用一個(gè)。

id & result

 <id property="id" column="post_id"/>
 <result property="subject" column="post_subject"/>

這些是結(jié)果映射最基本的內(nèi)容。id 和 result 元素都將一個(gè)列的值映射到一個(gè)簡(jiǎn)單數(shù)據(jù)類型（String, int, double, Date 等）的屬性或字段。

這兩者之間的唯一不同是，id 元素表示的結(jié)果將是對(duì)象的標(biāo)識(shí)屬性，這會(huì)在比較對(duì)象實(shí)例時(shí)用到。 這樣可以提高整體的性能，尤其是進(jìn)行緩存和嵌套結(jié)果映射（也就是連接映射）的時(shí)候。

緩存

默認(rèn)情況下，只啟用了本地的會(huì)話緩存，它僅僅對(duì)一個(gè)會(huì)話中的數(shù)據(jù)進(jìn)行緩存。 要啟用全局的二級(jí)緩存，只需要在你的 SQL 映射文件中添加一行：<cache/>

基本上就是這樣。這個(gè)簡(jiǎn)單語(yǔ)句的效果如下:

• 映射語(yǔ)句文件中的所有 select 語(yǔ)句的結(jié)果將會(huì)被緩存。
• 映射語(yǔ)句文件中的所有 insert、update 和 delete 語(yǔ)句會(huì)刷新緩存。
• 緩存會(huì)使用最近最少使用算法（LRU, Least Recently Used）算法來(lái)清除不需要的緩存。
• 緩存不會(huì)定時(shí)進(jìn)行刷新（也就是說(shuō)，沒(méi)有刷新間隔）。
• 緩存會(huì)保存列表或?qū)ο螅o(wú)論查詢方法返回哪種）的 1024 個(gè)引用。
• 緩存會(huì)被視為讀/寫(xiě)緩存，這意味著獲取到的對(duì)象并不是共享的，可以安全地被調(diào)用者修改，而不干擾其他調(diào)用者或線程所做的潛在修改。

提示 緩存只作用于 cache 標(biāo)簽所在的映射文件中的語(yǔ)句。如果你混合使用 Java API 和 XML 映射文件，在共用接口中的語(yǔ)句將不會(huì)被默認(rèn)緩存。你需要使用 @CacheNamespaceRef 注解指定緩存作用域。

這些屬性可以通過(guò) cache 元素的屬性來(lái)修改。比如：

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

這個(gè)更高級(jí)的配置創(chuàng)建了一個(gè) FIFO 緩存，每隔 60 秒刷新，最多可以存儲(chǔ)結(jié)果對(duì)象或列表的 512 個(gè)引用，而且返回的對(duì)象被認(rèn)為是只讀的，因此對(duì)它們進(jìn)行修改可能會(huì)在不同線程中的調(diào)用者產(chǎn)生沖突。

可用的清除策略有：

• LRU – 最近最少使用：移除最長(zhǎng)時(shí)間不被使用的對(duì)象。
• FIFO – 先進(jìn)先出：按對(duì)象進(jìn)入緩存的順序來(lái)移除它們。
• SOFT – 軟引用：基于垃圾回收器狀態(tài)和軟引用規(guī)則移除對(duì)象。
• WEAK – 弱引用：更積極地基于垃圾收集器狀態(tài)和弱引用規(guī)則移除對(duì)象。

默認(rèn)的清除策略是 LRU。

flushInterval（刷新間隔）屬性可以被設(shè)置為任意的正整數(shù)，設(shè)置的值應(yīng)該是一個(gè)以毫秒為單位的合理時(shí)間量。 默認(rèn)情況是不設(shè)置，也就是沒(méi)有刷新間隔，緩存僅僅會(huì)在調(diào)用語(yǔ)句時(shí)刷新。

size（引用數(shù)目）屬性可以被設(shè)置為任意正整數(shù)，要注意欲緩存對(duì)象的大小和運(yùn)行環(huán)境中可用的內(nèi)存資源。默認(rèn)值是 1024。

readOnly（只讀）屬性可以被設(shè)置為 true 或 false。只讀的緩存會(huì)給所有調(diào)用者返回緩存對(duì)象的相同實(shí)例。 因此這些對(duì)象不能被修改。這就提供了可觀的性能提升。而可讀寫(xiě)的緩存會(huì)（通過(guò)序列化）返回緩存對(duì)象的拷貝。 速度上會(huì)慢一些，但是更安全，因此默認(rèn)值是 false。

提示 二級(jí)緩存是事務(wù)性的。這意味著，當(dāng) SqlSession 完成并提交時(shí)，或是完成并回滾，但沒(méi)有執(zhí)行 flushCache=true 的 insert/delete/update 語(yǔ)句時(shí)，緩存會(huì)獲得更新。

使用自定義緩存

除了上述自定義緩存的方式，你也可以通過(guò)實(shí)現(xiàn)你自己的緩存，或?yàn)槠渌谌骄彺娣桨竸?chuàng)建適配器，來(lái)完全覆蓋緩存行為。

 <cache type="com.domain.something.MyCustomCache"/>

例子：

type 屬性指定的類必須實(shí)現(xiàn) org.mybatis.cache.Cache 接口，且提供一個(gè)接受 String 參數(shù)作為 id 的構(gòu)造器。 這個(gè)接口是 MyBatis 框架中許多復(fù)雜的接口之一，但是行為卻非常簡(jiǎn)單。

 public interface Cache {
   String getId();
   int getSize();
   void putObject(Object key, Object value);
   Object getObject(Object key);
   boolean hasKey(Object key);
   Object removeObject(Object key);
   void clear();
 }

動(dòng)態(tài)SQL

• Mybatis 動(dòng)態(tài) SQL ，可以讓我們?cè)?XML 映射文件內(nèi)，以 XML 標(biāo)簽的形式編寫(xiě)動(dòng)態(tài) SQL ，完成邏輯判斷和動(dòng)態(tài)拼接 SQL 的功能。
• Mybatis 提供了 9 種動(dòng)態(tài) SQL 標(biāo)簽：<if />、<choose />、<when />、<otherwise />、<trim />、<where />、<set />、<foreach />、<bind /> 。
• 其執(zhí)行原理為，使用 OGNL 的表達(dá)式，從 SQL 參數(shù)對(duì)象中計(jì)算表達(dá)式的值，根據(jù)表達(dá)式的值動(dòng)態(tài)拼接 SQL ，以此來(lái)完成動(dòng)態(tài) SQL 的功能。

if

動(dòng)態(tài) SQL 通常要做的事情是根據(jù)條件包含 where 子句的一部分。比如：

 <select id="findActiveBlogWithTitleLike"
      resultType="Blog">
   SELECT * FROM BLOG
   WHERE state = ‘ACTIVE'
   <if test="title != null">
     AND title like #{title}
   </if>
 </select>

這條語(yǔ)句提供了一種可選的查找文本功能。如果沒(méi)有傳入“title”，那么所有處于“ACTIVE”狀態(tài)的BLOG都會(huì)返回；反之若傳入了“title”，那么就會(huì)對(duì)“title”一列進(jìn)行模糊查找并返回 BLOG 結(jié)果（“title”參數(shù)值是可以包含一些掩碼或通配符的）。

通過(guò)“title”和“author”兩個(gè)參數(shù)進(jìn)行可選搜索:

 <select id="findActiveBlogLike"
      resultType="Blog">
   SELECT * FROM BLOG WHERE state = ‘ACTIVE'
   <if test="title != null">
     AND title like #{title}
   </if>
   <if test="author != null and author.name != null">
     AND author_name like #{author.name}
   </if>
 </select>

choose, when, otherwise

有時(shí)我們不想應(yīng)用到所有的條件語(yǔ)句，而只想從中擇其一項(xiàng)。針對(duì)這種情況，MyBatis 提供了 choose 元素，它有點(diǎn)像 Java 中的 switch 語(yǔ)句。

這次變?yōu)樘峁┝恕皌itle”就按“title”查找，提供了“author”就按“author”查找的情形，若兩者都沒(méi)有提供，就返回所有符合條件的 BLOG（實(shí)際情況可能是由管理員按一定策略選出 BLOG 列表，而不是返回大量無(wú)意義的隨機(jī)結(jié)果）。

 <select id="findActiveBlogLike"
      resultType="Blog">
   SELECT * FROM BLOG WHERE state = ‘ACTIVE'
   <choose>
     <when test="title != null">
       AND title like #{title}
     </when>
     <when test="author != null and author.name != null">
       AND author_name like #{author.name}
     </when>
     <otherwise>
       AND featured = 1
     </otherwise>
   </choose>
 </select>

trim, where, set

上面的幾個(gè)例子，如果條件不滿足的話，會(huì)拼湊成不成一條sql語(yǔ)句，導(dǎo)致無(wú)法查詢，如：SELECT * FROM BLOG WHERE

 <select id="findActiveBlogLike"
      resultType="Blog">
   SELECT * FROM BLOG
   <where>
     <if test="state != null">
          state = #{state}
     </if>
     <if test="title != null">
         AND title like #{title}
     </if>
     <if test="author != null and author.name != null">
         AND author_name like #{author.name}
     </if>
   </where>
 </select>

where 元素只會(huì)在至少有一個(gè)子元素的條件返回 SQL 子句的情況下才去插入“WHERE”子句。而且，若語(yǔ)句的開(kāi)頭為“AND”或“OR”，where 元素也會(huì)將它們?nèi)コ?/p>

如果 where 元素沒(méi)有按正常套路出牌，我們可以通過(guò)自定義 trim 元素來(lái)定制 where 元素的功能。比如，和 where 元素等價(jià)的自定義 trim 元素為：

 <trim prefix="WHERE" prefixOverrides="AND |OR ">
   ...
 </trim>

prefixOverrides 屬性會(huì)忽略通過(guò)管道分隔的文本序列（注意此例中的空格也是必要的）。它的作用是移除所有指定在 prefixOverrides 屬性中的內(nèi)容，并且插入 prefix 屬性中指定的內(nèi)容。

類似的用于動(dòng)態(tài)更新語(yǔ)句的解決方案叫做 set。set 元素可以用于動(dòng)態(tài)包含需要更新的列，而舍去其它的。比如：

 <update id="updateAuthorIfNecessary">
   update Author
     <set>
       <if test="username != null">username=#{username},</if>
       <if test="password != null">password=#{password},</if>
       <if test="email != null">email=#{email},</if>
       <if test="bio != null">bio=#{bio}</if>
     </set>
   where id=#{id}
 </update>

這里，set 元素會(huì)動(dòng)態(tài)前置 SET 關(guān)鍵字，同時(shí)也會(huì)刪掉無(wú)關(guān)的逗號(hào)，因?yàn)橛昧藯l件語(yǔ)句之后很可能就會(huì)在生成的 SQL 語(yǔ)句的后面留下這些逗號(hào)。（譯者注：因?yàn)橛玫氖恰癷f”元素，若最后一個(gè)“if”沒(méi)有匹配上而前面的匹配上，SQL 語(yǔ)句的最后就會(huì)有一個(gè)逗號(hào)遺留）

若你對(duì) set 元素等價(jià)的自定義 trim 元素的代碼感興趣，那這就是它的真面目：

 <trim prefix="SET" suffixOverrides=",">
   ...
 </trim>

注意這里我們刪去的是后綴值，同時(shí)添加了前綴值。

foreach

動(dòng)態(tài) SQL 的另外一個(gè)常用的操作需求是對(duì)一個(gè)集合進(jìn)行遍歷，通常是在構(gòu)建 IN 條件語(yǔ)句的時(shí)候。比如：

 <select id="selectPostIn" resultType="domain.blog.Post">
   SELECT *
   FROM POST P
   WHERE ID in
   <foreach item="item" index="index" collection="list"
       open="(" separator="," close=")">
         #{item}
   </foreach>
 </select>

foreach 元素的功能非常強(qiáng)大，它允許你指定一個(gè)集合，聲明可以在元素體內(nèi)使用的集合項(xiàng)（item）和索引（index）變量。它也允許你指定開(kāi)頭與結(jié)尾的字符串以及在迭代結(jié)果之間放置分隔符。這個(gè)元素是很智能的，因此它不會(huì)偶然地附加多余的分隔符。

注意

可以將任何可迭代對(duì)象（如 List、Set 等）、Map 對(duì)象或者數(shù)組對(duì)象傳遞給 foreach 作為集合參數(shù)。當(dāng)使用可迭代對(duì)象或者數(shù)組時(shí)，index 是當(dāng)前迭代的次數(shù)，item 的值是本次迭代獲取的元素。當(dāng)使用 Map 對(duì)象（或者 Map.Entry 對(duì)象的集合）時(shí)，index 是鍵，item 是值。

bind

bind 元素可以從 OGNL 表達(dá)式中創(chuàng)建一個(gè)變量并將其綁定到上下文。比如：

 <select id="selectBlogsLike" resultType="Blog">
   <bind name="pattern" value="'%' + _parameter.getTitle() + '%'" />
   SELECT * FROM BLOG
   WHERE title LIKE #{pattern}
 </select>

以上為個(gè)人經(jīng)驗(yàn)，希望能給大家一個(gè)參考，也希望大家多多支持腳本之家。

最新評(píng)論