Spring + MyBatis配置整合_ZenDei技術網路在線

ibatis改名為mybatis已經將近一年了，mybatis3也發佈了，但是相關的開發文檔卻很少，查閱了官方的使用指南，也是說的模糊不清，一筆帶過，尤其是註解部分，只是列舉了註解種類，卻沒有對應的例子，因此可能會給某些兄弟使用mybatis註解帶來困惑，我想就我微薄的知識想對mybatis註解的使 ...

ibatis改名為mybatis已經將近一年了，mybatis3也發佈了，但是相關的開發文檔卻很少，查閱了官方的使用指南，也是說的模糊不清，一筆帶過，尤其是註解部分，只是列舉了註解種類，卻沒有對應的例子，因此可能會給某些兄弟使用mybatis註解帶來困惑，我想就我微薄的知識想對mybatis註解的使用以及和spring整合談談自己的看法，也希望大家猛烈的指正我的錯誤。

首先當然得下載mybatis-3.0.5.jar和mybatis-spring-1.0.1.jar兩個JAR包，並放在WEB-INF的lib目錄下(如果你使用maven，則jar會根據你的pom配置的依賴自動下載，並存放在你指定的maven本地庫中，預設是~/.m2/repository)，前一個是mybatis核心包，後一個是和spring整合的包。

使用mybatis，必須有個全局配置文件configuration.xml，來配置mybatis的緩存，延遲載入等等一系列屬性，該配置文件示例如下：

Java代碼

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//ibatis.apache.org//DTD Config 3.0//EN"
"http://ibatis.apache.org/dtd/ibatis-3-config.dtd">
<configuration>
<settings>
<setting name="cacheEnabled" value="true" />
<setting name="lazyLoadingEnabled" value="true" />
<setting name="aggressiveLazyLoading" value="false" />
<setting name="multipleResultSetsEnabled" value="true" />
<setting name="useColumnLabel" value="true" />
<setting name="useGeneratedKeys" value="true" />
<setting name="autoMappingBehavior" value="FULL" />
<setting name="defaultExecutorType" value="BATCH" />
<setting name="defaultStatementTimeout" value="25000" />
</settings>
<typeAliases>
<typeAlias alias="TestBean"
type="com.wotao.taotao.persist.test.dataobject.TestBean" />
</typeAliases>
<mappers>
<mapper resource="persist/test/orm/test.xml" />
</mappers>
</configuration>

該文件放在資源文件的任意classpath目錄下，假設這裡就直接放在資源根目錄，等會spring需要引用該文件。

查看ibatis-3-config.dtd發現除了settings和typeAliases還有其他眾多元素，比如properties,objectFactory,environments等等，這些元素基本上都包含著一些環境配置，數據源定義，資料庫事務等等，在單獨使用mybatis的時候非常重要，比如通過以構造參數的形式去實例化一個sqlsessionFactory，就像這樣：

Java代碼

SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader);
SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader, properties);
SqlSessionFactory factory = sqlSessionFactoryBuilder.build(reader, environment, properties);

而typeHandlers則用來自定義映射規則，如你可以自定義將Character映射為varchar，plugins元素則放了一些攔截器介面，你可以繼承他們並做一些切麵的事情，至於每個元素的細節和使用，你參考mybatis用戶指南即可。

現在我們用的是spring，因此除settings和typeAliases元素之外，其他元素將會失效，故不在此配置，spring會覆蓋這些元素的配置，比如在spring配置文件中指定c3p0數據源定義如下：

Java代碼

<bean id="testDataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource"
destroy-method="close">
<property name="driverClass" value="${db.driver.class}" />
<property name="jdbcUrl" value="${db.url}" />
<property name="user" value="${db.username}" />
<property name="password" value="${db.password}" />
<property name="initialPoolSize" value="5" />
<property name="minPoolSize" value="5" />
<property name="maxPoolSize" value="20" />
<property name="maxStatements" value="100" />
<property name="maxIdleTime" value="3600" />
<property name="acquireIncrement" value="2" />
<property name="acquireRetryAttempts" value="10" />
<property name="acquireRetryDelay" value="600" />
<property name="testConnectionOnCheckin" value="true" />
<property name="idleConnectionTestPeriod" value="1200" />
<property name="checkoutTimeout" value="10000" />
</bean>

