ibatis基礎(chǔ)代碼包括:
1. ibatis實(shí)例配置
一個(gè)典型的配置文件如下(具體配置項(xiàng)目的含義見(jiàn)后):
<? xml version="1.0" encoding="UTF-8" ?>
<! DOCTYPE sqlMapConfig
PUBLIC "-//iBATIS.com//DTD SQL Map Config 2.0/
"http://www./dtd/sql-map-config-2.dt
<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" value ="user" />
< property name ="JDBC.Password" value ="mypass" />
< property name ="Pool.MaximumActiveConnections" value ="10" />
< property name ="Pool.MaximumIdleConnections" value ="5" />
< property name ="Pool.MaximumCheckoutTime" value ="120000" />
< property name ="Pool.TimeToWait" value ="500" />
< property name ="Pool.PingQuery" value ="select 1 from ACCOUNT" />
< property name ="Pool.PingEnabled" value ="false" />
< property name ="Pool.PingConnectionsOlderThan" value ="1" />
< property name ="Pool.PingConnectionsNotUsedFor" value ="1" />
</ dataSource >
</ transactionManager >
< sqlMap resource ="com/ibatis/sample/User.xml" />
</ sqlMapConfig >
⑴ Settings 節(jié)點(diǎn)
cacheModelsEnabled
是否啟用SqlMapClient上的緩存機(jī)制。 建議設(shè)為"true"
enhancementEnabled
是否針對(duì)POJO啟用字節(jié)碼增強(qiáng)機(jī)getter/setter的調(diào)用效能,避免Reflect所帶來(lái)的性能開(kāi)銷(xiāo)。同時(shí),這也為L(zhǎng)azy Loading帶來(lái)提升。 建議設(shè)為"true"
errorTracingEnabled
是否啟用錯(cuò)誤日志,在開(kāi)發(fā)期間建議設(shè)為"true" 以方便調(diào)試
lazyLoadingEnabled
是否啟用延遲加載機(jī)制,建議設(shè)為"true"
maxRequests
最大并發(fā)請(qǐng)求數(shù)(Statement并發(fā)數(shù))
maxTransactions
最大并發(fā)事務(wù)數(shù)
maxSessions 最大Session數(shù)。即當(dāng)前最大允許的并發(fā)SqlMapClient數(shù)。
useStatementNamespaces
是否使用Statement命名空間。
這里的命名空間指的是映射文件中,sqlMap節(jié)的namespace屬性,如在上例中針對(duì)t_use
表的映射文件sqlMap節(jié)點(diǎn): <sqlMap namespace="User"> 這里,指定了此sqlMap節(jié)點(diǎn)下定義的操作均屬于"User"命名空間。 在useStatementNamespaces="true"的情況下,Statement調(diào)用需追加命名空間,如:sqlMap.update("User.updateUser",user);
否則直接通過(guò)Statement名稱(chēng)調(diào)用即可,如: sqlMap.update("updateUser",user); 但請(qǐng)注意此時(shí)需要保證所有映射文件中,Statement定義無(wú)重名。
transactionManager節(jié)點(diǎn)
transactionManager節(jié)點(diǎn)定義了ibatis的事務(wù)管理器,目前提供了以下幾種選擇:
JDBC
通過(guò)傳統(tǒng)JDBC Connection.commit/rollback實(shí)現(xiàn)事務(wù)支持。
JTA
使用容器提供的JTA服務(wù)實(shí)現(xiàn)全局事務(wù)管理。
EXTERNAL
外部事務(wù)管理,如在EJB中使用ibatis,通過(guò)EJB的部署配置即可實(shí)現(xiàn)自
動(dòng)的事務(wù)管理機(jī)制。此時(shí)ibatis將把所有事務(wù)委托給外部容器進(jìn)行管理。
dataSource節(jié)點(diǎn)
dataSource從屬于transactionManager節(jié)點(diǎn),用于設(shè)定ibatis運(yùn)行期使用的DataSource屬性。
type屬性:
dataSource節(jié)點(diǎn)的type屬性指定了dataSource的實(shí)現(xiàn)類(lèi)型。 可選項(xiàng)目:
SIMPLE:
SIMPLE是ibatis內(nèi)置的dataSource實(shí)現(xiàn),其中實(shí)現(xiàn)了一個(gè)簡(jiǎn)單的
數(shù)據(jù)庫(kù)連接池機(jī)制,對(duì)應(yīng) ibatis 實(shí)現(xiàn)類(lèi)為
com.ibatis.sqlmap.engine.datasource.SimpleDataSourceFactory。
DBCP:
基于A(yíng)pache DBCP連接池組件實(shí)現(xiàn)的DataSource封裝,當(dāng)無(wú)容器提
供DataSource服務(wù)時(shí),建議使用該選項(xiàng),對(duì)應(yīng)ibatis實(shí)現(xiàn)類(lèi)為
com.ibatis.sqlmap.engine.datasource.DbcpDataSourceFactory。
JNDI:
使用J2EE容器提供的DataSource實(shí)現(xiàn),DataSource將通過(guò)指定
的JNDI Name從容器中獲取。對(duì)應(yīng) ibatis實(shí)現(xiàn)類(lèi)為
com.ibatis.sqlmap.engine.datasource.JndiDataSourceFactory。
dataSource的子節(jié)點(diǎn)說(shuō)明(SIMPLE&DBCP):
JDBC.Driver JDBC 驅(qū)動(dòng)。
如:org.gjt.mm.mysql.Driver
JDBC.ConnectionURL
數(shù)據(jù)庫(kù)URL。
如:jdbc:mysql://localhost/sample
如果用的是SQLServer JDBC Driver,需要
在url后追加SelectMethod=Cursor以獲得
JDBC事務(wù)的多Statement支持。
JDBC.Username
數(shù)據(jù)庫(kù)用戶(hù)名
JDBC.Password
數(shù)據(jù)庫(kù)用戶(hù)密碼
Pool.MaximumActiveConnections
數(shù)據(jù)庫(kù)連接池可維持的最大容量。
Pool.MaximumIdleConnections
數(shù)據(jù)庫(kù)連接池中允許的掛起(idle)連接數(shù)。
JNDI由于大部分配置是在應(yīng)用服務(wù)器中進(jìn)行,因此ibatis中的配置相對(duì)簡(jiǎn)
分別使用JDBC和JTA事務(wù)管理的JDNI配置:
使用JDBC事務(wù)管理的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 >
sqlMap節(jié)點(diǎn)
sqlMap節(jié)點(diǎn)指定了映射文件的位置,配置中可出現(xiàn)多個(gè)sqlMap節(jié)點(diǎn),以指定
項(xiàng)目?jī)?nèi)所包含的所有映射文件。
ibatis基礎(chǔ)語(yǔ)義
XmlSqlMapClientBuilder
XmlSqlMapClientBuilder是ibatis 2.0之后版本新引入的組件,用以替代1.x
版本中的XmlSqlMapBuilder。其作用是根據(jù)配置文件創(chuàng)建SqlMapClient實(shí)例。
SqlMapClient
SqlMapClient是ibatis的核心組件,提供數(shù)據(jù)操作的基礎(chǔ)平臺(tái)。SqlMapClient
可通過(guò)XmlSqlMapClientBuilder創(chuàng)建:
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
中的相對(duì)路徑。XmlSqlMapClientBuilder通過(guò)接受一個(gè)Reader類(lèi)型的配置文
件句柄,根據(jù)配置參數(shù),創(chuàng)建SqlMapClient實(shí)例。
SqlMapClient提供了眾多數(shù)據(jù)操作方法,下面是一些常用方法的示例,具體說(shuō)明
文檔請(qǐng)參見(jiàn)ibatis java doc,或者ibatis官方開(kāi)發(fā)手冊(cè)。
SqlMapClient基本操作示例
以下示例摘自ibatis官方開(kāi)發(fā)手冊(cè),筆者對(duì)其進(jìn)行了重新排版以獲得更好的閱讀效果。
例1: 數(shù)據(jù)寫(xiě)入操作(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: 數(shù)據(jù)查詢(xún) (select)
sqlMap.startTransaction();
Integer key = new Integer ( 1 );
Product product = (Product)sqlMap.queryForObject (“getProduct”, key);
sqlMap.commitTransaction();
例3: 在指定對(duì)象中存放查詢(xún)結(jié)果(select)
sqlMap.startTransaction();
Customer customer = new Customer();
sqlMap.queryForObject(“getCust”, parameterObject, customer);
sqlMap.queryForObject(“getAddr”, parameterObject, customer);
sqlMap.commitTransaction();
例4: 執(zhí)行批量查詢(xún) (select)
sqlMap.startTransaction();
List list = sqlMap.queryForList (“getProductList”, null )
sqlMap.commitTransaction();
例5: 關(guān)于A(yíng)utoCommit
// 沒(méi)有預(yù)先執(zhí)行startTransaction時(shí),默認(rèn)為auto_commit模式
int rows = sqlMap.insert (“insertProduct”, product);
例6:查詢(xún)指定范圍內(nèi)的數(shù)據(jù)
sqlMap.startTransaction();
List list = sqlMap.queryForList (“getProductList”, null , 0 , 40 );
sqlMap.commitTransaction();
例7: 結(jié)合RowHandler進(jìn)行查詢(xún)(select)
public class MyRowHandler implements RowHandler {
public void 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();
// 例8: 分頁(yè)查詢(xún) (select)
PaginatedList list =
sqlMap.queryForPaginatedList (“getProductList”, null , 10 );
list.nextPage();
list.previousPage();
// 例9: 基于Map的批量查詢(xún) (select)
sqlMap.startTransaction();
Map map = sqlMap.queryForMap (“getProductList”, null , “productCode”);
sqlMap.commitTransaction();
Product p = (Product) map.get(“EST - 93 ”);