Ibatis教程

Ibatis教程  

|字號

 

 

 

轉自：http://blog.csdn.net/lhminjava/article/details/1871136

ibatis 開發指南
ibatis Quick Start......................................... 5 
準備工做............................................... 5 
構建ibatis 基礎代碼...................................... 5 
ibatis 配置.............................................. 11 
ibatis 基礎語義............................................ 16 
XmlSqlMapClientBuilder....................................... 16 
SqlMapClient .............................................. 16 
SqlMapClient 基本操做示例................................. 16 
OR 映射................................................ 19 
ibatis 高級特性...................................... 26 
數據關聯.......................................... 26 
一對多關聯....................................... 26 
一對一關聯...................................... 28 
延遲加載.................................... 30 
動態映射..................................... 31 
事務管理........................................... 35

基於JDBC 的事務管理機制.................................... 35  
基於JTA 的事務管理機制................................ 36  
外部事務管理............................................ 38  
Cache .......................................... 39  
MEMORY 類型Cache 與WeakReference .................. 40  
LRU 型Cache ............................................... 42  
FIFO 型Cache ....................................... 43  
OSCache.............................................. 43  

 

相對Hibernate 和Apache OJB 等「一站式」ORM 解決方案而言，ibatis 是一種「半自動化」的ORM 實現。所謂「半自動」，可能理解上有點生澀。縱觀目前主流的ORM ，不管Hibernate 仍是Apache OJB，都對數據庫結構提供了較爲完整的封裝，提供了從POJO 到數據庫表的全套映射機制。程序員每每只需定義好了POJO 到數據庫表的映射關係，便可經過Hibernate 或者OJB 提供的方法完成持久層操做。程序員甚至不須要對SQL 的熟練掌握， Hibernate/OJB 會根據制定的存儲邏輯，自動生成對應的SQL 並調用JDBC 接口加以執行。大多數狀況下（ 特別是對新項目，新系統的開發而言），這樣的機制無往不利，大有一統天下的勢頭。可是，在一些特定的環境下，這種一站式的解決方案卻未必靈光。在筆者的系統諮詢工做過程當中，經常遇到如下狀況：

 
1． 系統的部分或所有數據來自現有數據庫，處於安全考慮，只對開發團隊提供幾條Select SQL（或存儲過程）以獲取所需數據，具體的表結構不予公開。
2． 開發規範中要求， 全部牽涉到業務邏輯部分的數據庫操做，必須在數據庫層由存儲過程實現（就筆者工做所面向的金融行業而言，工商銀行、中國銀行、交 通銀行，都在開發規範中嚴格指定）
3． 系統數據處理量巨大，性能要求極爲苛刻，這每每意味着咱們必須經過通過高度優化的SQL 語句（或存儲過程）才能達到系統性能設計指標。面對這樣的需求，再次舉起Hibernate 大刀，卻發現刀鋒再也不銳利，甚至沒法使用，奈何？恍惚之際，只好再摸出JDBC 準備拼死一搏……，說得未免有些淒涼，直接使用JDBC 進行數據庫操做實際上也是不錯的選擇，只是拖沓的數據庫訪問代碼，乏味的字段讀取操做使人厭煩。"半自動化」的ibatis，卻恰好解決了這個問題。
這裏的「半自動化」，是相對Hibernate 等提供了全面的數據庫封裝機制的「全自動化」ORM 實現而言，「全自動」ORM 實現了POJO 和數據庫表之間的映射，以及SQL 的自動生成和執行。而ibatis 的着力點，則在於POJO 與SQL 之間的映射關係。也就是說，ibatis 並不會爲程序員在運行期自動生成SQL 執行。具體的SQL 須要程序員編寫，而後經過映射配置文件，將SQL 所需的參數，以及返回的結果字段映射到指定POJO 。使用ibatis 提供的ORM 機制，對業務邏輯實現人員而言，面對的是純粹的Java 對象， 這一層與經過Hibernate 實現ORM 而言基本一致，而對於具體的數據操做，Hibernate 會自動生成SQL 語句，而ibatis 則要求開發者編寫具體的SQL 語句。相對Hibernate 等「全自動」ORM 機制而言，ibatis 以SQL 開發的工做量和數據庫移植性上的讓步，爲系統設計提供了更大的自由空間。做爲「全自動」ORM 實現的一種有益補充，ibatis 的出現顯得別具意義。

 

