MyBatis 真正的力量是在映射語(yǔ)句中。這里是奇跡發(fā)生的地方。對(duì)于所有的力量,SQL 映射的 XML 文件是相當(dāng)?shù)暮?jiǎn)單。當(dāng)然如果你將它們和對(duì)等功能的 JDBC 代碼來(lái)比較,你會(huì)發(fā)現(xiàn)映射文件節(jié)省了大約 95%的代碼量。MyBatis 的構(gòu)建就是聚焦于 SQL 的,使其遠(yuǎn)離于普通的方式。

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

• cache – 配置給定命名空間的緩存。

• cache-ref – 從其他命名空間引用緩存配置。

• resultMap – 最復(fù)雜,也是最有力量的元素,用來(lái)描述如何從數(shù)據(jù)庫(kù)結(jié)果集中來(lái)加載你的對(duì)象。

• parameterMap – 已經(jīng)被廢棄了!老式風(fēng)格的參數(shù)映射。內(nèi)聯(lián)參數(shù)是首選,這個(gè)元素可能在將來(lái)被移除。這里不會(huì)記錄。

• sql – 可以重用的 SQL 塊,也可以被其他語(yǔ)句引用。

• insert – 映射插入語(yǔ)句

• update – 映射更新語(yǔ)句

• delete – 映射刪除語(yǔ)句

• select – 映射查詢語(yǔ)句

下一部分將從語(yǔ)句本身開(kāi)始來(lái)描述每個(gè)元素的細(xì)節(jié)。

select

查詢語(yǔ)句是使用 MyBatis 時(shí)最常用的元素之一。直到你從數(shù)據(jù)庫(kù)取出數(shù)據(jù)時(shí)才會(huì)發(fā)現(xiàn)將數(shù)據(jù)存在數(shù)據(jù)庫(kù)中是多么的有價(jià)值, 所以許多應(yīng)用程序查詢要比更改數(shù)據(jù)多的多。對(duì)于每次插入,更新或刪除,那也會(huì)有很多的查詢。這是 MyBatis 的一個(gè)基本原則,也是將重心和努力放到查詢和結(jié)果映射的原因。對(duì)簡(jiǎn)單類別的查詢?cè)厥欠浅：?jiǎn)單的。比如:

SELECT * FROM PERSON WHERE ID = #{id}

這個(gè)語(yǔ)句被稱作 selectPerson, 使用一個(gè) int (或 Integer) 類型的參數(shù), 并返回一個(gè) HashMap 類型的對(duì)象,其中的鍵是列名,值是列對(duì)應(yīng)的值。

注意參數(shù)注釋:

{id}

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

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

當(dāng)然, 這需要很多單獨(dú)的 JDBC 的代碼來(lái)提取結(jié)果并將它們映射到對(duì)象實(shí)例中, 這就是 MyBatis 節(jié)省你時(shí)間的地方。我們需要深入了解參數(shù)和結(jié)果映射。那些細(xì)節(jié)部分我們下面來(lái)了解。

select 元素有很多屬性允許你配置,來(lái)決定每條語(yǔ)句的作用細(xì)節(jié)。

insert, update and delete

數(shù)據(jù)變更語(yǔ)句 insert,update 和 delete 在它們的實(shí)現(xiàn)中非常相似:

下面就是 insert,update 和 delete 語(yǔ)句的示例:

