注入映射器
爲了代替手工使用 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 表達式來作爲替代。
注 意 , 沒 有 必 要 去 指 定 SqlSessionFactory 或 SqlSessionTemplate , 因 爲 MapperScannerConfigurer 將會創建 MapperFactoryBean,之後自動裝配。但是,如果你使 用了一個 以上的 DataSource ,那 麼自動 裝配可 能會失效 。這種 情況下 ,你可 以使用 sqlSessionFactoryBeanName 或 sqlSessionTemplateBeanName 屬性來設置正確的 bean 名 稱來使用。這就是它如何來配置的,注意 bean 的名稱是必須的,而不是 bean 的引用,因 此,value 屬性在這裏替代通常的 ref:
<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 的話)或你自己的註解(肯定是自我註解)中,這 樣註解將會用作生成器和名稱提供器。