配置中的${}都是占位符，在你指定資料庫驅動打war時會自動替換，替換的值在你的父pom中配置，至於c3p0連接池的各種屬性詳細信息和用法，你自行參考c3p0的官方文檔，這裡要說明的是checkoutTimeout元素，記得千萬要設大一點，單位是毫秒，假如設置太小，有可能會導致沒等資料庫響應就直接超時了，小弟在這裡吃了不少苦頭，還是基本功太差。

數據源配置妥當之後，我們就要開始非常重要的sessionFactory配置了，無論是hibernate還是mybatis，都需要一個sessionFactory來生成session，sessionFactory配置如下：

Java代碼

<bean id="testSqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="configLocation" value="classpath:configuration.xml" />
<property name="dataSource" ref="testDataSource" />
</bean>

testSqlSessionFactory有兩處註入，一個就是前面提到的mybatis全局設置文件configuration.xml，另一個就是上面定義的數據源了（註：hibernate的sessionFactory只需註入hibernate.cfg.xml，數據源定義已經包含在該文件中），好了，sessionFactory已經產生了，由於我們用的mybatis3的註解，因此spring的sqlSessionTemplate也不用配置了，sqlSessionTemplate也不用註入到我們的BaseDAO中了，相應的，我們需要配置一個映射器介面來對應sqlSessionTemplate，該映射器介面定義了你自己的介面方法，具體實現不用關心，代碼如下：

Java代碼

<bean id="testMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
<property name="sqlSessionFactory" ref="testSqlSessionFactory" />
<property name="mapperInterface" value="com.wotao.taotao.persist.test.mapper.TestMapper" />
</bean>

對應於sqlSessionTemplate，testMapper同樣需要testSqlSessionFactory註入，另外一個註入就是你自己定義的Mapper介面，該介面定義了操作資料庫的方法和SQL語句以及很多的註解，稍後我會講到。到此，mybatis和spring整合的文件配置就算OK了（註：如果你需要開通spring對普通類的代理功能，那麼你需要在spring配置文件中加入<aop:aspectj-autoproxy />），至於其他的如事務配置，AOP切麵註解等內容不在本文範圍內，不作累述。

至此，一個完整的myabtis整合spring的配置文件看起來應該如下所示：

Java代碼

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
xmlns:tx="http://www.springframework.org/schema/tx" xmlns:aop="http://www.springframework.org/schema/aop"
xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-2.5.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-2.5.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-2.5.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-2.5.xsd">
<bean id="testDataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource"
destroy-method="close">
<property name="driverClass" value="${db.driver.class}" />
<property name="jdbcUrl" value="${db.url}" />
<property name="user" value="${db.username}" />
<property name="password" value="${db.password}" />
<property name="initialPoolSize" value="5" />
<property name="minPoolSize" value="5" />
<property name="maxPoolSize" value="20" />
<property name="maxStatements" value="100" />
<property name="maxIdleTime" value="3600" />
<property name="acquireIncrement" value="2" />
<property name="acquireRetryAttempts" value="10" />
<property name="acquireRetryDelay" value="600" />
<property name="testConnectionOnCheckin" value="true" />
<property name="idleConnectionTestPeriod" value="1200" />
<property name="checkoutTimeout" value="10000" />
</bean>
<bean id="testSqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="configLocation" value="classpath:configuration.xml" />
<property name="dataSource" ref="testDataSource" />
</bean>
<bean id="testMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
<property name="sqlSessionFactory" ref="testSqlSessionFactory" />
<property name="mapperInterface" value="com.wotao.taotao.persist.test.mapper.TestMapper" />
</bean>
</beans>

到此為止，我們只講了mybatis和spring的整合，還沒有真正觸及mybatis的核心：使用mybatis註解代替映射文件編程（不過官方文檔也說了，如果真正想發揮mybatis功能，還是需要用到映射文件，看來myabtis自己都對mybatis註解沒信心，呵呵），通過上述內容，我們知道配置搞定，但是testMapper還沒有被實現，而註解的使用，全部集中在這個testMapper上，是mybatis註解的核心所在，先來看一下這個testMapper介面是個什麼樣的：

