日韩性视频-久久久蜜桃-www中文字幕-在线中文字幕av-亚洲欧美一区二区三区四区-撸久久-香蕉视频一区-久久无码精品丰满人妻-国产高潮av-激情福利社-日韩av网址大全-国产精品久久999-日本五十路在线-性欧美在线-久久99精品波多结衣一区-男女午夜免费视频-黑人极品ⅴideos精品欧美棵-人人妻人人澡人人爽精品欧美一区-日韩一区在线看-欧美a级在线免费观看

歡迎訪問 生活随笔!

生活随笔

當前位置: 首頁 > 编程语言 > asp.net >内容正文

asp.net

mybatis入门(三)之Mapper XML 文件

發布時間:2023/12/3 asp.net 23 豆豆
生活随笔 收集整理的這篇文章主要介紹了 mybatis入门(三)之Mapper XML 文件 小編覺得挺不錯的,現在分享給大家,幫大家做個參考.

轉載自? ?mybatis Mapper XML 文件

Mapper XML 文件

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

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

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

下一部分將從語句本身開始來描述每個元素的細節。

select

查詢語句是 MyBatis 中最常用的元素之一,光能把數據存到數據庫中價值并不大,如果還能重新取出來才有用,多數應用也都是查詢比修改要頻繁。對每個插入、更新或刪除操作,通常對應多個查詢操作。這是 MyBatis 的基本原則之一,也是將焦點和努力放到查詢和結果映射的原因。簡單查詢的 select 元素是非常簡單的。比如:

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

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

注意參數符號:

#{id}

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

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

當然,這需要很多單獨的 JDBC 的代碼來提取結果并將它們映射到對象實例中,這就是 MyBatis 節省你時間的地方。我們需要深入了解參數和結果映射,細節部分我們下面來了解。

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

<selectid="selectPerson"parameterType="int"parameterMap="deprecated"resultType="hashmap"resultMap="personResultMap"flushCache="false"useCache="true"timeout="10000"fetchSize="256"statementType="PREPARED"resultSetType="FORWARD_ONLY"> Select Attributes屬性描述
id在命名空間中唯一的標識符,可以被用來引用這條語句。
parameterType將會傳入這條語句的參數類的完全限定名或別名。這個屬性是可選的,因為 MyBatis 可以通過 TypeHandler 推斷出具體傳入語句的參數,默認值為 unset。
parameterMap這是引用外部 parameterMap 的已經被廢棄的方法。使用內聯參數映射和 parameterType 屬性。
resultType從這條語句中返回的期望類型的類的完全限定名或別名。注意如果是集合情形,那應該是集合可以包含的類型,而不能是集合本身。使用 resultType 或 resultMap,但不能同時使用。
resultMap外部 resultMap 的命名引用。結果集的映射是 MyBatis 最強大的特性,對其有一個很好的理解的話,許多復雜映射的情形都能迎刃而解。使用 resultMap 或 resultType,但不能同時使用。
flushCache將其設置為 true,任何時候只要語句被調用,都會導致本地緩存和二級緩存都會被清空,默認值:false。
useCache將其設置為 true,將會導致本條語句的結果被二級緩存,默認值:對 select 元素為 true。
timeout這個設置是在拋出異常之前,驅動程序等待數據庫返回請求結果的秒數。默認值為 unset(依賴驅動)。
fetchSize這是嘗試影響驅動程序每次批量返回的結果行數和這個設置值相等。默認值為 unset(依賴驅動)。
statementTypeSTATEMENT,PREPARED 或 CALLABLE 的一個。這會讓 MyBatis 分別使用 Statement,PreparedStatement 或 CallableStatement,默認值:PREPARED。
resultSetTypeFORWARD_ONLY,SCROLL_SENSITIVE 或 SCROLL_INSENSITIVE 中的一個,默認值為 unset (依賴驅動)。
databaseId如果配置了 databaseIdProvider,MyBatis 會加載所有的不帶 databaseId 或匹配當前 databaseId 的語句;如果帶或者不帶的語句都有,則不帶的會被忽略。
resultOrdered這個設置僅針對嵌套結果 select 語句適用:如果為 true,就是假設包含了嵌套結果集或是分組了,這樣的話當返回一個主結果行的時候,就不會發生有對前面結果集的引用的情況。這就使得在獲取嵌套的結果集的時候不至于導致內存不夠用。默認值:false。
resultSets這個設置僅對多結果集的情況適用,它將列出語句執行后返回的結果集并每個結果集給一個名稱,名稱是逗號分隔的。

insert, update 和 delete

數據變更語句 insert,update 和 delete 的實現非常接近:

