MyBatis-Spring包用來將MyBatis無縫整合到Spring中。使用這個類庫中的類, Spring將會載入必要的MyBatis工廠類和Session類。 這個類庫也提供一個簡單的方式來注入 MyBatis 資料對映器和 SqlSession 到業務層的 bean 中。github: http://github.com/mybatis/spring

首先引入jar包

<dependency>
  <groupId>org.mybatis</groupId>
  <artifactId>mybatis-spring</artifactId>
  <version>x.x.x</version>
</dependency>

在 Spring 應用上下文中定義一個 SqlSessionFactory

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <property name="dataSource" ref="dataSource" />
  <property name="mapperLocations" value="classpath*:sample/config/mappers/**/*.xml" />
  <property name=“configLocation” value=“classpath:mybatis-config.xml” />
</bean>

在MyBatis中session工廠可以使用SqlSessionFactoryBuilder來建立。而在MyBatis-Spring中,使用SqlSessionFactoryBean來替代,SqlSessionFactoryBean 是用於建立 SqlSessionFactory的.

SqlSessionFactoryBean 實現了 Spring 的 FactoryBean 介面(參考Spring文件的3.8章)這就說明了由 Spring 最終建立的 bean 不是 SqlSessionFactoryBean 本身, 而是工廠類的getObject()返回的方法的結果。這種情況下,Spring 將會在應用啟動時建立 SqlSessionFactory物件,然後將它以 SqlSessionFactory 為名來儲存。相當於Java程式碼:

SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
SqlSessionFactory sessionFactory = factoryBean.getObject();

在一般的 MyBatis-Spring 用法中, 你不需要直接使用 SqlSessionFactoryBean 或和其對應的 SqlSessionFactory。相反session 工廠將會被注入到 MapperFactoryBean 或其它擴充套件了 SqlSessionDaoSupport的DAO(Data Access Object資料訪問物件)中。

SqlSessionFactory 有一個必須的屬性DataSource:

    <!-- 指定資料來源配置檔案 -->
    <context:property-placeholder location="classpath:jdbc.properties" />
    
    <!-- 資料來源 -->
    <bean id="dataSource_dev" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
        <property name="driverClassName" value="${driver}" />
        <property name="url" value="${url}" />
        <property name="username" value="${username}" />
        <property name="password" value="${password}" />
    </bean>

configLocation屬性用來指定MyBatis的XML配置檔案路徑。改變基本的MyBatis配置, 這個配置檔案不需要是一個完整的MyBatis配置。環境,資料來源和MyBatis的事務管理器都可被忽略,SqlSessionFactoryBean會自動建立。

mapperLocations屬性來指定Mapper所在位置, 它的值可以載入一個目錄中所有檔案, 或者從基路徑下遞迴搜尋所有路徑。

 

事務管理

MyBatis-Spring可以通過利用Spring中的DataSourceTransactionManager使MyBatis運用到Spring的事務管理中。

首先需要在Spring的配置檔案中建立一個DataSourceTransactionManager物件來開啟Spring的事務處理:

<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
  <property name="dataSource" ref="dataSource" />
</bean>

DataSource必須和建立SqlSessionFactoryBean的是同一個資料來源,否則事務管理器無法工作。

配置好後就可以在Spring中以通常的做法來配置事務。@Transactional註解和AOP樣式的配置都是支援的。

在事務處理期間,一個單獨的SqlSession物件將會被建立和使用。當事務完成時,這個session會以合適的方式提交或回滾。

這樣在DAO層中就不需要額外的程式碼了,MyBatis-Spring將會透明的管理事務。

 

容器管理的事務

如果你正使用一個 JEE 容器而且想讓 Spring 參與到容器管理事務(Container managed transactions)中,那麼 Spring 應該使用 JtaTransactionManager 或它的容器指定的子類來配置。

首先使用Spring的事務名稱空間:

<tx:jta-transaction-manager />

在這種配置中,MyBatis 將會和其它由 CMT 配置的 Spring 事務資源一樣。Spring 會自動使用任意存在的容器事務,在上面附加一個 SqlSession。如果沒有開始事務,或者需要基於事務配置,Spring 會開啟一個新的容器管理事務。