Java代碼

/**
* The test Mapper interface.
*
* @author HuangMin <a href="mailto:[email protected]>send email</a>
*
* @since 1.6
* @version 1.0
*
* #~TestMapper.java 2011-9-23 : afternoon 10:51:40
*/
@CacheNamespace(size = 512)
public interface TestMapper {
/**
* get test bean by UID.
*
* @param id
* @return
*/
@SelectProvider(type = TestSqlProvider.class, method = "getSql")
@Options(useCache = true, flushCache = false, timeout = 10000)
@Results(value = {
@Result(id = true, property = "id", column = "test_id", javaType = String.class, jdbcType = JdbcType.VARCHAR),
@Result(property = "testText", column = "test_text", javaType = String.class, jdbcType = JdbcType.VARCHAR) })
public TestBean get(@Param("id") String id);
/**
* get all tests.
*
* @return
*/
@SelectProvider(type = TestSqlProvider.class, method = "getAllSql")
@Options(useCache = true, flushCache = false, timeout = 10000)
@Results(value = {
@Result(id = true, property = "id", column = "test_id", javaType = String.class, jdbcType = JdbcType.VARCHAR),
@Result(property = "testText", column = "test_text", javaType = String.class, jdbcType = JdbcType.VARCHAR) })
public List<TestBean> getAll();
/**
* get tests by test text.
*
* @param testText
* @return
*/
@SelectProvider(type = TestSqlProvider.class, method = "getByTestTextSql")
@Options(useCache = true, flushCache = false, timeout = 10000)
@ResultMap(value = "getByTestText")
public List<TestBean> getByTestText(@Param("testText") String testText);
/**
* insert a test bean into database.
*
* @param testBean
*/
@InsertProvider(type = TestSqlProvider.class, method = "insertSql")
@Options(flushCache = true, timeout = 20000)
public void insert(@Param("testBean") TestBean testBean);
/**
* update a test bean with database.
*
* @param testBean
*/
@UpdateProvider(type = TestSqlProvider.class, method = "updateSql")
@Options(flushCache = true, timeout = 20000)
public void update(@Param("testBean") TestBean testBean);
/**
* delete a test by UID.
*
* @param id
*/
@DeleteProvider(type = TestSqlProvider.class, method = "deleteSql")
@Options(flushCache = true, timeout = 20000)
public void delete(@Param("id") String id);
}

下麵逐個對裡面的註解進行分析：
@CacheNamespace(size = 512) ：定義在該命名空間內允許使用內置緩存，最大值為512個對象引用，讀寫預設是開啟的，緩存內省刷新時間為預設3600000毫秒，寫策略是拷貝整個對象鏡像到全新堆（如同CopyOnWriteList）因此線程安全。

@SelectProvider(type = TestSqlProvider.class, method = "getSql") ：提供查詢的SQL語句，如果你不用這個註解，你也可以直接使用@Select("select * from ....")註解，把查詢SQL抽取到一個類裡面，方便管理，同時複雜的SQL也容易操作，type = TestSqlProvider.class就是存放SQL語句的類，而method = "getSql"表示get介面方法需要到TestSqlProvider類的getSql方法中獲取SQL語句。

@Options(useCache = true, flushCache = false, timeout = 10000) ：一些查詢的選項開關，比如useCache = true表示本次查詢結果被緩存以提高下次查詢速度，flushCache = false表示下次查詢時不刷新緩存，timeout = 10000表示查詢結果緩存10000秒。