insert into Author (id,username,password,email,bio)
values (#{id},#{username},#{password},#{email},#{bio}) update Author set
username = #{username},
password = #{password},
email = #{email},
bio = #{bio}
where id = #{id} delete from Author where id = #{id}

如前所述,插入語(yǔ)句有一點(diǎn)多,它有一些屬性和子元素用來(lái)處理主鍵的生成。

首先,如果你的數(shù)據(jù)庫(kù)支持自動(dòng)生成主鍵的字段(比如 MySQL 和 SQL Server) ,那么你可以設(shè)置 useGeneratedKeys=”true”,而且設(shè)置 keyProperty 到你已經(jīng)做好的目標(biāo)屬性上。例如,如果上面的 Author 表已經(jīng)對(duì) id 使用了自動(dòng)生成的列類型,那么語(yǔ)句可以修改為:

insert into Author (username,password,email,bio)
values (#{username},#{password},#{email},#{bio})

MyBatis 有另外一種方法來(lái)處理數(shù)據(jù)庫(kù)不支持自動(dòng)生成類型,或者可能 JDBC 驅(qū)動(dòng)不支持自動(dòng)生成主鍵時(shí)的主鍵生成問(wèn)題。

這里有一個(gè)簡(jiǎn)單(甚至很傻)的示例,它可以生成一個(gè)隨機(jī) ID(可能你不會(huì)這么做, 但是這展示了 MyBatis 處理問(wèn)題的靈活性,因?yàn)樗⒉徽娴年P(guān)心 ID 的生成):

    select CAST(RANDOM()*1000000 as INTEGER) a from SYSIBM.SYSDUMMY1
insert into Author

(id, username, password, email,bio, favourite_section)
values
(#{id}, #{username}, #{password}, #{email}, #{bio}, #{favouriteSection,jdbcType=VARCHAR})

在上面的示例中,selectKey 元素將會(huì)首先運(yùn)行,Author 的 id 會(huì)被設(shè)置,然后插入語(yǔ)句會(huì)被調(diào)用。這給你了一個(gè)簡(jiǎn)單的行為在你的數(shù)據(jù)庫(kù)中來(lái)處理自動(dòng)生成的主鍵, 而不需要使你的 Java 代碼變得復(fù)雜。

selectKey 元素描述如下:

sql

這個(gè)元素可以被用來(lái)定義可重用的 SQL 代碼段,可以包含在其他語(yǔ)句中。比如:

id,username,password

這個(gè) SQL 片段可以被包含在其他語(yǔ)句中,例如:

select from some_table
where id = #{id}

Parameters

在之前的語(yǔ)句中, 你已經(jīng)看到了一些簡(jiǎn)單參數(shù)的示例。 MyBatis 中參數(shù)是非常強(qiáng)大的在元素。對(duì)于簡(jiǎn)單的做法,大概 90%的情況,是不用太多的,比如:

select id, username, password
from users
where id = #{id}

上面的這個(gè)示例說(shuō)明了一個(gè)非常簡(jiǎn)單的命名參數(shù)映射。參數(shù)類型被設(shè)置為“int” ,因此這個(gè)參數(shù)可以被設(shè)置成任何內(nèi)容。原生的類型或簡(jiǎn)單數(shù)據(jù)類型, 比如整型和沒(méi)有相關(guān)屬性的字符串,因此它會(huì)完全用參數(shù)來(lái)替代。然而,如果你傳遞了一個(gè)復(fù)雜的對(duì)象,那么 MyBatis 的處理方式就會(huì)有一點(diǎn)不同。比如:

   insert into users (id, username, password)
 values (#{id}, #{username}, #{password})

如果 User 類型的參數(shù)對(duì)象傳遞到了語(yǔ)句中, username 和 password 屬性將會(huì)被查找, id、然后它們的值就被傳遞到預(yù)處理語(yǔ)句的參數(shù)中。

這點(diǎn)對(duì)于傳遞參數(shù)到語(yǔ)句中非常好。但是對(duì)于參數(shù)映射也有一些其他的特性。

首先,像 MyBatis 的其他部分,參數(shù)可以指定一個(gè)確定的數(shù)據(jù)類型。

#{property,javaType=int,jdbcType=NUMERIC}

像 MyBatis 的剩余部分,javaType 通常可以從參數(shù)對(duì)象中來(lái)去頂,除非對(duì)象是一個(gè) HashMap。那么 javaType 應(yīng)該被確定來(lái)保證使用正確類型處理器。

注意 如果 null 被當(dāng)作值來(lái)傳遞,對(duì)于所有可能為空的列,JDBC Type 是需要的。以可以自己通過(guò)閱讀預(yù)處理語(yǔ)句的 setNull()方法的 JavaDocs 文檔來(lái)研究這個(gè)。

為了自定義類型處理器,你可以指定一個(gè)確定的類型處理器類(或別名), 比如:

#{age,javaType=int,jdbcType=NUMERIC,typeHandler=MyTypeHandler}

盡管它看起來(lái)繁瑣,但是實(shí)際上是你很少設(shè)置它們其中之一。

對(duì)于數(shù)值類型,對(duì)于決定有多少數(shù)字是相關(guān)的,有一個(gè)數(shù)值范圍。

#{height,javaType=double,jdbcType=NUMERIC,numericScale=2}

最后,mode 屬性允許你指定 IN,OUT 或 INOUT 參數(shù)。如果參數(shù)為 OUT 或 INOUT, 參數(shù)對(duì)象屬性的真實(shí)值將會(huì)被改變,就像你期望你需要你個(gè)輸出參數(shù)。如果 mode 為 OUT (或 INOUT) ,而且 jdbcType 為 CURSOR(也就是 Oracle 的 REFCURSOR) ,你必須指定一個(gè) resultMap 來(lái)映射結(jié)果集到參數(shù)類型。要注意這里的 javaType 屬性是可選的,如果左邊的空白是 jdbcType 的 CURSOR 類型,它會(huì)自動(dòng)地被設(shè)置為結(jié)果集。

#{department, mode=OUT, jdbcType=CURSOR, javaType=ResultSet, resultMap=departmentResultMap}

MyBatis 也支持很多高級(jí)的數(shù)據(jù)類型,比如結(jié)構(gòu)體,但是當(dāng)注冊(cè) out 參數(shù)時(shí)你必須告訴語(yǔ)句類型名稱。比如(再次提示,在實(shí)際中不要像這樣換行):

#{middleInitial, mode=OUT, jdbcType=STRUCT, jdbcTypeName=MY_TYPE, resultMap=departmentResultMap}

盡管所有這些強(qiáng)大的選項(xiàng)很多時(shí)候你只簡(jiǎn)單指定屬性名,MyBatis 會(huì)自己計(jì)算剩余的。最多的情況是你為 jdbcType 指定可能為空的列名。

#{firstName} #{middleInitial,jdbcType=VARCHAR} #{lastName}

字符串替換

默認(rèn)情況下,使用#{}格式的語(yǔ)法會(huì)導(dǎo)致 MyBatis 創(chuàng)建預(yù)處理語(yǔ)句屬性并以它為背景設(shè)置安全的值(比如?) 。這樣做很安全,很迅速也是首選做法,有時(shí)你只是想直接在 SQL 語(yǔ)句中插入一個(gè)不改變的字符串。比如,像 ORDER BY,你可以這樣來(lái)使用:

ORDER BY ${columnName}

這里 MyBatis 不會(huì)修改或轉(zhuǎn)義字符串。

重要 接受從用戶輸出的內(nèi)容并提供給語(yǔ)句中不變的字符串,這樣做是不安全的。這會(huì)導(dǎo)致潛在的 SQL 注入攻擊,因此你不應(yīng)該允許用戶輸入這些字段,或者通常自行轉(zhuǎn)義并檢查。

Result Maps

resultMap 元素是 MyBatis 中最重要最強(qiáng)大的元素。它就是讓你遠(yuǎn)離 90%的需要從結(jié)果集中取出數(shù)據(jù)的 JDBC 代碼的那個(gè)東西, 而且在一些情形下允許你做一些 JDBC 不支持的事情。事實(shí)上, 編寫(xiě)相似于對(duì)復(fù)雜語(yǔ)句聯(lián)合映射這些等同的代碼, 也許可以跨過(guò)上千行的代碼。 ResultMap 的設(shè)計(jì)就是簡(jiǎn)單語(yǔ)句不需要明確的結(jié)果映射,而很多復(fù)雜語(yǔ)句確實(shí)需要描述它們的關(guān)系。

你已經(jīng)看到簡(jiǎn)單映射語(yǔ)句的示例了,但沒(méi)有明確的 resultMap。比如:

   select id, username, hashedPassword
 from some_table
 where id = #{id}

這樣一個(gè)語(yǔ)句簡(jiǎn)單作用于所有列被自動(dòng)映射到 HashMap 的鍵上,這由 resultType 屬性指定。這在很多情況下是有用的,但是 HashMap 不能很好描述一個(gè)領(lǐng)域模型。那樣你的應(yīng)用程序?qū)?huì)使用 JavaBeans 或 POJOs(Plain Old Java Objects,普通 Java 對(duì)象)來(lái)作為領(lǐng)域模型。MyBatis 對(duì)兩者都支持。看看下面這個(gè) JavaBean:

package com.someapp.model; 

public class User {  

 private int id; 

 private String username;

 private String hashedPassword; 
 public int getId() { 

 return id;

 } 

 public void setId(int id) {

 this.id = id; 

  } 

  public String getUsername() { 

    return username; 

  }  

 public void setUsername(String username) {  

   this.username = username;  

 }  

 public String getHashedPassword() { 

    return hashedPassword; 

  }  

 public void setHashedPassword(String hashedPassword) {

     this.hashedPassword = hashedPassword;  

 } }

基于 JavaBean 的規(guī)范,上面這個(gè)類有 3 個(gè)屬性:id,username 和 hashedPassword。這些在 select 語(yǔ)句中會(huì)精確匹配到列名。

這樣的一個(gè) JavaBean 可以被映射到結(jié)果集,就像映射到 HashMap 一樣簡(jiǎn)單。

  select id, username, hashedPassword
  from some_table
  where id = #{id}

要記住類型別名是你的伙伴。使用它們你可以不用輸入類的全路徑。比如:

  select id, username, hashedPassword
  from some_table
  where id = #{id}

這些情況下,MyBatis 會(huì)在幕后自動(dòng)創(chuàng)建一個(gè) ResultMap,基于屬性名來(lái)映射列到 JavaBean 的屬性上。如果列名沒(méi)有精確匹配,你可以在列名上使用 select 字句的別名(一個(gè)基本的 SQL 特性)來(lái)匹配標(biāo)簽。比如:

  select
   user_id             as "id",
   user_name           as "userName",
   hashed_password     as "hashedPassword"
  from some_table
  where id = #{id}

ResultMap 最優(yōu)秀的地方你已經(jīng)了解了很多了,但是你還沒(méi)有真正的看到一個(gè)。這些簡(jiǎn)單的示例不需要比你看到的更多東西。只是出于示例的原因, 讓我們來(lái)看看最后一個(gè)示例中外部的 resultMap 是什么樣子的,這也是解決列名不匹配的另外一種方式。

?

引用它的語(yǔ)句使用 resultMap 屬性就行了(注意我們?nèi)サ袅?resultType 屬性)。比如:

   select user_id, user_name, hashed_password
  from some_table
  where id = #{id}