準備工做
1. 下載ibatis 軟件包（http://www.ibatis.com）。
2. 建立測試數據庫，並在數據庫中建立一個t_user 表，其中包含三個字段： 
. id(int) 
. name(varchar) 
. sex(int) 。
3. 爲了在開發過程更加直觀，咱們須要將ibatis 日誌打開以便觀察ibatis 運做的細節。
ibatis 採用Apache common_logging，並結合Apache log4j 做爲日誌輸出組件。在
CLASSPATH 中新建log4j.properties 配置文件，內容以下：
log4j.rootLogger=DEBUG, stdout 
log4j.appender.stdout=org.apache.log4j.ConsoleAppender 
log4j.appender.stdout.layout=org.apache.log4j.PatternLayout 
log4j.appender.stdout.layout.ConversionPattern=%c{1} -%m%n 
log4j.logger.java.sql.PreparedStatement=DEBUG 
構建ibatis 基礎代碼
ibatis 基礎代碼包括： 
1． ibatis 實例配置
一個典型的配置文件sqlMapConfig以下（具體配置項目的含義見後）： 
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE sqlMapConfig
PUBLIC "-//iBATIS.com//DTD SQL Map Config 2.0//EN" 
"http://www.ibatis.com/dtd/sql-map-config-2.dtd">
<sqlMapConfig>
<settings
cacheModelsEnabled="true"
enhancementEnabled="true"
lazyLoadingEnabled="true"
errorTracingEnabled="true"
maxRequests="32"
maxSessions="10"
maxTransactions="5"
useStatementNamespaces="false" 
/>
<transactionManager type="JDBC">

<dataSource type="SIMPLE"> 
<property name="JDBC.Driver"  value="com.p6spy.engine.spy.P6SpyDriver"/> 
<property name="JDBC.ConnectionURL"  value="jdbc:mysql://localhost/sample"/> 
<property name="JDBC.Username" ="user"/> 
<property name="JDBC.Password" ="mypass"/> 
</dataSource> 
</transactionManager> 
<sqlMap resource="com/ibatis/sample/User.xml"/> 
</sqlMapConfig>