@Results(value = {
@Result(id = true, property = "id", column = "test_id", javaType = String.class, jdbcType = JdbcType.VARCHAR),
@Result(property = "testText", column = "test_text", javaType = String.class, jdbcType = JdbcType.VARCHAR) }) ：表示sql查詢返回的結果集，@Results是以@Result為元素的數組，@Result表示單條屬性-欄位的映射關係，如：@Result(id = true, property = "id", column = "test_id", javaType = String.class, jdbcType = JdbcType.VARCHAR)可以簡寫為：@Result(id = true, property = "id", column = "test_id")，id = true表示這個test_id欄位是個PK，查詢時mybatis會給予必要的優化，應該說數組中所有的@Result組成了單個記錄的映射關係，而@Results則單個記錄的集合。另外還有一個非常重要的註解@ResultMap也和@Results差不多，到時會講到。

@Param("id") ：全局限定別名，定義查詢參數在sql語句中的位置不再是順序下標0,1,2,3....的形式，而是對應名稱，該名稱就在這裡定義。

@ResultMap(value = "getByTestText") ：重要的註解，可以解決複雜的映射關係，包括resultMap嵌套，鑒別器discriminator等等。註意一旦你啟用該註解，你將不得不在你的映射文件中配置你的resultMap，而value = "getByTestText"即為映射文件中的resultMap ID(註意此處的value = "getByTestText"，必須是在映射文件中指定命名空間路徑)。@ResultMap在某些簡單場合可以用@Results代替，但是複雜查詢，比如聯合、嵌套查詢@ResultMap就會顯得解耦方便更容易管理。
一個映射文件如下所示：

Java代碼

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"
"http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">
<mapper namespace="com.wotao.taotao.persist.test.mapper.TestMapper">
<resultMap id="getByTestText" type="TestBean">
<id property="id" column="test_id" javaType="string" jdbcType="VARCHAR" />
<result property="testText" column="test_text" javaType="string" jdbcType="VARCHAR" />
</resultMap>
</mapper>

註意文件中的namespace路徑必須是使用@resultMap的類路徑，此處是TestMapper，文件中 id="getByTestText"必須和@resultMap中的value = "getByTestText"保持一致。

@InsertProvider(type = TestSqlProvider.class, method = "insertSql") ：用法和含義@SelectProvider一樣，只不過是用來插入資料庫而用的。

@Options(flushCache = true, timeout = 20000) ：對於需要更新資料庫的操作，需要重新刷新緩存flushCache = true使緩存同步。

@UpdateProvider(type = TestSqlProvider.class, method = "updateSql") ：用法和含義@SelectProvider一樣，只不過是用來更新資料庫而用的。

@Param("testBean") ：是一個自定義的對象，指定了sql語句中的表現形式，如果要在sql中引用對象裡面的屬性，只要使用testBean.id，testBean.textText即可，mybatis會通過反射找到這些屬性值。

@DeleteProvider(type = TestSqlProvider.class, method = "deleteSql") ：用法和含義@SelectProvider一樣，只不過是用來刪除數據而用的。

現在mybatis註解基本已經講完了，接下來我們就要開始寫SQL語句了，因為我們不再使用映射文件編寫SQL，那麼就不得不在java類裡面寫，就像上面提到的，我們不得不在TestSqlProvider這個類裡面寫SQL，雖然已經把所有sql語句集中到了一個類裡面去管理，但聽起來似乎仍然有點噁心，幸好mybatis提供SelectBuilder和SqlBuilder這2個小工具來幫助我們生成SQL語句，SelectBuilder專門用來生成select語句，而SqlBuilder則是一般性的工具，可以生成任何SQL語句，我這裡選擇了SqlBuilder來生成，TestSqlProvider代碼如下：

Java代碼