如果世界總是這么簡(jiǎn)單就好了。

高級(jí)結(jié)果映射

MyBatis 創(chuàng)建的一個(gè)想法:數(shù)據(jù)庫(kù)不用永遠(yuǎn)是你想要的或需要它們是什么樣的。而我們最喜歡的數(shù)據(jù)庫(kù)最好是第三范式或 BCNF 模式,但它們有時(shí)不是。如果可能有一個(gè)單獨(dú)的數(shù)據(jù)庫(kù)映射,所有應(yīng)用程序都可以使用它,這是非常好的,但有時(shí)也不是。結(jié)果映射就是 MyBatis 提供處理這個(gè)問(wèn)題的答案。

比如,我們?nèi)绾斡成湎旅孢@個(gè)語(yǔ)句?

    select
       B.id as blog_id,
       B.title as blog_title,
       B.author_id as blog_author_id,
       A.id as author_id,
       A.username as author_username,
       A.password as author_password,
       A.email as author_email,
       A.bio as author_bio,
       A.favourite_section as author_favourite_section,
       P.id as post_id,
       P.blog_id as post_blog_id,
       P.author_id as post_author_id,
       P.created_on as post_created_on,
       P.section as post_section,
       P.subject as post_subject,
       P.draft as draft,
       P.body as post_body,
       C.id as comment_id,
       C.post_id as comment_post_id,
       C.name as comment_name,
       C.comment as comment_text,
       T.id as tag_id,
       T.name as tag_name
  from Blog B
       left outer join Author A on B.author_id = A.id
       left outer join Post P on B.id = P.blog_id
       left outer join Comment C on P.id = C.post_id
       left outer join Post_Tag PT on PT.post_id = P.id
       left outer join Tag T on PT.tag_id = T.id
  where B.id = #{id}