<insertid="insertAuthor"parameterType="domain.blog.Author"flushCache="true"statementType="PREPARED"keyProperty=""keyColumn=""useGeneratedKeys=""timeout="20"><updateid="updateAuthor"parameterType="domain.blog.Author"flushCache="true"statementType="PREPARED"timeout="20"><deleteid="deleteAuthor"parameterType="domain.blog.Author"flushCache="true"statementType="PREPARED"timeout="20"> Insert, Update, Delete 's Attributes屬性描述
id命名空間中的唯一標識符,可被用來代表這條語句。
parameterType將要傳入語句的參數的完全限定類名或別名。這個屬性是可選的,因為 MyBatis 可以通過 TypeHandler 推斷出具體傳入語句的參數,默認值為 unset。
parameterMap這是引用外部 parameterMap 的已經被廢棄的方法。使用內聯參數映射和 parameterType 屬性。
flushCache將其設置為 true,任何時候只要語句被調用,都會導致本地緩存和二級緩存都會被清空,默認值:true(對應插入、更新和刪除語句)。
timeout這個設置是在拋出異常之前,驅動程序等待數據庫返回請求結果的秒數。默認值為 unset(依賴驅動)。
statementTypeSTATEMENT,PREPARED 或 CALLABLE 的一個。這會讓 MyBatis 分別使用 Statement,PreparedStatement 或 CallableStatement,默認值:PREPARED。
useGeneratedKeys(僅對 insert 和 update 有用)這會令 MyBatis 使用 JDBC 的 getGeneratedKeys 方法來取出由數據庫內部生成的主鍵(比如:像 MySQL 和 SQL Server 這樣的關系數據庫管理系統的自動遞增字段),默認值:false。
keyProperty(僅對 insert 和 update 有用)唯一標記一個屬性,MyBatis 會通過 getGeneratedKeys 的返回值或者通過 insert 語句的 selectKey 子元素設置它的鍵值,默認:unset。如果希望得到多個生成的列,也可以是逗號分隔的屬性名稱列表。
keyColumn(僅對 insert 和 update 有用)通過生成的鍵值設置表中的列名,這個設置僅在某些數據庫(像 PostgreSQL)是必須的,當主鍵列不是表中的第一列的時候需要設置。如果希望得到多個生成的列,也可以是逗號分隔的屬性名稱列表。
databaseId如果配置了 databaseIdProvider,MyBatis 會加載所有的不帶 databaseId 或匹配當前 databaseId 的語句;如果帶或者不帶的語句都有,則不帶的會被忽略。

下面就是 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 setusername = #{username},password = #{password},email = #{email},bio = #{bio}where id = #{id} </update><delete id="deleteAuthor">delete from Author where id = #{id} </delete>

如前所述,插入語句的配置規則更加豐富,在插入語句里面有一些額外的屬性和子元素用來處理主鍵的生成,而且有多種生成方式。

首先,如果你的數據庫支持自動生成主鍵的字段(比如 MySQL 和 SQL Server),那么你可以設置 useGeneratedKeys=”true”,然后再把 keyProperty 設置到目標屬性上就OK了。例如,如果上面的 Author 表已經對 id 使用了自動生成的列類型,那么語句可以修改為:

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

如果你的數據庫還支持多行插入, 你也可以傳入一個Authors數組或集合,并返回自動生成的主鍵。

<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>

對于不支持自動生成類型的數據庫或可能不支持自動生成主鍵的 JDBC 驅動,MyBatis 有另外一種方法來生成主鍵。