/*
* #~ test-afternoon10:51:40
*/
package com.wotao.taotao.persist.test.sqlprovider;
import static org.apache.ibatis.jdbc.SqlBuilder.BEGIN;
import static org.apache.ibatis.jdbc.SqlBuilder.FROM;
import static org.apache.ibatis.jdbc.SqlBuilder.SELECT;
import static org.apache.ibatis.jdbc.SqlBuilder.SQL;
import static org.apache.ibatis.jdbc.SqlBuilder.WHERE;
import static org.apache.ibatis.jdbc.SqlBuilder.DELETE_FROM;
import static org.apache.ibatis.jdbc.SqlBuilder.INSERT_INTO;
import static org.apache.ibatis.jdbc.SqlBuilder.SET;
import static org.apache.ibatis.jdbc.SqlBuilder.UPDATE;
import static org.apache.ibatis.jdbc.SqlBuilder.VALUES;
import java.util.Map;
/**
* The test sql Provider,define the sql script for mapping.
*
* @author HuangMin <a href="mailto:[email protected]>send email</a>
*
* @since 1.6
* @version 1.0
*
* #~TestSqlProvider.java 2011-9-23 : afternoon 10:51:40
*/
public class TestSqlProvider {
/** table name, here is test */
private static final String TABLE_NAME = "test";
/**
* get test by id sql script.
*
* @param parameters
* @return
*/
public String getSql(Map<String, Object> parameters) {
String uid = (String) parameters.get("id");
BEGIN();
SELECT("test_id, test_text");
FROM(TABLE_NAME);
if (uid != null) {
WHERE("test_id = #{id,javaType=string,jdbcType=VARCHAR}");
}
return SQL();
}
/**
* get all tests sql script.
*
* @return
*/
public String getAllSql() {
BEGIN();
SELECT("test_id, test_text");
FROM(TABLE_NAME);
return SQL();
}
/**
* get test by test text sql script.
*
* @param parameters
* @return
*/
public String getByTestTextSql(Map<String, Object> parameters) {
String tText = (String) parameters.get("testText");
BEGIN();
SELECT("test_id, test_text");
FROM(TABLE_NAME);
if (tText != null) {
WHERE("test_text like #{testText,javaType=string,jdbcType=VARCHAR}");
}
return SQL();
}
/**
* insert a test sql script.
*
* @return
*/
public String insertSql() {
BEGIN();
INSERT_INTO(TABLE_NAME);
VALUES("test_id", "#{testBean.id,javaType=string,jdbcType=VARCHAR}");
VALUES("test_text", "#{testBean.testText,javaType=string,jdbcType=VARCHAR}");
return SQL();
}
/**
* update a test sql script.
*
* @return
*/
public String updateSql() {
BEGIN();
UPDATE(TABLE_NAME);
SET("test_text = #{testBean.testText,javaType=string,jdbcType=VARCHAR}");
WHERE("test_id = #{testBean.id,javaType=string,jdbcType=VARCHAR}");
return SQL();
}
/**
* delete a test sql script.
*
* @return
*/
public String deleteSql() {
BEGIN();
DELETE_FROM(TABLE_NAME);
WHERE("test_id = #{id,javaType=string,jdbcType=VARCHAR}");
return SQL();
}
}

BEGIN();表示刷新本地線程，某些變數為了線程安全，會先在本地存放變數，此處需要刷新。
SELECT，FROM，WHERE等等都是sqlbuilder定義的公用靜態方法，用來組成你的sql字元串。如果你在testMapper中調用該方法的某個介面方法已經定義了參數@Param()，那麼該方法的參數Map<String, Object> parameters即組裝了@Param()定義的參數，比如testMapper介面方法中定義參數為@Param("testId"),@Param("testText")，那麼parameters的形態就是：[key="testId",value=object1],[key="testText",value=object2]，如果介面方法沒有定義@Param()，那麼parameters的key就是參數的順序小標：[key=0,value=object1],[key=1,value=object2]，SQL()將返回最終append結束的字元串，sql語句中的形如
#{id,javaType=string,jdbcType=VARCHAR}完全可簡寫為#{id}，我只是為了規整如此寫而已。另外，對於複雜查詢還有很多標簽可用，比如：JOIN，INNER_JOIN，GROUP_BY，ORDER_BY等等，具體使用詳情，你可以查看源碼。

最後記得把你的Mapper介面註入到你的DAO類中，在DAO中引用Mapper介面方法即可。我在BaseDAO中的註解註入如下：

Java代碼

......
@Repository("testBaseDAO")
public class TestBaseDAO {
......

Java代碼

......
/**
* @param testMapper
* the testMapper to set
*/
@Autowired
public void setTestMapper(@Qualifier("testMapper") TestMapper testMapper) {
this.testMapper = testMapper;
}
......