你可能想把它映射到一個(gè)智能的對(duì)象模型,包含一個(gè)作者寫(xiě)的博客,有很多的博文,每篇博文有零條或多條的評(píng)論和標(biāo)簽。下面是一個(gè)完整的復(fù)雜結(jié)果映射例子 (假設(shè)作者, 博客, 博文, 評(píng)論和標(biāo)簽都是類型的別名) 我們來(lái)看看, 。但是不用緊張, 我們會(huì)一步一步來(lái)說(shuō)明。當(dāng)天最初它看起來(lái)令人生畏,但實(shí)際上非常簡(jiǎn)單。

?

resultMap 元素有很多子元素和一個(gè)值得討論的結(jié)構(gòu)。下面是 resultMap 元素的概念視圖

resultMap

• constructor - 類在實(shí)例化時(shí),用來(lái)注入結(jié)果到構(gòu)造方法中

  • idArg - ID 參數(shù);標(biāo)記結(jié)果作為 ID 可以幫助提高整體效能

  • arg - 注入到構(gòu)造方法的一個(gè)普通結(jié)果

• id – 一個(gè) ID 結(jié)果;標(biāo)記結(jié)果作為 ID 可以幫助提高整體效能

• result – 注入到字段或 JavaBean 屬性的普通結(jié)果

• association – 一個(gè)復(fù)雜的類型關(guān)聯(lián);許多結(jié)果將包成這種類型

  • 嵌入結(jié)果映射 – 結(jié)果映射自身的關(guān)聯(lián),或者參考一個(gè)

• collection – 復(fù)雜類型的集

  • 嵌入結(jié)果映射 – 結(jié)果映射自身的集,或者參考一個(gè)

• discriminator – 使用結(jié)果值來(lái)決定使用哪個(gè)結(jié)果映射

  • case – 基于某些值的結(jié)果映射

    • 嵌入結(jié)果映射 – 這種情形結(jié)果也映射它本身,因此可以包含很多相 同的元素,或者它可以參照一個(gè)外部的結(jié)果映射。

最佳實(shí)踐 通常逐步建立結(jié)果映射。單元測(cè)試的真正幫助在這里。如果你嘗試創(chuàng)建一次創(chuàng)建一個(gè)向上面示例那樣的巨大的結(jié)果映射, 那么可能會(huì)有錯(cuò)誤而且很難去控制它來(lái)工作。開(kāi)始簡(jiǎn)單一些,一步一步的發(fā)展。而且要進(jìn)行單元測(cè)試!使用該框架的缺點(diǎn)是它們有時(shí)是黑盒(是否可見(jiàn)源代碼) 。你確定你實(shí)現(xiàn)想要的行為的最好選擇是編寫(xiě)單元測(cè)試。它也可以你幫助得到提交時(shí)的錯(cuò)誤。

下面一部分將詳細(xì)說(shuō)明每個(gè)元素。

id & result

這些是結(jié)果映射最基本內(nèi)容。id 和 result 都映射一個(gè)單獨(dú)列的值到簡(jiǎn)單數(shù)據(jù)類型(字符串,整型,雙精度浮點(diǎn)數(shù),日期等)的單獨(dú)屬性或字段。

這兩者之間的唯一不同是 id 表示的結(jié)果將是當(dāng)比較對(duì)象實(shí)例時(shí)用到的標(biāo)識(shí)屬性。這幫助來(lái)改進(jìn)整體表現(xiàn),特別是緩存和嵌入結(jié)果映射(也就是聯(lián)合映射) 。

每個(gè)都有一些屬性:

支持的 JDBC 類型

為了未來(lái)的參考,MyBatis 通過(guò)包含的 jdbcType 枚舉型,支持下面的 JDBC 類型。

構(gòu)造方法

?