這里有一個簡單(甚至很傻)的示例,它可以生成一個隨機 ID(你最好不要這么做,但這里展示了 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>

在上面的示例中,selectKey 元素將會首先運行,Author 的 id 會被設置,然后插入語句會被調用。這給你了一個和數據庫中來處理自動生成的主鍵類似的行為,避免了使 Java 代碼變得復雜。

selectKey 元素描述如下:

<selectKeykeyProperty="id"resultType="int"order="BEFORE"statementType="PREPARED"> selectKey Attributes屬性描述
keyPropertyselectKey 語句結果應該被設置的目標屬性。如果希望得到多個生成的列,也可以是逗號分隔的屬性名稱列表。
keyColumn匹配屬性的返回結果集中的列名稱。如果希望得到多個生成的列,也可以是逗號分隔的屬性名稱列表。
resultType結果的類型。MyBatis 通常可以推算出來,但是為了更加確定寫上也不會有什么問題。MyBatis 允許任何簡單類型用作主鍵的類型,包括字符串。如果希望作用于多個生成的列,則可以使用一個包含期望屬性的 Object 或一個 Map。
order這可以被設置為 BEFORE 或 AFTER。如果設置為 BEFORE,那么它會首先選擇主鍵,設置 keyProperty 然后執行插入語句。如果設置為 AFTER,那么先執行插入語句,然后是 selectKey 元素 - 這和像 Oracle 的數據庫相似,在插入語句內部可能有嵌入索引調用。
statementType與前面相同,MyBatis 支持 STATEMENT,PREPARED 和 CALLABLE 語句的映射類型,分別代表 PreparedStatement 和 CallableStatement 類型。

sql

這個元素可以被用來定義可重用的 SQL 代碼段,可以包含在其他語句中。它可以被靜態地(在加載參數) 參數化. 不同的屬性值通過包含的實例變化. 比如:

<sql id="userColumns"> ${alias}.id,${alias}.username,${alias}.password </sql>

這個 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 t1cross join some_table t2 </select>

屬性值也可以被用在 include 元素的 refid 屬性里(

<include refid="${include_target}"/>

)或 include 內部語句中(

${prefix}Table

),例如:

<sql id="sometable">${prefix}Table </sql><sql id="someinclude">from<include refid="${include_target}"/> </sql><select id="select" resultType="map">selectfield1, field2, field3<include refid="someinclude"><property name="prefix" value="Some"/><property name="include_target" value="sometable"/></include> </select>

參數(Parameters)

前面的所有語句中你所見到的都是簡單參數的例子,實際上參數是 MyBatis 非常強大的元素,對于簡單的做法,大概 90% 的情況參數都很少,比如:

<select id="selectUsers" resultType="User">select id, username, passwordfrom userswhere id = #{id} </select>

上面的這個示例說明了一個非常簡單的命名參數映射。參數類型被設置為?int,這樣這個參數就可以被設置成任何內容。原生的類型或簡單數據類型(比如整型和字符串)因為沒有相關屬性,它會完全用參數值來替代。然而,如果傳入一個復雜的對象,行為就會有一點不同了。比如:

<insert id="insertUser" parameterType="User">insert into users (id, username, password)values (#{id}, #{username}, #{password}) </insert>

如果 User 類型的參數對象傳遞到了語句中,id、username 和 password 屬性將會被查找,然后將它們的值傳入預處理語句的參數中。

這點相對于向語句中傳參是比較好的,而且又簡單,不過參數映射的功能遠不止于此。

首先,像 MyBatis 的其他部分一樣,參數也可以指定一個特殊的數據類型。

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

像 MyBatis 的剩余部分一樣,javaType 通常可以由參數對象確定,除非該對象是一個 HashMap。這時所使用的?TypeHandler?應該明確指明 javaType。

NOTE?如果一個列允許 null 值,并且會傳遞值 null 的參數,就必須要指定 JDBC Type。閱讀?PreparedStatement.setNull()?的 JavaDocs 文檔來獲取更多信息。

為了以后定制類型處理方式,你也可以指定一個特殊的類型處理器類(或別名),比如:

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

盡管看起來配置變得越來越繁瑣,但實際上,很少需要去設置它們。

對于數值類型,還有一個小數保留位數的設置,來確定小數點后保留的位數。

#{height,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。

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

MyBatis 也支持很多高級的數據類型,比如結構體,但是當注冊 out 參數時你必須告訴它語句類型名稱。比如(再次提示,在實際中要像這樣不能換行):

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

盡管所有這些選項很強大,但大多時候你只須簡單地指定屬性名,其他的事情 MyBatis 會自己去推斷,頂多要為可能為空的列指定?jdbcType。

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

字符串替換

默認情況下,使用?#{}?格式的語法會導致 MyBatis 創建?PreparedStatement?參數并安全地設置參數(就像使用 ? 一樣)。這樣做更安全,更迅速,通常也是首選做法,不過有時你就是想直接在 SQL 語句中插入一個不轉義的字符串。比如,像 ORDER BY,你可以這樣來使用:

ORDER BY ${columnName}

這里 MyBatis 不會修改或轉義字符串。

NOTE?用這種方式接受用戶的輸入,并將其用于語句中的參數是不安全的,會導致潛在的 SQL 注入攻擊,因此要么不允許用戶輸入這些字段,要么自行轉義并檢驗。

Result Maps

resultMap?元素是 MyBatis 中最重要最強大的元素。它可以讓你從 90% 的 JDBC?ResultSets?數據提取代碼中解放出來, 并在一些情形下允許你做一些 JDBC 不支持的事情。 實際上,在對復雜語句進行聯合映射的時候,它很可能可以代替數千行的同等功能的代碼。 ResultMap 的設計思想是,簡單的語句不需要明確的結果映射,而復雜一點的語句只需要描述它們的關系就行了。

你已經見過簡單映射語句的示例了,但沒有明確的 resultMap。比如:

<select id="selectUsers" resultType="map">select id, username, hashedPasswordfrom some_tablewhere id = #{id} </select>

上述語句只是簡單地將所有的列映射到 HashMap 的鍵上,這由 resultType 屬性指定。 雖然在大部分情況下都夠用,但是 HashMap 不是一個很好的領域模型。 你的程序更可能會使用 JavaBean 或 POJO(Plain Old Java Objects,普通 Java 對象)作為領域模型。 MyBatis 對兩者都支持。看看下面這個 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 的規范,上面這個類有 3 個屬性:id,username 和 hashedPassword。這些屬性會對應到 select 語句中的列名。

這樣的一個 JavaBean 可以被映射到?ResultSet,就像映射到?HashMap?一樣簡單。

<select id="selectUsers" resultType="com.someapp.model.User">select id, username, hashedPasswordfrom some_tablewhere id = #{id} </select>

類型別名是你的好幫手。使用它們,你就可以不用輸入類的完全限定名稱了。比如:

<!-- In mybatis-config.xml file --> <typeAlias type="com.someapp.model.User" alias="User"/><!-- In SQL Mapping XML file --> <select id="selectUsers" resultType="User">select id, username, hashedPasswordfrom some_tablewhere id = #{id} </select>

這些情況下,MyBatis 會在幕后自動創建一個?ResultMap,再基于屬性名來映射列到 JavaBean 的屬性上。如果列名和屬性名沒有精確匹配,可以在 SELECT 語句中對列使用別名(這是一個 基本的 SQL 特性)來匹配標簽。比如:

<select id="selectUsers" resultType="User">selectuser_id as "id",user_name as "userName",hashed_password as "hashedPassword"from some_tablewhere id = #{id} </select>

ResultMap?最優秀的地方在于,雖然你已經對它相當了解了,但是根本就不需要顯式地用到他們。 上面這些簡單的示例根本不需要下面這些繁瑣的配置。 出于示范的原因,讓我們來看看最后一個示例中,如果使用外部的?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>

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

<select id="selectUsers" resultMap="userResultMap">select user_id, user_name, hashed_passwordfrom some_tablewhere id = #{id} </select>

如果世界總是這么簡單就好了。

高級結果映射

MyBatis 創建的一個想法是:數據庫不可能永遠是你所想或所需的那個樣子。 我們希望每個數據庫都具備良好的第三范式或 BCNF 范式,可惜它們不總都是這樣。 如果有一個獨立且完美的數據庫映射模式,所有應用程序都可以使用它,那就太好了,但可惜也沒有。 ResultMap 就是 MyBatis 對這個問題的答案。

比如,我們如何映射下面這個語句?

<!-- Very Complex Statement --> <select id="selectBlogDetails" resultMap="detailedBlogResultMap">selectB.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_namefrom Blog Bleft outer join Author A on B.author_id = A.idleft outer join Post P on B.id = P.blog_idleft outer join Comment C on P.id = C.post_idleft outer join Post_Tag PT on PT.post_id = P.idleft outer join Tag T on PT.tag_id = T.idwhere B.id = #{id} </select>

你可能想把它映射到一個智能的對象模型,這個對象表示了一篇博客,它由某位作者所寫, 有很多的博文,每篇博文有零或多條的評論和標簽。 我們來看看下面這個完整的例子,它是一個非常復雜的 ResultMap (假設作者,博客,博文,評論和標簽都是類型的別名)。 不用緊張,我們會一步一步來說明。 雖然它看起來令人望而生畏,但其實非常簡單。

<!-- 超復雜的 Result Map --> <resultMap id="detailedBlogResultMap" type="Blog"><constructor><idArg column="blog_id" javaType="int"/></constructor><result property="title" column="blog_title"/><association property="author" javaType="Author"><id property="id" column="author_id"/><result property="username" column="author_username"/><result property="password" column="author_password"/><result property="email" column="author_email"/><result property="bio" column="author_bio"/><result property="favouriteSection" column="author_favourite_section"/></association><collection property="posts" ofType="Post"><id property="id" column="post_id"/><result property="subject" column="post_subject"/><association property="author" javaType="Author"/><collection property="comments" ofType="Comment"><id property="id" column="comment_id"/></collection><collection property="tags" ofType="Tag" ><id property="id" column="tag_id"/></collection><discriminator javaType="int" column="draft"><case value="1" resultType="DraftPost"/></discriminator></collection> </resultMap>

resultMap?元素有很多子元素和一個值得討論的結構。 下面是?resultMap?元素的概念視圖。

resultMap

  • constructor?- 用于在實例化類時,注入結果到構造方法中
    • idArg?- ID 參數;標記出作為 ID 的結果可以幫助提高整體性能
    • arg?- 將被注入到構造方法的一個普通結果
  • id?– 一個 ID 結果;標記出作為 ID 的結果可以幫助提高整體性能
  • result?– 注入到字段或 JavaBean 屬性的普通結果
  • association?– 一個復雜類型的關聯;許多結果將包裝成這種類型
    • 嵌套結果映射 – 關聯可以指定為一個?resultMap?元素,或者引用一個
  • collection?– 一個復雜類型的集合
    • 嵌套結果映射 – 集合可以指定為一個?resultMap?元素,或者引用一個
  • discriminator?– 使用結果值來決定使用哪個?resultMap
    • case?– 基于某些值的結果映射
      • 嵌套結果映射 – 一個?case?也是一個映射它本身的結果,因此可以包含很多相 同的元素,或者它可以參照一個外部的?resultMap。
ResultMap &#x7684;&#x5c5e;&#x6027;&#x5217;&#x8868;屬性描述
id當前命名空間中的一個唯一標識,用于標識一個result map.
type類的完全限定名, 或者一個類型別名 (內置的別名可以參考上面的表格).
autoMapping如果設置這個屬性,MyBatis將會為這個ResultMap開啟或者關閉自動映射。這個屬性會覆蓋全局的屬性 autoMappingBehavior。默認值為:unset。

最佳實踐?最好一步步地建立結果映射。單元測試可以在這個過程中起到很大幫助。如果你嘗試一次創建一個像上面示例那樣的巨大的結果映射, 那么很可能會出現錯誤而且很難去使用它來完成工作。 從最簡單的形態開始,逐步進化。而且別忘了單元測試!使用框架的缺點是有時候它們看上去像黑盒子(無論源代碼是否可見)。 為了確保你實現的行為和想要的一致,最好的選擇是編寫單元測試。提交 bug 的時候它也能起到很大的作用。

下一部分將詳細說明每個元素。

id & result

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

這些是結果映射最基本的內容。id 和 result 都將一個列的值映射到一個簡單數據類型(字符串,整型,雙精度浮點數,日期等)的屬性或字段。

這兩者之間的唯一不同是, id 表示的結果將是對象的標識屬性,這會在比較對象實例時用到。 這樣可以提高整體的性能,尤其是緩存和嵌套結果映射(也就是聯合映射)的時候。

兩個元素都有一些屬性:

Id &#x548c; Result &#x7684;&#x5c5e;&#x6027;屬性描述
property映射到列結果的字段或屬性。如果用來匹配的 JavaBeans 存在給定名字的屬性,那么它將會被使用。否則 MyBatis 將會尋找給定名稱 property 的字段。 無論是哪一種情形,你都可以使用通常的點式分隔形式進行復雜屬性導航。比如,你可以這樣映射一些簡單的東西: “username” ,或者映射到一些復雜的東西: “address.street.number” 。
column數據庫中的列名,或者是列的別名。一般情況下,這和 傳遞給?resultSet.getString(columnName)?方法的參數一樣。
javaType一個 Java 類的完全限定名,或一個類型別名(參考上面內建類型別名 的列表) 。如果你映射到一個 JavaBean,MyBatis 通常可以斷定類型。 然而,如果你映射到的是 HashMap,那么你應該明確地指定 javaType 來保證期望的行為。
jdbcTypeJDBC 類型,所支持的 JDBC 類型參見這個表格之后的“支持的 JDBC 類型”。 只需要在可能執行插入、更新和刪除的允許空值的列上指定 JDBC 類型。這是 JDBC 的要求而非 MyBatis 的要求。如果你直接面向 JDBC 編程,你需要對可能為 null 的值指定這個類型。
typeHandler我們在前面討論過的默認類型處理器。使用這個屬性,你可以覆蓋默 認的類型處理器。這個屬性值是一個類型處理 器實現類的完全限定名,或者是類型別名。

支持的 JDBC 類型

為了未來的參考,MyBatis 通過包含的 jdbcType 枚舉型,支持下面的 JDBC 類型。

BITFLOATCHARTIMESTAMPOTHERUNDEFINED
TINYINTREALVARCHARBINARYBLOBNVARCHAR
SMALLINTDOUBLELONGVARCHARVARBINARYCLOBNCHAR
INTEGERNUMERICDATELONGVARBINARYBOOLEANNCLOB
BIGINTDECIMALTIMENULLCURSORARRAY

構造方法

通過修改對象屬性的方式,可以滿足大多數的數據傳輸對象(Data Transfer Object,DTO)以及絕大部分領域模型的要求。 但有些情況下你想使用不可變類。 通常來說,很少或基本不變的、包含引用或查詢數 據的表,很適合使用不可變類。 構造方法注入允許你在初始化時 為類設置屬性的值,而不用暴露出公有方法。MyBatis 也支持私有屬性和私有 JavaBeans 屬 性來達到這個目的,但有一些人更青睞于構造方法注入。constructor 元素就是為此而生的。

看看下面這個構造方法:

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

為了將結果注入構造方法,MyBatis需要通過某種方式定位相應的構造方法。 在下面的例子中,MyBatis搜索一個聲明了三個形參的的構造方法,以?java.lang.Integer,?java.lang.Stringand?int?的順序排列。

<constructor><idArg column="id" javaType="int"/><arg column="username" javaType="String"/><arg column="age" javaType="_int"/> </constructor>

當你在處理一個帶有多個形參的構造方法時,很容易在保證 arg 元素的正確順序上出錯。 從版本 3.4.3 開始,可以在指定參數名稱的前提下,以任意順序編寫 arg 元素。 為了通過名稱來引用構造方法參數,你可以添加?@Param?注解,或者使用 '-parameters' 編譯選項并啟用?useActualParamName?選項(默認開啟)來編譯項目。 下面的例子對于同一個構造方法依然是有效的,盡管第二和第三個形參順序與構造方法中聲明的順序不匹配。

<constructor><idArg column="id" javaType="int" name="id" /><arg column="age" javaType="_int" name="age" /><arg column="username" javaType="String" name="username" /> </constructor>

如果類中存在名稱和類型相同的屬性,那么可以省略?javaType?。

剩余的屬性和規則和普通的 id 和 result 元素是一樣的。

屬性描述
column數據庫中的列名,或者是列的別名。一般情況下,這和 傳遞給?resultSet.getString(columnName)?方法的參數一樣。
javaType一個 Java 類的完全限定名,或一個類型別名(參考上面內建類型別名的列表)。 如果你映射到一個 JavaBean,MyBatis 通常可以斷定類型。然而,如 果你映射到的是 HashMap,那么你應該明確地指定 javaType 來保證期望的 行為。
jdbcTypeJDBC 類型,所支持的 JDBC 類型參見這個表格之前的“支持的 JDBC 類型”。 只需要在可能執行插入、更新和刪除的允許空值的列上指定 JDBC 類型。這是 JDBC 的要求而非 MyBatis 的要求。如果你直接面向 JDBC 編程,你需要對可能為 null 的值指定這個類型。
typeHandler我們在前面討論過的默認類型處理器。使用這個屬性,你可以覆蓋默 認的類型處理器。這個屬性值是一個類型處理 器實現類的完全限定名,或者是類型別名。
select用于加載復雜類型屬性的映射語句的 ID,它會從 column 屬性中指定的列檢索數據,作為參數傳遞給此 select 語句。具體請參考 Association 標簽。
resultMapResultMap 的 ID,可以將嵌套的結果集映射到一個合適的對象樹中,功能和 select 屬性相似,它可以實現將多表連接操作的結果映射成一個單一的ResultSet。這樣的ResultSet將會將包含重復或部分數據重復的結果集正確的映射到嵌套的對象樹中。為了實現它, MyBatis允許你 “串聯” ResultMap,以便解決嵌套結果集的問題。想了解更多內容,請參考下面的Association元素。
name構造方法形參的名字。從3.4.3版本開始,通過指定具體的名字,你可以以任意順序寫入arg元素。參看上面的解釋。

關聯

<association property="author" column="blog_author_id" javaType="Author"><id property="id" column="author_id"/><result property="username" column="author_username"/> </association>

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

關聯中不同的是你需要告訴 MyBatis 如何加載關聯。MyBatis 在這方面會有兩種不同的 方式:

  • 嵌套查詢:通過執行另外一個 SQL 映射語句來返回預期的復雜類型。
  • 嵌套結果:使用嵌套結果映射來處理重復的聯合結果的子集。首先,然讓我們來查看這個元素的屬性。所有的你都會看到,它和普通的只由 select 和

resultMap 屬性的結果映射不同。

屬性描述
property映射到列結果的字段或屬性。如果用來匹配的 JavaBeans 存在給定名字的屬性,那么它將會被使用。 否則 MyBatis 將會尋找與給定名稱相同的字段。 這兩種情形你可以使用通常點式的復雜屬性導航。比如,你可以這樣映射 一 些 東 西 :“ username ”, 或 者 映 射 到 一 些 復 雜 的 東 西 : “address.street.number” 。
javaType一個 Java 類的完全限定名,或一個類型別名(參考上面內建類型別名的列 表) 。如果你映射到一個 JavaBean,MyBatis 通常可以斷定類型。然而,如 javaType 果你映射到的是 HashMap,那么你應該明確地指定 javaType 來保證所需的 行為。
jdbcType在這個表格之前的所支持的 JDBC 類型列表中的類型。JDBC 類型是僅僅 需要對插入, 更新和刪除操作可能為空的列進行處理。這是 JDBC 的需要, jdbcType 而不是 MyBatis 的。如果你直接使用 JDBC 編程,你需要指定這個類型-但 僅僅對可能為空的值。
typeHandler我們在前面討論過默認的類型處理器。使用這個屬性,你可以覆蓋默認的 typeHandler 類型處理器。 這個屬性值是類的完全限定名或者是一個類型處理器的實現, 或者是類型別名。

關聯的嵌套查詢

屬性描述
column來自數據庫的列名,或重命名的列標簽。這和通常傳遞給 resultSet.getString(columnName)方法的字符串是相同的。 column 注 意 : 要 處 理 復 合 主 鍵 , 你 可 以 指 定 多 個 列 名 通 過 column= ” {prop1=col1,prop2=col2} ” 這種語法來傳遞給嵌套查詢語 句。這會引起 prop1 和 prop2 以參數對象形式來設置給目標嵌套查詢語句。
select另外一個映射語句的 ID,可以加載這個屬性映射需要的復雜類型。獲取的 在列屬性中指定的列的值將被傳遞給目標 select 語句作為參數。表格后面 有一個詳細的示例。 select 注 意 : 要 處 理 復 合 主 鍵 , 你 可 以 指 定 多 個 列 名 通 過 column= ” {prop1=col1,prop2=col2} ” 這種語法來傳遞給嵌套查詢語 句。這會引起 prop1 和 prop2 以參數對象形式來設置給目標嵌套查詢語句。
fetchType可選的。有效值為?lazy和eager。 如果使用了,它將取代全局配置參數lazyLoadingEnabled。

示例:

<resultMap id="blogResult" type="Blog"><association property="author" column="author_id" javaType="Author" select="selectAuthor"/> </resultMap><select id="selectBlog" resultMap="blogResult">SELECT * FROM BLOG WHERE ID = #{id} </select><select id="selectAuthor" resultType="Author">SELECT * FROM AUTHOR WHERE ID = #{id} </select>

我們有兩個查詢語句:一個來加載博客,另外一個來加載作者,而且博客的結果映射描 述了“selectAuthor”語句應該被用來加載它的 author 屬性。

其他所有的屬性將會被自動加載,假設它們的列和屬性名相匹配。

這種方式很簡單, 但是對于大型數據集合和列表將不會表現很好。 問題就是我們熟知的 “N+1 查詢問題”。概括地講,N+1 查詢問題可以是這樣引起的:

  • 你執行了一個單獨的 SQL 語句來獲取結果列表(就是“+1”)。
  • 對返回的每條記錄,你執行了一個查詢語句來為每個加載細節(就是“N”)。

這個問題會導致成百上千的 SQL 語句被執行。這通常不是期望的。

MyBatis 能延遲加載這樣的查詢就是一個好處,因此你可以分散這些語句同時運行的消 耗。然而,如果你加載一個列表,之后迅速迭代來訪問嵌套的數據,你會調用所有的延遲加 載,這樣的行為可能是很糟糕的。

所以還有另外一種方法。

關聯的嵌套結果

屬性描述
resultMap這是結果映射的 ID,可以映射關聯的嵌套結果到一個合適的對象圖中。這 是一種替代方法來調用另外一個查詢語句。這允許你聯合多個表來合成到 resultMap 一個單獨的結果集。這樣的結果集可能包含重復,數據的重復組需要被分 解,合理映射到一個嵌套的對象圖。為了使它變得容易,MyBatis 讓你“鏈 接”結果映射,來處理嵌套結果。一個例子會很容易來仿照,這個表格后 面也有一個示例。
columnPrefix當連接多表時,你將不得不使用列別名來避免ResultSet中的重復列名。指定columnPrefix允許你映射列名到一個外部的結果集中。 請看后面的例子。
notNullColumn默認情況下,子對象僅在至少一個列映射到其屬性非空時才創建。 通過對這個屬性指定非空的列將改變默認行為,這樣做之后Mybatis將僅在這些列非空時才創建一個子對象。 可以指定多個列名,使用逗號分隔。默認值:未設置(unset)。
autoMapping如果使用了,當映射結果到當前屬性時,Mybatis將啟用或者禁用自動映射。 該屬性覆蓋全局的自動映射行為。 注意它對外部結果集無影響,所以在select?or?resultMap屬性中這個是毫無意義的。 默認值:未設置(unset)。

在上面你已經看到了一個非常復雜的嵌套關聯的示例。 下面這個是一個非常簡單的示例 來說明它如何工作。代替了執行一個分離的語句,我們聯合博客表和作者表在一起,就像:

<select id="selectBlog" resultMap="blogResult">selectB.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_biofrom Blog B left outer join Author A on B.author_id = A.idwhere B.id = #{id} </select>

注意這個聯合查詢, 以及采取保護來確保所有結果被唯一而且清晰的名字來重命名。 這使得映射非常簡單。現在我們可以映射這個結果:

<resultMap id="blogResult" type="Blog"><id property="id" column="blog_id" /><result property="title" column="blog_title"/><association property="author" column="blog_author_id" javaType="Author" resultMap="authorResult"/> </resultMap><resultMap id="authorResult" type="Author"><id property="id" column="author_id"/><result property="username" column="author_username"/><result property="password" column="author_password"/><result property="email" column="author_email"/><result property="bio" column="author_bio"/> </resultMap>

在上面的示例中你可以看到博客的作者關聯代表著“authorResult”結果映射來加載作 者實例。

非常重要: id元素在嵌套結果映射中扮演著非 常重要的角色。你應該總是指定一個或多個可以唯一標識結果的屬性。實際上如果你不指定它的話, MyBatis仍然可以工作,但是會有嚴重的性能問題。在可以唯一標識結果的情況下, 盡可能少的選擇屬性。主鍵是一個顯而易見的選擇(即使是復合主鍵)。

現在,上面的示例用了外部的結果映射元素來映射關聯。這使得 Author 結果映射可以 重用。然而,如果你不需要重用它的話,或者你僅僅引用你所有的結果映射合到一個單獨描 述的結果映射中。你可以嵌套結果映射。這里給出使用這種方式的相同示例:

<resultMap id="blogResult" type="Blog"><id property="id" column="blog_id" /><result property="title" column="blog_title"/><association property="author" javaType="Author"><id property="id" column="author_id"/><result property="username" column="author_username"/><result property="password" column="author_password"/><result property="email" column="author_email"/><result property="bio" column="author_bio"/></association> </resultMap>

如果blog有一個co-author怎么辦? select語句將看起來這個樣子:

<select id="selectBlog" resultMap="blogResult">selectB.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_biofrom Blog Bleft outer join Author A on B.author_id = A.idleft outer join Author CA on B.co_author_id = CA.idwhere B.id = #{id} </select>

再次調用Author的resultMap將定義如下:

<resultMap id="authorResult" type="Author"><id property="id" column="author_id"/><result property="username" column="author_username"/><result property="password" column="author_password"/><result property="email" column="author_email"/><result property="bio" column="author_bio"/> </resultMap>

因為結果中的列名與resultMap中的列名不同。 你需要指定columnPrefix去重用映射co-author結果的resultMap。

<resultMap id="blogResult" type="Blog"><id property="id" column="blog_id" /><result property="title" column="blog_title"/><association property="author"resultMap="authorResult" /><association property="coAuthor"resultMap="authorResult"columnPrefix="co_" /> </resultMap>

上面你已經看到了如何處理“有一個”類型關聯。但是“有很多個”是怎樣的?下面這 個部分就是來討論這個主題的。

集合

<collection property="posts" ofType="domain.blog.Post"><id property="id" column="post_id"/><result property="subject" column="post_subject"/><result property="body" column="post_body"/> </collection>

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

我們來繼續上面的示例,一個博客只有一個作者。但是博客有很多文章。在博客類中, 這可以由下面這樣的寫法來表示:

private List<Post> posts;

要映射嵌套結果集合到 List 中,我們使用集合元素。就像關聯元素一樣,我們可以從 連接中使用嵌套查詢,或者嵌套結果。

集合的嵌套查詢

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

<resultMap id="blogResult" type="Blog"><collection property="posts" javaType="ArrayList" column="id" ofType="Post" select="selectPostsForBlog"/> </resultMap><select id="selectBlog" resultMap="blogResult">SELECT * FROM BLOG WHERE ID = #{id} </select><select id="selectPostsForBlog" resultType="Post">SELECT * FROM POST WHERE BLOG_ID = #{id} </select>

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

<collection property="posts" javaType="ArrayList" column="id" ofType="Post" select="selectPostsForBlog"/>

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

javaType 屬性是不需要的,因為 MyBatis 在很多情況下會為你算出來。所以你可以縮短 寫法:

<collection property="posts" column="id" ofType="Post" select="selectPostsForBlog"/>

集合的嵌套結果

至此,你可以猜測集合的嵌套結果是如何來工作的,因為它和關聯完全相同,除了它應 用了一個“ofType”屬性

首先, 讓我們看看 SQL:

<select id="selectBlog" resultMap="blogResult">selectB.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 Bleft outer join Post P on B.id = P.blog_idwhere B.id = #{id} </select>

我們又一次聯合了博客表和文章表,而且關注于保證特性,結果列標簽的簡單映射。現 在用文章映射集合映射博客,可以簡單寫為:

<resultMap id="blogResult" type="Blog"><id property="id" column="blog_id" /><result property="title" column="blog_title"/><collection property="posts" ofType="Post"><id property="id" column="post_id"/><result property="subject" column="post_subject"/><result property="body" column="post_body"/></collection> </resultMap>

同樣,要記得 id 元素的重要性,如果你不記得了,請閱讀上面的關聯部分。

同樣, 如果你引用更長的形式允許你的結果映射的更多重用, 你可以使用下面這個替代 的映射:

<resultMap id="blogResult" type="Blog"><id property="id" column="blog_id" /><result property="title" column="blog_title"/><collection property="posts" ofType="Post" resultMap="blogPostResult" columnPrefix="post_"/> </resultMap><resultMap id="blogPostResult" type="Post"><id property="id" column="id"/><result property="subject" column="subject"/><result property="body" column="body"/> </resultMap>

注意?這個對你所映射的內容沒有深度,廣度或關聯和集合相聯合的限制。當映射它們 時你應該在大腦中保留它們的表現。 你的應用在找到最佳方法前要一直進行的單元測試和性 能測試。好在 myBatis 讓你后來可以改變想法,而不對你的代碼造成很小(或任何)影響。

高級關聯和集合映射是一個深度的主題。文檔只能給你介紹到這了。加上一點聯系,你 會很快清楚它們的用法。

鑒別器

<discriminator javaType="int" column="draft"><case value="1" resultType="DraftPost"/> </discriminator>

有時一個單獨的數據庫查詢也許返回很多不同 (但是希望有些關聯) 數據類型的結果集。 鑒別器元素就是被設計來處理這個情況的, 還有包括類的繼承層次結構。 鑒別器非常容易理 解,因為它的表現很像 Java 語言中的 switch 語句。

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

<resultMap id="vehicleResult" type="Vehicle"><id property="id" column="id" /><result property="vin" column="vin"/><result property="year" column="year"/><result property="make" column="make"/><result property="model" column="model"/><result property="color" column="color"/><discriminator javaType="int" column="vehicle_type"><case value="1" resultMap="carResult"/><case value="2" resultMap="truckResult"/><case value="3" resultMap="vanResult"/><case value="4" resultMap="suvResult"/></discriminator> </resultMap>

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

<resultMap id="carResult" type="Car"><result property="doorCount" column="door_count" /> </resultMap>

那么只有 doorCount 屬性會被加載。這步完成后完整地允許鑒別器實例的獨立組,盡管 和父結果映射可能沒有什么關系。這種情況下,我們當然知道 cars 和 vehicles 之間有關系, 如 Car 是一個 Vehicle 實例。因此,我們想要剩余的屬性也被加載。我們設置的結果映射的 簡單改變如下。

<resultMap id="carResult" type="Car" extends="vehicleResult"><result property="doorCount" column="door_count" /> </resultMap>

現在 vehicleResult 和 carResult 的屬性都會被加載了。

盡管曾經有些人會發現這個外部映射定義會多少有一些令人厭煩之處。 因此還有另外一 種語法來做簡潔的映射風格。比如:

<resultMap id="vehicleResult" type="Vehicle"><id property="id" column="id" /><result property="vin" column="vin"/><result property="year" column="year"/><result property="make" column="make"/><result property="model" column="model"/><result property="color" column="color"/><discriminator javaType="int" column="vehicle_type"><case value="1" resultType="carResult"><result property="doorCount" column="door_count" /></case><case value="2" resultType="truckResult"><result property="boxSize" column="box_size" /><result property="extendedCab" column="extended_cab" /></case><case value="3" resultType="vanResult"><result property="powerSlidingDoor" column="power_sliding_door" /></case><case value="4" resultType="suvResult"><result property="allWheelDrive" column="all_wheel_drive" /></case></discriminator> </resultMap>

要記得?這些都是結果映射, 如果你不指定任何結果, 那么 MyBatis 將會為你自動匹配列 和屬性。所以這些例子中的大部分是很冗長的,而其實是不需要的。也就是說,很多數據庫 是很復雜的,我們不太可能對所有示例都能依靠它。

自動映射

正如你在前面一節看到的,在簡單的場景下,MyBatis可以替你自動映射查詢結果。 如果遇到復雜的場景,你需要構建一個result map。 但是在本節你將看到,你也可以混合使用這兩種策略。 讓我們到深一點的層面上看看自動映射是怎樣工作的。

當自動映射查詢結果時,MyBatis會獲取sql返回的列名并在java類中查找相同名字的屬性(忽略大小寫)。 這意味著如果Mybatis發現了ID列和id屬性,Mybatis會將ID的值賦給id。

通常數據庫列使用大寫單詞命名,單詞間用下劃線分隔;而java屬性一般遵循駝峰命名法。 為了在這兩種命名方式之間啟用自動映射,需要將?mapUnderscoreToCamelCase設置為true。

自動映射甚至在特定的result map下也能工作。在這種情況下,對于每一個result map,所有的ResultSet提供的列, 如果沒有被手工映射,則將被自動映射。自動映射處理完畢后手工映射才會被處理。 在接下來的例子中,?id?和?userName列將被自動映射,?hashed_password?列將根據配置映射。

<select id="selectUsers" resultMap="userResultMap">selectuser_id as "id",user_name as "userName",hashed_passwordfrom some_tablewhere id = #{id} </select> <resultMap id="userResultMap" type="User"><result property="password" column="hashed_password"/> </resultMap>

有三種自動映射等級:

  • NONE?- 禁用自動映射。僅設置手動映射屬性。
  • PARTIAL?- 將自動映射結果除了那些有內部定義內嵌結果映射的(joins).
  • FULL?- 自動映射所有。

默認值是PARTIAL,這是有原因的。當使用FULL時,自動映射會在處理join結果時執行,并且join取得若干相同行的不同實體數據,因此這可能導致非預期的映射。下面的例子將展示這種風險:

<select id="selectBlog" resultMap="blogResult">selectB.id,B.title,A.username,from Blog B left outer join Author A on B.author_id = A.idwhere B.id = #{id} </select> <resultMap id="blogResult" type="Blog"><association property="author" resultMap="authorResult"/> </resultMap><resultMap id="authorResult" type="Author"><result property="username" column="author_username"/> </resultMap>

在結果中Blog和Author均將自動映射。但是注意Author有一個id屬性,在ResultSet中有一個列名為id, 所以Author的id將被填充為Blog的id,這不是你所期待的。所以需要謹慎使用FULL。

通過添加autoMapping屬性可以忽略自動映射等級配置,你可以啟用或者禁用自動映射指定的ResultMap。

<resultMap id="userResultMap" type="User" autoMapping="false"><result property="password" column="hashed_password"/> </resultMap>

緩存

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

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

<cache/>

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

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

NOTE?The cache will only apply to statements declared in the mapping file where the cache tag is located. If you are using the Java API in conjunction with the XML mapping files, then statements declared in the companion interface will not be cached by default. You will need to refer to the cache region using the @CacheNamespaceRef annotation.

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

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

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

可用的收回策略有:

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

默認的是 LRU。

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

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

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

使用自定義緩存

除了這些自定義緩存的方式, 你也可以通過實現你自己的緩存或為其他第三方緩存方案 創建適配器來完全覆蓋緩存行為。

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

這個示 例展 示了 如何 使用 一個 自定義 的緩 存實 現。type 屬 性指 定的 類必 須實現 org.mybatis.cache.Cache 接口。這個接口是 MyBatis 框架中很多復雜的接口之一,但是簡單 給定它做什么就行。

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(); }

要配置你的緩存, 簡單和公有的 JavaBeans 屬性來配置你的緩存實現, 而且是通過 cache 元素來傳遞屬性, 比如, 下面代碼會在你的緩存實現中調用一個稱為 “setCacheFile(String file)” 的方法:

<cache type="com.domain.something.MyCustomCache"><property name="cacheFile" value="/tmp/my-custom-cache.tmp"/> </cache>

你可以使用所有簡單類型作為 JavaBeans 的屬性,MyBatis 會進行轉換。 And you can specify a placeholder(e.g.?${cache.file}) to replace value defined at?configuration properties.

從3.4.2版本開始,MyBatis已經支持在所有屬性設置完畢以后可以調用一個初始化方法。如果你想要使用這個特性,請在你的自定義緩存類里實現org.apache.ibatis.builder.InitializingObject?接口。

public interface InitializingObject {void initialize() throws Exception; }

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

<select ... flushCache="false" useCache="true"/> <insert ... flushCache="true"/> <update ... flushCache="true"/> <delete ... flushCache="true"/>

因為那些是默認的,你明顯不能明確地以這種方式來配置一條語句。相反,如果你想改 變默認的行為,只能設置 flushCache 和 useCache 屬性。比如,在一些情況下你也許想排除 從緩存中查詢特定語句結果,或者你也許想要一個查詢語句來刷新緩存。相似地,你也許有 一些更新語句依靠執行而不需要刷新緩存。

參照緩存

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

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

?

總結

以上是生活随笔為你收集整理的mybatis入门(三)之Mapper XML 文件的全部內容,希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯,歡迎將生活随笔推薦給好友。