2． POJO（Plain Ordinary Java Object） 
下面是咱們用做示例的一個POJO: 
public class User implements Serializable { 
private Integer id; 
private String name; 
private Integer sex; 
private Set addresses = new HashSet(); 
/** default constructor */
public User() { 
} 
public Integer getId() {
return this.id;

} 
public void setId(Integer id) {
this.id = id; 
} 
public String getName() {
return this.name; 
} 
public void setName(String name) {
this.name = name; 
} 
public Integer getSex() {
return this.sex; 
} 
public void setSex(Integer sex) {
this.sex = sex; 
} 
}
3． 映射文件
與Hibernate 不一樣。由於須要人工編寫SQL 代碼，ibatis 的映射文件通常採
用手動編寫（經過Copy/Paste，手工編寫映射文件也並沒想象中的麻煩）。
針對上面POJO 的映射代碼以下：
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE sqlMap
PUBLIC "-//iBATIS.com//DTD SQL Map 2.0//EN"
"http://www.ibatis.com/dtd/sql-map-2.dtd">
<sqlMap namespace="User">
<typeAlias alias="user" type="com.ibatis.sample.User"/>
<select id="getUser" parameterClass="java.lang.String"  resultClass="user">
<![CDATA[
select  name, sex from t_user where name = #name# 
]]>
</select>
<update id="updateUser"  parameterClass="user"> 
<![CDATA[
UPDATE t_user SET name=#name#, sex=#sex#  WHERE id = #id# 
]]>
</update>
<insert id="insertUser"  parameterClass="user">
INSERT INTO t_user ( name, sex) VALUES ( #name#,#sex# ) 
</insert>
<delete id="deleteUser" parameterClass="java.lang.String">
delete from t_user  where id = #value# 
</delete>
</sqlMap> 
從上面的映射文件能夠看出，經過<insert>、<delete>、<update>、<select>四個節點，咱們分別定義了針對TUser 對象的增刪改查操做。在這四個節點中，咱們指定了對應的SQL 語句，以update 節點爲例： 
……
<update id="updateUser" ⑴ parameterClass="user"> ⑵ 
<![CDATA[ ⑶ 
UPDATE t_user ⑷ SET ( name=#name#, ⑸ sex=#sex# ⑹ ) WHERE id = #id# ⑺
]]> 
</update> 
…… 
⑴ ID 
指定了操做ID，以後咱們能夠在代碼中經過指定操做id 來執行此節點所定義的操做，如：sqlMap.update("updateUser",user); ID 設定使得在一個配置文件中定義兩個同名節點成爲可能（兩個update 節
點，以不一樣id 區分） 
⑵ parameterClass 指定了操做所需的參數類型，此例中update 操做以com.ibatis.sample.User 類型的對象做爲參數，目標是將提供的User 實例更新到數據庫。parameterClass="user"中，user 爲「com.ibatis.sample.User」 類的別名，別名可經過typeAlias 節點指定，如示例配置文件中的：<typeAlias alias="user" type="com.ibatis.sample.User"/>
⑶ <![CDATA[……]]> :經過<![CDATA[……]]>節點，能夠避免SQL 中與XML 規範相沖突的字符對XML 映射文件的合法性形成影響。⑷ 執行更新操做的SQL，這裏的SQL 即實際數據庫支持的SQL 語句， 將由 ibatis 填入參數後交給數據庫執行。⑸ SQL 中所需的用戶名參數，「#name#」在運行期會由傳入的user 對象的name 屬性填充。
⑹ SQL 中所需的用戶性別參數「#sex#」， 將在運行期由傳入的user 對象的sex 屬性填充。
⑺ SQL 中所需的條件參數「#id#」， 將在運行期由傳入的user 對象的id 屬性填充。對於這個示例，ibatis 在運行期會讀取id 爲「updateUser」的update 節點的SQL 定義，並調用指定的user 對象的對應getter 方法獲取屬性值，並用此屬性值，對SQL 中的參數進行填充後提交數據庫執行。此例對應的應用級代碼以下，其中演示了的基本使用方法：
String resource ="com/ibatis/sample/SqlMapConfig.xml"; 
Reader reader; 
reader = Resources.getResourceAsReader(resource); 
XmlSqlMapClientBuilder xmlBuilder =new XmlSqlMapClientBuilder(); 
SqlMapClient sqlMap = xmlBuilder.buildSqlMap(reader); 
//sqlMap系統初始化完畢，開始執行update操做
try{ 
sqlMap.startTransaction(); 
User user = new User(); 
user.setId(new Integer(1)); 
user.setName("Erica"); 
user.setSex(new Integer(1)); 
sqlMap.update("updateUser",user); 
sqlMap.commitTransaction(); 
finally{ 
sqlMap.endTransaction(); 
} 
其中，SqlMapClient 是ibatis 運做的核心，全部操做均經過SqlMapClient 實例完成。能夠看出，對於應用層而言，程序員面對的是傳統意義上的數據對象，而非JDBC 中煩雜的ResultSet，這使得上層邏輯開發人員的工做量大大減輕，同時代碼更加清晰簡潔。數據庫操做在映射文件中加以定義，從而將數據存儲邏輯從上層邏輯代碼中獨立出來。而底層數據操做的SQL 可配置化，使得咱們能夠控制最終的數據操做方式，經過SQL 的優化得到最佳的數據庫執行效能，這在依賴SQL 自動生成的「全自動」ORM 機制中是所難以實現的。
 結合上面示例中的ibatis 配置文件。下面是對配置文件中各節點的說明：
⑴ Settings 節點
參數描述cacheModelsEnabled 是否啓用SqlMapClient 上的緩存機制。建議設爲"true" 
enhancementEnabled 是否針對POJO 啓用字節碼加強機制以提高getter/setter 的調用效能，避免使用Java Reflect 所帶來的性能開銷。同時，這也爲Lazy Loading 帶來了極大的性能提高。
建議設爲"true" 
errorTracingEnabled 是否啓用錯誤日誌，在開發期間建議設爲"true"以方便調試

lazyLoadingEnabled 是否啓用延遲加載機制，建議設爲"true" 
maxRequests 最大併發請求數（Statement 併發數） 
maxTransactions 最大併發事務數
maxSessions 最大Session 數。即當前最大容許的併發SqlMapClient 數。
maxSessions 設定必須介於
maxTransactions 和maxRequests 之間，即
maxTransactions<maxSessions=< 
maxRequests

useStatementNamespaces 是否使用Statement 命名空間。
這裏的命名空間指的是映射文件中，sqlMap 節點
的namespace 屬性，如在上例中針對t_user 
表的映射文件sqlMap 節點： 
<sqlMap namespace="User"> 
這裏，指定了此sqlMap 節點下定義的操做均從
屬於"User"命名空間。
在useStatementNamespaces="true"的情
況下，Statement 調用需追加命名空間，如：

 sqlMap.update("User.updateUser",use 
r); 
不然直接經過Statement 名稱調用即
sqlMap.update("updateUser",user); 
但請注意此時須要保證全部映射
定義無重名。

⑵ transactionManager 節點
transactionManager 節點定義了ibatis 的事務管理器，目前提供瞭如下幾
種選擇： 
. JDBC 
經過傳統JDBC Connection.commit/rollback 實現事務支持。
. JTA 
使用容器提供的JTA 服務實現全局事務管理。
. EXTERNAL 
外部事務管理， 如在EJB 中使用ibatis，經過EJB 的部署配置便可實現自
動的事務管理機制。此時ibatis 將把全部事務委託給外部容器進行管理。
此外，經過Spring 等輕量級容器實現事務的配置化管理也是一個不錯的選
擇。關於結合容器實現事務管理，參見「高級特性」中的描述。
⑶ dataSource 節點
dataSource 從屬於transactionManager 節點，用於設定ibatis 運行期使
用的DataSource 屬性。
type 屬性： dataSource 節點的type屬性指定了dataSource 的實現類型。
可選項目： 
. SIMPLE： SIMPLE 是ibatis 內置的dataSource 實現，其中實現了一個簡單的
數據庫鏈接池機制，對應ibatis 實現類爲
com.ibatis.sqlmap.engine.datasource.SimpleDataSourceFactory 。
. DBCP: 
基於Apache DBCP 鏈接池組件實現的DataSource 封裝，當無容器提
供DataSource 服務時，建議使用該選項，對應ibatis 實現類爲
com.ibatis.sqlmap.engine.datasource.DbcpDataSourceFactory 。
. JNDI： 
使用J2EE 容器提供的DataSource 實現，DataSource 將經過指定
的JNDI Name 從容器中獲取。對應ibatis 實現類爲
com.ibatis.sqlmap.engine.datasource.JndiDataSourceFacto 
ry。
dataSource 的子節點說明（SIMPLE&DBCP）：

 

參數描述
JDBC.Driver JDBC 驅動。
如：org.gjt.mm.mysql.Driver 
JDBC.ConnectionURL 數據庫URL 。
如：jdbc:mysql://localhost/sample 
若是用的是SQLServer JDBC Driver，須要
在url 後追加SelectMethod=Cursor 以得到
JDBC 事務的多Statement 支持。
JDBC.Username 數據庫用戶名
JDBC.Password 數據庫用戶密碼
Pool.MaximumActiveConn 數據庫鏈接池可維持的最大容量。
ections 
Pool.MaximumIdleConnec 
tions 
數據庫鏈接池中容許的掛起（idle）鏈接數。
以上子節點適用於SIMPLE 和DBCP 模式，分別針對SIMPLE 和DBCP 模式的
DataSource 私有配置節點以下：
SIMPLE: 
參數描述
Pool.MaximumCheckoutTi 數據庫聯接池中，鏈接被某個任務所容許佔用的
me 最大時間，若是超過這個時間限定，鏈接將被強
制收回。（毫秒） 
Pool.TimeToWait 當線程試圖從鏈接池中獲取鏈接時，鏈接池中無
可用鏈接可供使用，此時線程將進入等待狀態， 
直到池中出現空閒鏈接。此參數設定了線程所允
許等待的最長時間。（毫秒） 
Pool.PingQuery 數據庫鏈接狀態檢測語句。
某些數據庫在鏈接在某段時間持續處於空閒狀態 
時會將其斷開。而鏈接池管理器將經過此語句檢
測池中鏈接是否可用。
檢測語句應該是一個最簡化的無邏輯SQL 。
如「select 1 from t_user」， 若是執行此語句
成功，鏈接池管理器將認爲此鏈接處於可用狀態。
Pool.PingEnabled 是否容許檢測鏈接狀態。
Pool.PingConnectionsOl 對持續鏈接時間超過設定值（毫秒）的鏈接進行
derThan 檢測。

 

 

Pool.PingConnectionsNotUsedFor 對空閒超過設定值（毫秒）的鏈接進行檢測。
DBCP: 
參數描述
Pool.MaximumWait 當線程試圖從鏈接池中獲取鏈接時，鏈接池中無可用鏈接可供使用，此時線程將進入等待狀態， 
直到池中出現空閒鏈接。此參數設定了線程所容許等待的最長時間。（毫秒） 
Pool.ValidationQuery 數據庫鏈接狀態檢測語句。某些數據庫在鏈接在某段時間持續處於空閒狀態時會將其斷開。而鏈接池管理器將經過此語句檢測池中鏈接是否可用。檢測語句應該是一個最簡化的無邏輯SQL 。
如「select 1 from t_user」， 若是執行此語句成功，鏈接池管理器將認爲此鏈接處於可用狀態。
Pool.LogAbandoned 當數據庫鏈接被廢棄時，是否打印日誌。
Pool.RemoveAbandonedTi 數據庫鏈接被廢棄的最大超時時間
meoutPool.RemoveAbandoned 當鏈接空閒時間超過RemoveAbandonedTimeout 時，是否將其廢棄。
JNDI 因爲大部分配置是在應用服務器中進行，所以ibatis 中的配置相對簡單，下面是分別使用JDBC 和JTA 事務管理的JDNI 配置： 
使用JDBC 事務管理的JNDI DataSource 配置 
<transactionManager type="JDBC" > 
<dataSource type="JNDI"> 
<property name="DataSource" 
value="java:comp/env/jdbc/myDataSource"/> 
</dataSource> 
</transactionManager> 
<transactionManager type="JTA" > 
<property name="UserTransaction" 
value="java:/ctx/con/UserTransaction"/> 
<dataSource type="JNDI"> 
<property name="DataSource" 
value="java:comp/env/jdbc/myDataSource"/> 
</dataSource>

</transactionManager>
⑷ sqlMap 節點
sqlMap 節點指定了映射文件的位置，配置中可出現多個sqlMap 節點，以指定
項目內所包含的全部映射文件。
ibatis 基礎語義
XmlSqlMapClientBuilder 
XmlSqlMapClientBuilder 是ibatis 2.0 以後版本新引入的組件，用以替代1.x 
版本中的XmlSqlMapBuilder。其做用是根據配置文件建立SqlMapClient 實例。
SqlMapClient 
SqlMapClient 是ibatis 的核心組件，提供數據操做的基礎平臺。SqlMapClient 
可經過XmlSqlMapClientBuilder 建立: 
String resource ="com/ibatis/sample/SqlMapConfig.xml"; 
Reader reader; 
reader = Resources.getResourceAsReader(resource); 
XmlSqlMapClientBuilder xmlBuilder =
new XmlSqlMapClientBuilder(); 
SqlMapClient sqlMap = xmlBuilder.buildSqlMap(reader);
"com/ibatis/sample/SqlMapConfig.xml"指明瞭配置CLASSPATH文件在
中的相對路徑。XmlSqlMapClientBuilder 經過接受一個Reader 類型的配置文
件句柄，根據配置參數，建立SqlMapClient 實例。
SqlMapClient 提供了衆多數據操做方法，下面是一些經常使用方法的示例，具體說明 
文檔請參見ibatis java doc，或者ibatis 官方開發手冊。
SqlMapClient 基本操做示例
如下示例摘自ibatis 官方開發手冊，筆者對其進行了從新排版以得到更好的閱讀效果。
例1: 數據寫入操做(insert, update, delete): 
sqlMap.startTransaction(); 
Product product = new Product(); 
product.setId (1); 
product.setDescription (「Shih Tzu」);
int rows = sqlMap.insert (「insertProduct」, product); 
sqlMap.commitTransaction();

例2: 數據查詢(select) 
sqlMap.startTransaction(); 
Integer key = new Integer (1); 
Product product = (Product)sqlMap.queryForObject 
(「getProduct」, key); 
sqlMap.commitTransaction(); 
例3: 在指定對象中存放查詢結果(select) 
sqlMap.startTransaction(); 
Customer customer = new Customer(); 
sqlMap.queryForObject(「getCust」, parameterObject, customer); 
sqlMap.queryForObject(「getAddr」, parameterObject, customer); 
sqlMap.commitTransaction(); 
例4: 執行批量查詢(select) 
sqlMap.startTransaction(); 
List list = sqlMap.queryForList (「getProductList」, null); 
sqlMap.commitTransaction(); 
例5: 關於AutoCommit 
//沒有預先執行startTransaction時，默認爲模式
int rows = sqlMap.insert (「insertProduct」, product); 
auto_commit 
例6:查詢指定範圍內的數據
sqlMap.startTransaction(); 
= 「」, nullsqlMap.commitTransaction(); 
List list sqlMap.queryForList (getProductList, 0, 40);

 

例7: 結合RowHandler 進行查詢(select) 
MyRowHandler implements RowHandler { 
handleRow (Object object, List list) throws 
SQLException { 
Product product = (Product) object; 
product.setQuantity (10000); 
sqlMap.update (「updateProduct」, product); 
} 
} 
sqlMap.startTransaction(); 
RowHandler rowHandler = new MyRowHandler(); 
List list = sqlMap.queryForList (「getProductList」, null, 
rowHandler); 
sqlMap.commitTransaction(); 
public classpublic void

 

 

例8: 分頁查詢(select) 
PaginatedList list = 
sqlMap.queryForPaginatedList (「getProductList」, null, 10); 
list.nextPage(); 
list.previousPage(); 
例9: 基於Map 的批量查詢(select) 
sqlMap.startTransaction(); 
Map map = sqlMap.queryForMap (「getProductList」, null, 
「productCode」); 
sqlMap.commitTransaction(); 
Product p = (Product) map.get(「EST-93」);

 

 

OR 映射相對Hibernate 等ORM 實現而言，ibatis 的映射配置更爲簡潔直接，下面是一
個典型的配置文件。
<!DOCTYPE sqlMap
PUBLIC "-//iBATIS.com//DTD SQL Map 2.0//EN"
"http://www.ibatis.com/dtd/sql-map-2.dtd">
<sqlMap namespace="User">
<!--模塊配置--> 
<typeAlias alias="user" type="com.ibatis.sample.User"/>
<cacheModel id="userCache" type="LRU">
<flushInterval hours="24"/> 
<flushOnExecute statement=" updateUser"/>
<property name="size" value="1000" />
</cacheModel>
<!—Statement配置--> 
<select id="getUser"
parameterClass="java.lang.String"
resultClass="user" 
cacheModel="userCache"
>
<![CDATA[
select name, sex from t_user where name = #name# 
]]>
</select> 
<update id="updateUser"
parameterClass="user">
UPDATE t_user SET name=#name#, sex=#sex# WHERE id = #id# 
</update> </sqlMap> 
能夠看到，映射文件主要分爲兩個部分：模塊配置和Statement 配置。
模塊配置包括： 
. typeAlias 節點： 
定義了本映射文件中的別名，以免過長變量值的反覆書寫，此例中經過
typeAlias 節點爲類"com.ibatis.sample.User"定義了一個別名"user"， 
這樣在本配置文件的其餘部分，須要引用"com.ibatis.sample.User" 類時，
只需以其別名替代便可。
. cacheModel 節點
定義了本映射文件中使用的Cache 機制: 
<cacheModel id="userCache" type="LRU"> 
<flushInterval hours="24"/> 
<flushOnExecute statement="updateUser"/> 
<property name="size" value="1000" /> 
</cacheModel> 
這裏申明瞭一個名爲"userCache" 的，以後能夠在cacheModel 
Statement 申明中對其進行引用：
<select id="getUser"
parameterClass="java.lang.String"
resultClass="user" 
cacheModel="userCache"
>

 

這代表對經過id 爲"getUser"的獲取的數據，使用Select statement 
cacheModel "userCache" 進行緩存。以後若是程序再次用此Statement 
進行數據查詢，即直接從緩存中讀取查詢結果，而無需再去數據庫查詢。
cacheModel 主要有下面幾個配置點： 
. flushInterval ： 
設定緩存有效期，若是超過此設定值，則將此CacheModel 的緩存清空。
. size： 
本CacheModel 中最大容納的數據對象數量。
. flushOnExecute： 
指定執行特定Statement 時，將緩存清空。如updateUser 操做將更
新數據庫中的用戶信息，這將致使緩存中的數據對象與數據庫中的實際
數據發生誤差，所以必須將緩存清空以免髒數據的出現。
關於Cache 的深刻探討，請參見「高級特性」中的相關章節。
Statement 配置：  

Statement 配置包含了數個與SQL Statement 相關的節點，分別爲： 
. statement 
. insert 
. delete 
. update 
. select 
. procedure 
其中，statement 最爲通用，它能夠替代其他的全部節點。除statement 以外
的節點各自對應了SQL 中的同名操做（procedure 對應存儲過程）。
使用statement 定義全部操做當然能夠達成目標，但缺少直觀性，建議在實際
開發中根據操做目的，各自選用對應的節點名加以申明。一方面，使得配置文件
更加直觀，另外一方面，也可藉助DTD 對節點申明進行更有針對性的檢查，以免
配置上的失誤。
各類類型的Statement 配置節點的參數類型基本一致，區別在於數量不一樣。如
insert、update、delete 節點無需返回數據類型定義（老是int）。
主要的配置項以下：
statement: 
<statement id="statementName" 
[parameterClass="some.class.Name"] 
[resultClass="some.class.Name"] 
[parameterMap="nameOfParameterMap"] 
[resultMap="nameOfResultMap"] 
[cacheModel="nameOfCache"] 
> 
select * from t_user where sex = [?|#propertyName#] 
order by [$simpleDynamic$] 
</statement> 
select: 
<select id="statementName" 
[parameterClass="some.class.Name"] 
[resultClass="some.class.Name"] 
[parameterMap="nameOfParameterMap"] 
[resultMap="nameOfResultMap"] 
[cacheModel="nameOfCache"] 
> 
select * from t_user where sex = [?|#propertyName#] 
order by [$simpleDynamic$] 
</select> 
Insert:

 

 

<insert id="statementName" 
[parameterClass="some.class.Name"] 
[parameterMap="nameOfParameterMap"]
>
insert into t_user
(name,sex)
values
([?|#propertyName#],[?|#propertyName#]) 
</insert> 
Update： 
<update id="statementName" 
[parameterClass="some.class.Name"] 
[parameterMap="nameOfParameterMap"]
>
UPDATE t_user 
SET
name=[?|#propertyName#], 
sex=[?|#propertyName#] 
WHERE id = [?|#propertyName#] 
</update> 
Delete： 
<delete id="statementName" 
[parameterClass="some.class.Name"] 
[parameterMap="nameOfParameterMap"]
>
delete from t_user 
where id = [?|#propertyName#] 
</delete> 
其中以「[]」包圍的部分爲可能出現的配置欄目。
參數描述
parameterClass 參數類。指定了參數的完整類名（包括包路徑）。
可經過別名避免每次重複書寫冗長的類名。 
resultClass 結果類。指定結果類型的完整類名（包括包路徑） 
可經過別名避免每次重複書寫冗長的類名。
parameterMap 參數映射，需結合parameterMap 節點對映射
關係加以定義。
對於存儲過程以外的statement 而言，建議使用
parameterClass 做爲參數配置方式， 一方面避

 

 

免了參數映射配置工做，另外一方面其性能表現也
更加出色。
resultMap 結果映射，需結合resultMap 節點對映射關係
加以定義。
cacheModel statement 對應的Cache 模塊。
對於參數定義而言，儘可能使用parameterClass，即直接將POJO 做爲
statement 的調用參數，這樣在SQL 中能夠直接將POJO 的屬性做爲參數加以
設定，如：
<update id="updateUser"
parameterClass="com.ibatis.sample.User">
UPDATE t_user 
SET
name=#name#, 
sex=#sex# 
WHERE id = #id# 
</update> 
這裏將com.ibatis.sample.User 類設定爲的參數，以後，update statement 
咱們便可在SQL 中經過#propertyName#對POJO 的屬性進行引用。如上例
中的：
SET name=#name#, sex=#sex# WHERE id=#id# 
運行期，將經過調用對象的、和方法得到相ibatis User getName getSex getId 
應的參數值，並將其做爲SQL 的參數。
若是parameterClass 中設定的是jdk 的中的簡單對象類型，如String、
Integer，ibatis 會直接將其做爲SQL 中的參數值。
咱們也能夠將包含了參數數據的Map 對象傳遞給Statement ，如： 
<update id="updateUser"
parameterClass="java.util.Map">
UPDATE t_user 
SET
name=#name#, 
sex=#sex# 
WHERE id = #id# 
</update> 
這裏傳入的參數就是一個對象，將以」」、」」、」id」從中Map ibatis key namesex
提取對應的參數值。
一樣的原理，咱們也能夠在resultMap 中設定返回類型爲map 。
<select id="getUser" 
parameterClass="java.lang.String" 
resultClass="java.util.Map">

 

 

<![CDATA[
select 
id, 
name, 
sex 
from t_user 
where id = #id# 
]]>
</select>
返回的結果將以各字段名爲保存在對象中返回。key Map 
在SQL 中設定參數名時，能夠同時指定參數類型， 如：
SET name=#name:VARCHAR#,sex=#sex:NUMERIC# WHERE 
id=#id:NUMERIC# 
對於返回結果而言，若是是select 語句，建議也採用resultClass 進行定義，如：
<select id="getUser"
parameterClass="java.lang.String"
resultClass="user">
<![CDATA[
select 
name, 
sex 
from t_user 
where name = #name# 
]]>
</select> 
會自動根據語句中的字段名，調用對應的方法設定屬性ibatis select POJO set 
值，如上例中，ibatis 會調用setName，setSex 方法將Select 語句返回的數據賦
予相應的POJO 實例。
有些時候，數據庫表中的字段名過於晦澀，而爲了使得代碼更易於理解，咱們
但願字段映射到POJO 時，採用比較易讀的屬性名，此時，咱們能夠經過Select 
的as 字句對字段名進行轉義，如（假設咱們的書庫中對應用戶名的字段爲

 

xingming ，對應性別的字段爲xingbie）： 
select 
xingming as name, 
xingbie as sex 
from t_user 
where id = #id# 
會根據轉義後的字段名進行屬性映射（即調用的方法而ibatis POJO setName 
不是setXingming 方法）。

 

 

parameterMap 和resultMap 實現了POJO 到數據庫字段的映射配置，下面是
一個例子： 
<resultMap id="get_user_result" class="user"> 
<result property="name" column="xingming" 
jdbcType="VARCHAR" javaType="java.lang.String"/> 
<result property="sex" column="xingbie" 
jdbcType="int" javaType="java.lang.Integer"/> 
<result property="id" column="id" 
jdbcType="int" javaType="java.lang.Integer"/> 
</resultMap> 
<parameterMap id="update_user_para" class="redemption" > 
<parameter property="name" 
jdbcType="VARCHAR" 
javaType="java.lang.String" 
nullValue="" 
/> 
<parameter property="sex" 
jdbcType="int" 
javaType="java.lang.Integer" 
nullValue=""

/> 
</parameterMap> 
Parameter 的nullValue 指定了若是參數爲空（null）時的默認值。
以後咱們便可在statement 申明中對其進行引用，如：
<procedure id="getUserList"
resultMap="get_user_result"
> 
{call sp_getUserList()} 
</procedure> 
<procedure id="doUserUpdate"
parameterMap="update_user_para"
> 
{call sp_doUserUpdate(#id#,#name#,#sex#)} 
</procedure> 
通常而言，對於insert 、update 、delete 、select 語句，優先採用parameterClass 
和resultClass 。
parameterMap 使用較少，而resultMap 則大多用於嵌套查詢以及存儲過程的

 

處理，之因此這樣，緣由是因爲存儲過程相對而言比較封閉（不少狀況下須要調用現有
的存儲過程，其參數命名和返回的數據字段命名每每不符合Java 編程中的命名習慣， 
而且因爲咱們難以經過Select SQL 的as子句進行字段名轉義，沒法使其自動與POJO 
中的屬性名相匹配）。此時，使用resultMap 創建字段名和POJO 屬性名之間的映射
關係就顯得很是有效。另外一方面，因爲經過resultMap 指定了字段名和字段類型， 
ibatis 無需再經過JDBC ResultSetMetaData 來動態獲取字段信息，在必定程度
上也提高了性能表現。
ibatis 高級特性
數據關聯
至此，咱們討論的都是針對獨立數據的操做。在實際開發中，咱們經常遇到關聯數
據的狀況，如User 對象擁有若干Address 對象，每一個Address 對象描述了對應User 的
一個聯繫地址，這種狀況下，咱們應該如何處理？ 
經過單獨的Statement 操做當然能夠實現（經過Statement 用於讀取用戶數據，再手
工調用另一個Statement 根據用戶ID 返回對應的Address 信息）。不過這樣未免失之
繁瑣。下面咱們就看看在ibatis 中，如何對關聯數據進行操做。
ibatis 中，提供了Statement 嵌套支持，經過Statement 嵌套，咱們便可實現關聯數
據的操做。
一對多關聯
下面的例子中，咱們首選讀取t_user 表中的全部用戶記錄，而後獲取每一個用戶對應
的全部地址信息。
配置文件以下：
<sqlMap namespace="User"> 
<typeAlias alias="user" type="com.ibatis.sample.User"/> 
<typeAlias alias="address" type="com.ibatis.sample.Address"/> 
<resultMap id="get-user-result" class="user"> 
<result property="id" column="id"/> 
<result property="name" column="name"/> 
<result property="sex" column="sex"/> 
<result property="addresses" column="id" 
select="User.getAddressByUserId"/> 
</resultMap> 
<select id="getUsers" 
parameterClass="java.lang.String" 
resultMap="get-user-result"> 
<![CDATA[ 
select 
id,

 

 

name, 
sex 
from t_user 
where id = #id# 
]]>
</select>
<select id="getAddressByUserId"
parameterClass="int"
resultClass="address">
<![CDATA[
select 
address, 
zipcode 
from t_address 
where user_id = #userid# 
]]>
</select>
</sqlMap>
對應代碼：
String resource ="com/ibatis/sample/SqlMapConfig.xml"; 
Reader reader; 
reader = Resources.getResourceAsReader(resource); 
XmlSqlMapClientBuilder xmlBuilder= new XmlSqlMapClientBuilder(); 
sqlMap = xmlBuilder.buildSqlMap(reader); 
//sqlMap系統初始化完畢
List userList = sqlMap.queryForList("User.getUsers", ""); 
for (int i = 0; i < userList.size(); i++) { 
User user = (User)userList.get(i);
System.out.println("==>" + user.getName()); 
for (int k = 0; k < user.getAddresses().size(); k++) { 
Address addr = (Address) user.getAddresses().get(k);

System.out.println(addr.getAddress()); 
} 
}

 

 

這裏經過在resultMap 中定義嵌套查詢getAddressByUserId，咱們實現了關聯
數據的讀取。
實際上，這種方式相似於前面所說的經過兩條單獨的Statement 進行關聯數據的讀
取，只是將關聯關係在配置中加以描述，由ibatis 自動完成關聯數據的讀取。
須要注意的是，這裏有一個潛在的性能問題，也就是所謂「n+1」Select 問題。
注意上面示例運行過程當中的日誌輸出： 
…… 
PreparedStatement -{pstm-100001} PreparedStatement: select id, name, sex from 
t_user 
…… 
PreparedStatement -{pstm-100004} PreparedStatement: select address, zipcode from 
t_address where user_id = ? 
…… 
PreparedStatement -{pstm-100007} PreparedStatement: select address,zipcode from 
t_address where user_id = ? 
第一條將表中的全部數據讀取出來PreparedStatement t_user （目前t_user 表中有兩
條測試數據），隨即，經過兩次Select 操做，從t_address 表中讀取兩個用戶所關聯的
Address 記錄。
若是t_user 表中記錄較少，不會有明顯的影響，假設t_user 表中有十萬條記錄，那

麼這樣的操做將須要100000＋1 條Select 語句反覆執行才能得到結果，無疑，隨着記錄的增加，這樣的開銷將沒法承受。之因此在這裏說起這個問題，目的在於引發讀者的注意，在系統設計中根據具體情況，採用一些規避手段（如使用存儲過程集中處理大批量關聯數據），從而避免由於這個問題而引發產品品質上的缺陷。