對(duì)于大多數(shù)數(shù)據(jù)傳輸對(duì)象(Data Transfer Object,DTO)類型,屬性可以起作用,而且像你絕大多數(shù)的領(lǐng)域模型, 指令也許是你想使用一成不變的類的地方。通常包含引用或查詢數(shù)據(jù)的表很少或基本不變的話對(duì)一成不變的類來(lái)說(shuō)是合適的。構(gòu)造方法注入允許你在初始化時(shí)為類設(shè)置屬性的值,而不用暴露出公有方法。MyBatis 也支持私有屬性和私有 JavaBeans 屬性來(lái)達(dá)到這個(gè)目的,但是一些人更青睞構(gòu)造方法注入。構(gòu)造方法元素支持這個(gè)。

看看下面這個(gè)構(gòu)造方法:

public class User { //... public User(int id, String username) { //... } //... }

為了向這個(gè)構(gòu)造方法中注入結(jié)果,MyBatis 需要通過(guò)它的參數(shù)的類型來(lái)標(biāo)識(shí)構(gòu)造方法。 Java 沒(méi)有自查(反射)參數(shù)名的方法。所以當(dāng)創(chuàng)建一個(gè)構(gòu)造方法元素時(shí),保證參數(shù)是按順序排列的,而且數(shù)據(jù)類型也是確定的。

?

剩余的屬性和規(guī)則和固定的 id 和 result 元素是相同的。

關(guān)聯(lián)

?

關(guān)聯(lián)元素處理“有一個(gè)”類型的關(guān)系。比如,在我們的示例中,一個(gè)博客有一個(gè)用戶。關(guān)聯(lián)映射就工作于這種結(jié)果之上。你指定了目標(biāo)屬性,來(lái)獲取值的列,屬性的 java 類型(很多情況下 MyBatis 可以自己算出來(lái)) ,如果需要的話還有 jdbc 類型,如果你想覆蓋或獲取的結(jié)果值還需要類型控制器。

關(guān)聯(lián)中不同的是你需要告訴 MyBatis 如何加載關(guān)聯(lián)。MyBatis 在這方面會(huì)有兩種不同的方式:

• 嵌套查詢:通過(guò)執(zhí)行另外一個(gè) SQL 映射語(yǔ)句來(lái)返回預(yù)期的復(fù)雜類型。

• 嵌套結(jié)果:使用嵌套結(jié)果映射來(lái)處理重復(fù)的聯(lián)合結(jié)果的子集。首先,然讓我們來(lái)查看這個(gè)元素的屬性。所有的你都會(huì)看到,它和普通的只由 select 和

resultMap 屬性的結(jié)果映射不同。

關(guān)聯(lián)的嵌套查詢

示例:

    SELECT * FROM BLOG WHERE ID = #{id}    SELECT * FROM AUTHOR WHERE ID = #{id}

我們有兩個(gè)查詢語(yǔ)句:一個(gè)來(lái)加載博客,另外一個(gè)來(lái)加載作者,而且博客的結(jié)果映射描述了“selectAuthor”語(yǔ)句應(yīng)該被用來(lái)加載它的 author 屬性。

其他所有的屬性將會(huì)被自動(dòng)加載,假設(shè)它們的列和屬性名相匹配。

這種方式很簡(jiǎn)單, 但是對(duì)于大型數(shù)據(jù)集合和列表將不會(huì)表現(xiàn)很好。問(wèn)題就是我們熟知的 “N+1 查詢問(wèn)題”。概括地講,N+1 查詢問(wèn)題可以是這樣引起的:

• 你執(zhí)行了一個(gè)單獨(dú)的 SQL 語(yǔ)句來(lái)獲取結(jié)果列表(就是“+1”)。

• 對(duì)返回的每條記錄,你執(zhí)行了一個(gè)查詢語(yǔ)句來(lái)為每個(gè)加載細(xì)節(jié)(就是“N”)。

這個(gè)問(wèn)題會(huì)導(dǎo)致成百上千的 SQL 語(yǔ)句被執(zhí)行。這通常不是期望的。

MyBatis 能延遲加載這樣的查詢就是一個(gè)好處,因此你可以分散這些語(yǔ)句同時(shí)運(yùn)行的消耗。然而,如果你加載一個(gè)列表,之后迅速迭代來(lái)訪問(wèn)嵌套的數(shù)據(jù),你會(huì)調(diào)用所有的延遲加載,這樣的行為可能是很糟糕的。

所以還有另外一種方法。

關(guān)聯(lián)的嵌套結(jié)果

在上面你已經(jīng)看到了一個(gè)非常復(fù)雜的嵌套關(guān)聯(lián)的示例。下面這個(gè)是一個(gè)非常簡(jiǎn)單的示例來(lái)說(shuō)明它如何工作。代替了執(zhí)行一個(gè)分離的語(yǔ)句,我們聯(lián)合博客表和作者表在一起,就像:

   select
    B.id            as blog_id,
    B.title         as blog_title,
    B.author_id     as blog_author_id,
    A.id            as author_id,
    A.username      as author_username,
    A.password      as author_password,
    A.email         as author_email,
    A.bio           as author_bio
  from Blog B left outer join Author A on B.author_id = A.id
  where B.id = #{id}

注意這個(gè)聯(lián)合查詢, 以及采取保護(hù)來(lái)確保所有結(jié)果被唯一而且清晰的名字來(lái)重命名。這使得映射非常簡(jiǎn)單。現(xiàn)在我們可以映射這個(gè)結(jié)果:

?

在上面的示例中你可以看到博客的作者關(guān)聯(lián)代表著“authorResult”結(jié)果映射來(lái)加載作者實(shí)例。

非常重要: 在嵌套據(jù)誒過(guò)映射中 id 元素扮演了非常重要的角色。應(yīng)應(yīng)該通常指定一個(gè)或多個(gè)屬性,它們可以用來(lái)唯一標(biāo)識(shí)結(jié)果。實(shí)際上就是如果你離開(kāi)她了,但是有一個(gè)嚴(yán)重的性能問(wèn)題時(shí) MyBatis 仍然可以工作。選擇的屬性越少越好,它們可以唯一地標(biāo)識(shí)結(jié)果。主鍵就是一個(gè)顯而易見(jiàn)的選擇(盡管是聯(lián)合主鍵)。

現(xiàn)在,上面的示例用了外部的結(jié)果映射元素來(lái)映射關(guān)聯(lián)。這使得 Author 結(jié)果映射可以重用。然而,如果你不需要重用它的話,或者你僅僅引用你所有的結(jié)果映射合到一個(gè)單獨(dú)描述的結(jié)果映射中。你可以嵌套結(jié)果映射。這里給出使用這種方式的相同示例:

?

What if the blog has a co-author? The select statement would look like:

   select
    B.id            as blog_id,
    B.title         as blog_title,
    A.id            as author_id,
    A.username      as author_username,
    A.password      as author_password,
    A.email         as author_email,
    A.bio           as author_bio,
    CA.id           as co_author_id,
    CA.username     as co_author_username,
    CA.password     as co_author_password,
    CA.email        as co_author_email,
    CA.bio          as co_author_bio
  from Blog B
  left outer join Author A on B.author_id = A.id
  left outer join Author CA on B.co_author_id = CA.id
  where B.id = #{id}

Recall that the resultMap for Author is defined as follows.

?

Because the column names in the results differ from the columns defined in the resultMap, you need to specify columnPrefix to reuse the resultMap for mapping co-author results.

?

上面你已經(jīng)看到了如何處理“有一個(gè)”類型關(guān)聯(lián)。但是“有很多個(gè)”是怎樣的?下面這個(gè)部分就是來(lái)討論這個(gè)主題的。

集合

?

集合元素的作用幾乎和關(guān)聯(lián)是相同的。實(shí)際上,它們也很相似,文檔的異同是多余的。所以我們更多關(guān)注于它們的不同。

我們來(lái)繼續(xù)上面的示例,一個(gè)博客只有一個(gè)作者。但是博客有很多文章。在博客類中, 這可以由下面這樣的寫(xiě)法來(lái)表示:

private List posts;

要映射嵌套結(jié)果集合到 List 中,我們使用集合元素。就像關(guān)聯(lián)元素一樣,我們可以從連接中使用嵌套查詢,或者嵌套結(jié)果。

集合的嵌套查詢

首先,讓我們看看使用嵌套查詢來(lái)為博客加載文章。

    SELECT * FROM BLOG WHERE ID = #{id}    SELECT * FROM POST WHERE BLOG_ID = #{id}

這里你應(yīng)該注意很多東西,但大部分代碼和上面的關(guān)聯(lián)元素是非常相似的。首先,你應(yīng)該注意我們使用的是集合元素。然后要注意那個(gè)新的“ofType”屬性。這個(gè)屬性用來(lái)區(qū)分 JavaBean(或字段)屬性類型和集合包含的類型來(lái)說(shuō)是很重要的。所以你可以讀出下面這個(gè)映射:

讀作: “在 Post 類型的 ArrayList 中的 posts 的集合。”

javaType 屬性是不需要的,因?yàn)?MyBatis 在很多情況下會(huì)為你算出來(lái)。所以你可以縮短寫(xiě)法:

集合的嵌套結(jié)果

至此,你可以猜測(cè)集合的嵌套結(jié)果是如何來(lái)工作的,因?yàn)樗完P(guān)聯(lián)完全相同,除了它應(yīng)用了一個(gè)“ofType”屬性

First, let's look at the SQL:

   select
  B.id as blog_id,
  B.title as blog_title,
  B.author_id as blog_author_id,
  P.id as post_id,
  P.subject as post_subject,
  P.body as post_body,
  from Blog B
  left outer join Post P on B.id = P.blog_id
  where B.id = #{id}

我們又一次聯(lián)合了博客表和文章表,而且關(guān)注于保證特性,結(jié)果列標(biāo)簽的簡(jiǎn)單映射。現(xiàn)在用文章映射集合映射博客,可以簡(jiǎn)單寫(xiě)為:

?

同樣,要記得 id 元素的重要性,如果你不記得了,請(qǐng)閱讀上面的關(guān)聯(lián)部分。

同樣, 如果你引用更長(zhǎng)的形式允許你的結(jié)果映射的更多重用, 你可以使用下面這個(gè)替代的映射:

?

注意 這個(gè)對(duì)你所映射的內(nèi)容沒(méi)有深度,廣度或關(guān)聯(lián)和集合相聯(lián)合的限制。當(dāng)映射它們時(shí)你應(yīng)該在大腦中保留它們的表現(xiàn)。你的應(yīng)用在找到最佳方法前要一直進(jìn)行的單元測(cè)試和性能測(cè)試。好在 myBatis 讓你后來(lái)可以改變想法,而不對(duì)你的代碼造成很小(或任何)影響。