注意, 如果要使用CMT , 而不使用Spring的事務管理 , 就必須配置SqlSessionFactoryBean使用基本的MyBatis的ManagedTransactionFactory，而不是其它Spring的事務管理器:

<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <property name="dataSource" ref="dataSource" />
  <property name="transactionFactory">
    <bean class="org.apache.ibatis.transaction.managed.ManagedTransactionFactory" />
  </property>  
</bean>

 

使用 SqlSession

MyBatis中, 使用SqlSessionFactory來建立SqlSession。獲得一個session之後就可以使用它來執行對映語句,提交或回滾連線,最後不再需要它的時候, 可以關閉session。

使用MyBatis-Spring之後, 不再需要直接使用SqlSessionFactory了,因為你的bean可以通過一個執行緒安全的SqlSession來注入；基於Spring的事務管理來自動提交,回滾,關閉session。

 

SqlSessionTemplate

SqlSessionTemplate 是 MyBatis-Spring 的核心。 負責管理 MyBatis 的 SqlSession, 呼叫 MyBatis 的 SQL 方法, 翻譯異常。 SqlSessionTemplate 是執行緒安全的, 可以被多個 DAO 所共享使用。

當呼叫 SQL 方法時, 包含從對映器 getMapper()方法返回的方法, SqlSessionTemplate 將會保證使用的 SqlSession 是和當前 Spring 的事務相關的。此外,它管理 session 的生命週期,包含必要的關閉,提交或回滾操作。

SqlSessionTemplate 實現了 SqlSession 介面,這就是說,在程式碼中無需對 MyBatis 的 SqlSession 進行替換。 SqlSessionTemplate 通常是被用來替代預設的 MyBatis 實現的 DefaultSqlSession , 因為模板可以參與到 Spring 的事務中並且被多個注入的對映器類所使 用時也是執行緒安全的。相同應用程式中兩個類之間的轉換可能會引起資料一致性的問題。

SqlSessionTemplate 物件可以使用 SqlSessionFactory 作為構造方法的引數來建立。

<bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
  <constructor-arg index="0" ref="sqlSessionFactory" />
</bean>

 

這個 bean 現在可以直接注入到 DAO bean 中。你需要在 bean 中新增一個 SqlSession 屬性:

public class UserDaoImpl implements UserDao {
  private SqlSession sqlSession;
  public void setSqlSession(SqlSession sqlSession) {
    this.sqlSession = sqlSession;
  }
  public User getUser(String userId) {
    return (User) sqlSession.selectOne("org.mybatis.spring.sample.mapper.UserMapper.getUser", userId);
  }
}

如下注入 SqlSessionTemplate:

<bean id="userDao" class="org.mybatis.spring.sample.dao.UserDaoImpl">
  <property name="sqlSession" ref="sqlSession" />
</bean>

SqlSessionTemplate 有一個使用 ExecutorType 作為引數的構造方法。這允許你用來 建立物件,比如,一個批量 SqlSession,但是使用了下列 Spring 配置的 XML 檔案:

<bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">
  <constructor-arg index="0" ref="sqlSessionFactory" />
  <constructor-arg index="1" value="BATCH" />
</bean>

現在你所有的語句可以批量操作了,下面的語句就可以在 DAO 中使用了。

public void insertUsers(User[] users) {
   for (User user : users) {
     sqlSession.insert("org.mybatis.spring.sample.mapper.UserMapper.insertUser", user);
   }
 }

 

注意,如果所需的執行方法和預設的 SqlSessionFactory 設定不同,這種配置風格才 能使用。

對這種形式需要說明的是當這個方法被呼叫時,不能有一個存在使用不同 ExecutorType 執行的事務。也要保證在不同的事務中,使用不同執行器來呼叫 SqlSessionTemplate 時, (比如 PROPAGATION_REQUIRES_NEW)或完全在一個事務外面。

 

SqlSessionDaoSupport

SqlSessionDaoSupport 是一個抽象的支援類, 用來為你提供 SqlSession。調 用 getSqlSession()方法你會得到一個 SqlSessionTemplate,之後可以用於執行 SQL 方法:

public class UserDaoImpl extends SqlSessionDaoSupport implements UserDao {
  public User getUser(String userId) {
    return (User) getSqlSession().selectOne("org.mybatis.spring.sample.mapper.UserMapper.getUser", userId);
  }
}

 

通常 MapperFactoryBean 是這個類的首選,因為它不需要額外的程式碼。但是,如果你 需要在 DAO 中做其它非 MyBatis 的工作或需要具體的類,那麼這個類就很有用了。

SqlSessionDaoSupport 需要一個 sqlSessionFactory 或 sqlSessionTemplate 屬性來 設 置 。 這 些 被 明 確 地 設 置 或 由 Spring 來 自 動 裝 配 。 如 果 兩 者 都 被 設 置 了 , 那 麼 SqlSessionFactory 是被忽略的。

假設類 UserMapperImpl 是 SqlSessionDaoSupport 的子類,它可以在 Spring 中進行如 下的配置:

<bean id="userMapper" class="org.mybatis.spring.sample.mapper.UserDaoImpl">
  <property name="sqlSessionFactory" ref="sqlSessionFactory" />
</bean>

 

 

注入對映器

為了代替手工使用 SqlSessionDaoSupport 或 SqlSessionTemplate 編寫資料訪問物件 (DAO)的程式碼,MyBatis-Spring 提供了一個動態代理的實現:MapperFactoryBean。這個類 可以讓你直接注入資料對映器介面到你的 service 層 bean 中。當使用對映器時,你僅僅如調 用你的 DAO 一樣呼叫它們就可以了,但是你不需要編寫任何 DAO 實現的程式碼,因為 MyBatis-Spring 將會為你建立代理。

使用注入的對映器程式碼,在 MyBatis,Spring 或 MyBatis-Spring 上面不會有直接的依賴。 MapperFactoryBean 建立的代理控制開放和關閉 session,翻譯任意的異常到 Spring 的 DataAccessException 異常中。此外,如果需要或參與到一個已經存在活動事務中,代理將 會開啟一個新的 Spring 事務。

MapperFactoryBean

資料對映器介面可以按照如下做法加入到 Spring 中:

<bean id="userMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
  <property name="mapperInterface" value="org.mybatis.spring.sample.mapper.UserMapper" />
  <property name="sqlSessionFactory" ref="sqlSessionFactory" />
</bean>

 

MapperFactoryBean 建立的代理類實現了 UserMapper 介面,並且注入到應用程式中。 因為代理建立在執行時環境中(Runtime,譯者注) ,那麼指定的對映器必須是一個介面,而 不是一個具體的實現類。

如果 UserMapper 有一個對應的 MyBatis 的 XML 對映器檔案, 如果 XML 檔案在類路徑的 位置和對映器類相同時, 它會被 MapperFactoryBean 自動解析。 沒有必要在 MyBatis 配置文 件 中 去 指 定 映 射 器 , 除 非 映 射 器 的 XML 文 件 在 不 同 的 類 路 徑 下 。 可 以 參 考 SqlSessionFactoryBean 的 configLocation 屬性(第三章)來獲取更多資訊。

注意,當 MapperFactoryBean 需要 SqlSessionFactory 或 SqlSessionTemplate 時。 這些可以通過各自的 SqlSessionFactory 或 SqlSessionTemplate 屬性來設定, 或者可以由 Spring 來自動裝配。如果兩個屬性都設定了,那麼 SqlSessionFactory 就會被忽略,因為 SqlSessionTemplate 是需要有一個 session 工廠的設定; 那個工廠會由 MapperFactoryBean. 來使用。

你可以直接在 business/service 物件中以和注入任意 Spring bean 的相同方式直接注入映 射器:

<bean id="fooService" class="org.mybatis.spring.sample.mapper.FooServiceImpl">
  <property name="userMapper" ref="userMapper" />
</bean>

 

這個 bean 可以直接在應用程式邏輯中使用:

public class FooServiceImpl implements FooService {

  private UserMapper userMapper;