高級(jí)關(guān)聯(lián)和集合映射是一個(gè)深度的主題。文檔只能給你介紹到這了。加上一點(diǎn)聯(lián)系,你會(huì)很快清楚它們的用法。

鑒別器

?

有時(shí)一個(gè)單獨(dú)的數(shù)據(jù)庫(kù)查詢也許返回很多不同 (但是希望有些關(guān)聯(lián)) 數(shù)據(jù)類型的結(jié)果集。鑒別器元素就是被設(shè)計(jì)來(lái)處理這個(gè)情況的, 還有包括類的繼承層次結(jié)構(gòu)。鑒別器非常容易理解,因?yàn)樗谋憩F(xiàn)很像 Java 語(yǔ)言中的 switch 語(yǔ)句。

定義鑒別器指定了 column 和 javaType 屬性。列是 MyBatis 查找比較值的地方。 JavaType 是需要被用來(lái)保證等價(jià)測(cè)試的合適類型(盡管字符串在很多情形下都會(huì)有用)。比如:

?

在這個(gè)示例中, MyBatis 會(huì)從結(jié)果集中得到每條記錄, 然后比較它的 vehicle 類型的值。如果它匹配任何一個(gè)鑒別器的實(shí)例,那么就使用這個(gè)實(shí)例指定的結(jié)果映射。換句話說(shuō),這樣做完全是剩余的結(jié)果映射被忽略(除非它被擴(kuò)展,這在第二個(gè)示例中討論) 。如果沒(méi)有任何一個(gè)實(shí)例相匹配,那么 MyBatis 僅僅使用鑒別器塊外定義的結(jié)果映射。所以,如果 carResult 按如下聲明:

?

那么只有 doorCount 屬性會(huì)被加載。這步完成后完整地允許鑒別器實(shí)例的獨(dú)立組,盡管和父結(jié)果映射可能沒(méi)有什么關(guān)系。這種情況下,我們當(dāng)然知道 cars 和 vehicles 之間有關(guān)系, 如 Car 是一個(gè) Vehicle 實(shí)例。因此,我們想要剩余的屬性也被加載。我們?cè)O(shè)置的結(jié)果映射的簡(jiǎn)單改變?nèi)缦隆?/p>

?

現(xiàn)在 vehicleResult 和 carResult 的屬性都會(huì)被加載了。

盡管曾經(jīng)有些人會(huì)發(fā)現(xiàn)這個(gè)外部映射定義會(huì)多少有一些令人厭煩之處。因此還有另外一種語(yǔ)法來(lái)做簡(jiǎn)潔的映射風(fēng)格。比如:

?

要記得 這些都是結(jié)果映射, 如果你不指定任何結(jié)果, 那么 MyBatis 將會(huì)為你自動(dòng)匹配列和屬性。所以這些例子中的大部分是很冗長(zhǎng)的,而其實(shí)是不需要的。也就是說(shuō),很多數(shù)據(jù)庫(kù)是很復(fù)雜的,我們不太可能對(duì)所有示例都能依靠它。

Auto-mapping

As you have already seen in the previous sections, in simple cases MyBatis can auto-map the results for you and in others you will need to build a result map. But as you will see in this section you can also mix both strategies. Let's have a deeper look at how auto-mapping works.

When auto-mapping results MyBatis will get the column name and look for a property with the same name ignoring case. That means that if a column named ID and property named id are found, MyBatis will set the id property with the ID column value.

Usually database columns are named using uppercase letters and underscores between words and java properties often follow the camelcase naming covention. To enable the auto-mapping between them set the setting mapUnderscoreToCamelCase to true.

Auto-mapping works even when there is an specific result map. When this happens, for each result map, all columns that are present in the ResultSet that have not a manual mapping will be auto-mapped, then manual mappings will be processed. In the following sample id and userName columns will be auto-mapped and hashed_password column will be mapped.

   select
    user_id             as "id",
    user_name           as "userName",
    hashed_password
  from some_table
  where id = #{id}

There are three auto-mapping levels:

• NONE - disables auto-mapping. Only manually mapped properties will be set.

• PARTIAL - will auto-map results except those that have nested result mappings defined inside (joins).

• FULL - auto-maps everything.

The default value is PARTIAL, and it is so for a reason. When FULL is used auto-mapping will be performed when processing join results and joins retrieve data of several different entities in the same row hence this may result in undesired mappings. To understand the risk have a look at the following sample:

   select
    B.id,
    B.title,
    A.username,
  from Blog B left outer join Author A on B.author_id = A.id
  where B.id = #{id}

?

With this result map both Blog and Author will be auto-mapped. But note that Author has an idproperty and there is a column named id in the ResultSet so Author's id will be filled with Blog's id, and that is not what you were expecting. So use the FULL option with caution.

緩存

MyBatis 包含一個(gè)非常強(qiáng)大的查詢緩存特性,它可以非常方便地配置和定制。MyBatis 3 中的緩存實(shí)現(xiàn)的很多改進(jìn)都已經(jīng)實(shí)現(xiàn)了,使得它更加強(qiáng)大而且易于配置。

默認(rèn)情況下是沒(méi)有開(kāi)啟緩存的,除了局部的 session 緩存,可以增強(qiáng)變現(xiàn)而且處理循環(huán)依賴也是必須的。要開(kāi)啟二級(jí)緩存,你需要在你的 SQL 映射文件中添加一行:

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

• 映射語(yǔ)句文件中的所有 select 語(yǔ)句將會(huì)被緩存。

• 映射語(yǔ)句文件中的所有 insert,update 和 delete 語(yǔ)句會(huì)刷新緩存。

• 緩存會(huì)使用 Least Recently Used(LRU,最近最少使用的)算法來(lái)收回。

• 根據(jù)時(shí)間表(比如 no Flush Interval,沒(méi)有刷新間隔), 緩存不會(huì)以任何時(shí)間順序 來(lái)刷新。

• 緩存會(huì)存儲(chǔ)列表集合或?qū)ο?無(wú)論查詢方法返回什么)的 1024 個(gè)引用。

• 緩存會(huì)被視為是 read/write(可讀/可寫(xiě))的緩存,意味著對(duì)象檢索不是共享的,而且可以安全地被調(diào)用者修改,而不干擾其他調(diào)用者或線程所做的潛在修改。

所有的這些屬性都可以通過(guò)緩存元素的屬性來(lái)修改。比如:

這個(gè)更高級(jí)的配置創(chuàng)建了一個(gè) FIFO 緩存,并每隔 60 秒刷新,存數(shù)結(jié)果對(duì)象或列表的 512 個(gè)引用,而且返回的對(duì)象被認(rèn)為是只讀的,因此在不同線程中的調(diào)用者之間修改它們會(huì)導(dǎo)致沖突。

可用的收回策略有:

• 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ù),而且它們代表一個(gè)合理的毫秒形式的時(shí)間段。默認(rèn)情況是不設(shè)置,也就是沒(méi)有刷新間隔,緩存僅僅調(diào)用語(yǔ)句時(shí)刷新。

size(引用數(shù)目)可以被設(shè)置為任意正整數(shù),要記住你緩存的對(duì)象數(shù)目和你運(yùn)行環(huán)境的可用內(nèi)存資源數(shù)目。默認(rèn)值是 1024。

readOnly(只讀)屬性可以被設(shè)置為 true 或 false。只讀的緩存會(huì)給所有調(diào)用者返回緩存對(duì)象的相同實(shí)例。因此這些對(duì)象不能被修改。這提供了很重要的性能優(yōu)勢(shì)。可讀寫(xiě)的緩存會(huì)返回緩存對(duì)象的拷貝(通過(guò)序列化) 。這會(huì)慢一些,但是安全,因此默認(rèn)是 false。

使用自定義緩存

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

這個(gè)示 例展 示了 如何 使用 一個(gè) 自定義 的緩 存實(shí) 現(xiàn)。type 屬 性指 定的 類必 須實(shí)現(xiàn) org.mybatis.cache.Cache 接口。這個(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(); ReadWriteLock getReadWriteLock(); }

要配置你的緩存, 簡(jiǎn)單和公有的 JavaBeans 屬性來(lái)配置你的緩存實(shí)現(xiàn), 而且是通過(guò) cache 元素來(lái)傳遞屬性, 比如, 下面代碼會(huì)在你的緩存實(shí)現(xiàn)中調(diào)用一個(gè)稱為 “setCacheFile(String file)” 的方法:

?

你可以使用所有簡(jiǎn)單類型作為 JavaBeans 的屬性,MyBatis 會(huì)進(jìn)行轉(zhuǎn)換。

記得緩存配置和緩存實(shí)例是綁定在 SQL 映射文件的命名空間是很重要的。因此,所有在相同命名空間的語(yǔ)句正如綁定的緩存一樣。語(yǔ)句可以修改和緩存交互的方式, 或在語(yǔ)句的語(yǔ)句的基礎(chǔ)上使用兩種簡(jiǎn)單的屬性來(lái)完全排除它們。默認(rèn)情況下,語(yǔ)句可以這樣來(lái)配置:

因?yàn)槟切┦悄J(rèn)的,你明顯不能明確地以這種方式來(lái)配置一條語(yǔ)句。相反,如果你想改變默認(rèn)的行為,只能設(shè)置 flushCache 和 useCache 屬性。比如,在一些情況下你也許想排除從緩存中查詢特定語(yǔ)句結(jié)果,或者你也許想要一個(gè)查詢語(yǔ)句來(lái)刷新緩存。相似地,你也許有一些更新語(yǔ)句依靠執(zhí)行而不需要刷新緩存。

參照緩存

回想一下上一節(jié)內(nèi)容, 這個(gè)特殊命名空間的唯一緩存會(huì)被使用或者刷新相同命名空間內(nèi)的語(yǔ)句。也許將來(lái)的某個(gè)時(shí)候,你會(huì)想在命名空間中共享相同的緩存配置和實(shí)例。在這樣的情況下你可以使用 cache-ref 元素來(lái)引用另外一個(gè)緩存。