  public void setUserMapper(UserMapper userMapper) {
    this.userMapper = userMapper;
  }

  public User doSomeBusinessStuff(String userId) {
    return this.userMapper.getUser(userId);
  }
}

 

注意在這段程式碼中沒有 SqlSession 或 MyBatis 的引用。也沒有任何需要建立,開啟或 關閉 session 的程式碼,MyBatis-Spring 會來關心它的。

 

MapperScannerConfigurer

沒有必要在 Spring 的 XML 配置檔案中註冊所有的對映器。相反,你可以使用一個 MapperScannerConfigurer , 它 將 會 查 找 類 路 徑 下 的 映 射 器 並 自 動 將 它 們 創 建 成 MapperFactoryBean。

要建立 MapperScannerConfigurer,可以在 Spring 的配置中新增如下程式碼:

<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
  <property name="basePackage" value="org.mybatis.spring.sample.mapper" />
</bean>

basePackage 屬性為對映器介面檔案設定基本的包路徑。可以使用分號或逗號作為分隔符設定多個包路徑。每個對映器將會在指定的包路徑中遞迴地被搜尋到。

MapperScannerConfigurer屬性不支援使用了PropertyPlaceholderConfigurer 的屬 性替換,因為會在 Spring 其中之前來它載入。但是,你可以使用 PropertiesFactoryBean 和 SpEL 表示式來作為替代。

如果只有一個DataSource,就不用指定SqlSessionFactory或SqlSessionTemplate , 因為MapperScannerConfigurer將會建立 MapperFactoryBean,之後自動裝配。

如果有多個DataSource ,那麼自動裝配可能會失效 。可以使用 sqlSessionFactoryBeanName 或 sqlSessionTemplateBeanName 屬性來設定正確的bean名稱來使用:

<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />

 

MapperScannerConfigurer支援過濾由指定的建立介面或註解建立對映器。 annotationClass屬性指定了要尋找的註解名稱。 markerInterface 屬性指定了要尋找的父介面。如果兩者都被指定了,加入到介面中的對映器會匹配兩種標準。預設情況下,這兩個 屬性都是 null,所以在基包中給定的所有介面可以作為對映器載入。

被發現的對映器將會使用 Spring 對自動偵測元件(參考 Spring 手冊的 3.14.4)預設的命名策略來命名。也就是說,如果沒有發現註解,它就會使用對映器的非大寫的非完全限定類 名。但是如果發現了@Component 或 JSR-330 的@Named 註解,它會獲取名稱。注意你可以 配 置 到 org.springframework.stereotype.Component , javax.inject.Named(如果你使用 JSE 6 的話)或你自己的註解(肯定是自我註解)中,這 樣註解將會用作生成器和名稱提供器。

 

 

使用 MyBatis API

使用了MyBatis-Spring, 還可以繼續使用MyBatis的API，比如Spring中的SqlSessionFactoryBean來建立一個SqlSessionFactory：

public class UserMapperSqlSessionImpl implements UserMapper {
  // SqlSessionFactory would normally be set by SqlSessionDaoSupport
  private SqlSessionFactory sqlSessionFactory;

  public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory) {
    this.sqlSessionFactory = sqlSessionFactory;
  }

  public User getUser(String userId) {
    // note standard MyBatis API usage - opening and closing the session manually
    SqlSession session = sqlSessionFactory.openSession();

    try {
      return (User) session.selectOne("org.mybatis.spring.sample.mapper.UserMapper.getUser", userId);
    } finally {
      session.close();
    }
  }
}

但是需要注意的是:

1. 這樣不會參與到 Spring 的事務之中。

2. 如果 SqlSession 使用 DataSource,它也會被 Spring 事務管理器使用,而且當前有事務在進行時,這段程式碼會丟擲異常。

3. MyBatis的DefaultSqlSession是執行緒不安全的。如果在 bean中注入了它,就會發生錯誤。

4. 使用 DefaultSqlSession建立的對映器也不是執行緒安全的。如果你將它們注入到 bean中就會發生錯誤的。

5. 必須保證在 finally 塊中來關閉 SqlSession。

所以還是不要這樣寫。