根據(jù)官方的說法，在ibatis3，也就是Mybatis3問世之前，Spring3的開發(fā)工作就已經(jīng)完成了，所以Spring3中還是沒有對Mybatis3的支持。因此由Mybatis社區(qū)自己開發(fā)了一個Mybatis-Spring用來滿足Mybatis用戶整合Spring的需求。下面就將通過Mybatis-Spring來整合Mybatis跟Spring的用法做一個簡單的介紹。
MapperFactoryBean
首先，我們需要從Mybatis官網(wǎng)上下載Mybatis-Spring的jar包添加到我們項目的類路徑下，當(dāng)然也需要添加Mybatis的相關(guān)jar包和Spring的相關(guān)jar包。我們知道在Mybatis的所有操作都是基于一個SqlSession的，而SqlSession是由SqlSessionFactory來產(chǎn)生的，SqlSessionFactory又是由SqlSessionFactoryBuilder來生成的。但是Mybatis-Spring是基于SqlSessionFactoryBean的。在使用Mybatis-Spring的時候，我們也需要SqlSession，而且這個SqlSession是內(nèi)嵌在程序中的，一般不需要我們直接訪問。SqlSession也是由SqlSessionFactory來產(chǎn)生的，但是Mybatis-Spring給我們封裝了一個SqlSessionFactoryBean，在這個bean里面還是通過SqlSessionFactoryBuilder來建立對應(yīng)的SqlSessionFactory，進(jìn)而獲取到對應(yīng)的SqlSession。通過SqlSessionFactoryBean我們可以通過對其指定一些屬性來提供Mybatis的一些配置信息。所以接下來我們需要在Spring的applicationContext配置文件中定義一個SqlSessionFactoryBean。
Xml代碼
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource" />
<property name="mapperLocations"
value="classpath:com/tiantian/ckeditor/mybatis/mappers/*Mapper.xml" />
<property name="typeAliasesPackage" value="com.tiantian.ckeditor.model" />
bean>
在定義SqlSessionFactoryBean的時候，dataSource屬性是必須指定的，它表示用于連接數(shù)據(jù)庫的數(shù)據(jù)源。當(dāng)然，我們也可以指定一些其他的屬性，下面簡單列舉幾個：
mapperLocations：它表示我們的Mapper文件存放的位置，當(dāng)我們的Mapper文件跟對應(yīng)的Mapper接口處于同一位置的時候可以不用指定該屬性的值。
configLocation：用于指定Mybatis的配置文件位置。如果指定了該屬性，那么會以該配置文件的內(nèi)容作為配置信息構(gòu)建對應(yīng)的SqlSessionFactoryBuilder，但是后續(xù)屬性指定的內(nèi)容會覆蓋該配置文件里面指定的對應(yīng)內(nèi)容。
typeAliasesPackage：它一般對應(yīng)我們的實體類所在的包，這個時候會自動取對應(yīng)包中不包括包名的簡單類名作為包括包名的別名。多個package之間可以用逗號或者分號等來進(jìn)行分隔。
typeAliases：數(shù)組類型，用來指定別名的。指定了這個屬性后，Mybatis會把這個類型的短名稱作為這個類型的別名，前提是該類上沒有標(biāo)注@Alias注解，否則將使用該注解對應(yīng)的值作為此種類型的別名。
Xml代碼
<property name="typeAliases">
<array>
<value>com.tiantian.mybatis.model.Blogvalue>
<value>com.tiantian.mybatis.model.Commentvalue>
array>
property>
plugins：數(shù)組類型，用來指定Mybatis的Interceptor。
typeHandlersPackage：用來指定TypeHandler所在的包，如果指定了該屬性，SqlSessionFactoryBean會自動把該包下面的類注冊為對應(yīng)的TypeHandler。多個package之間可以用逗號或者分號等來進(jìn)行分隔。
typeHandlers：數(shù)組類型，表示TypeHandler。
接下來就是在Spring的applicationContext文件中定義我們想要的Mapper對象對應(yīng)的MapperFactoryBean了。通過MapperFactoryBean可以獲取到我們想要的Mapper對象。MapperFactoryBean實現(xiàn)了Spring的FactoryBean接口，所以MapperFactoryBean是通過FactoryBean接口中定義的getObject方法來獲取對應(yīng)的Mapper對象的。在定義一個MapperFactoryBean的時候有兩個屬性需要我們注入，一個是Mybatis-Spring用來生成實現(xiàn)了SqlSession接口的SqlSessionTemplate對象的sqlSessionFactory；另一個就是我們所要返回的對應(yīng)的Mapper接口了。
定義好相應(yīng)Mapper接口對應(yīng)的MapperFactoryBean之后，我們就可以把我們對應(yīng)的Mapper接口注入到由Spring管理的bean對象中了，比如Service bean對象。這樣當(dāng)我們需要使用到相應(yīng)的Mapper接口時，MapperFactoryBean會從它的getObject方法中獲取對應(yīng)的Mapper接口，而getObject內(nèi)部還是通過我們注入的屬性調(diào)用SqlSession接口的getMapper(Mapper接口)方法來返回對應(yīng)的Mapper接口的。這樣就通過把SqlSessionFactory和相應(yīng)的Mapper接口交給Spring管理實現(xiàn)了Mybatis跟Spring的整合。
Spring的applicationContext.xml配置文件：
Xml代碼
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:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.0.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">
<context:component-scan base-package="com.tiantian.mybatis"/>
<context:property-placeholder location="classpath:config/jdbc.properties"/>
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
destroy-method="close">
<property name="driverClassName" value="${jdbc.driver}" />
<property name="url" value="${jdbc.url}" />
<property name="username" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
bean>
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource" />
<property name="mapperLocations"value="classpath:com/tiantian/mybatis/mapper/*.xml"/>
<property name="typeAliasesPackage" value="com.tiantian.mybatis.model" />
bean>
<bean id="blogMapper" class="org.mybatis.spring.mapper.MapperFactoryBean">
<property name="mapperInterface"
value="com.tiantian.mybatis.mapper.BlogMapper" />
<property name="sqlSessionFactory" ref="sqlSessionFactory" />
bean>
beans>
BlogMapper.xml文件：
Xml代碼
xml version="1.0" encoding="UTF-8" ?>
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.tiantian.mybatis.mapper.BlogMapper">
<insert id="insertBlog" parameterType="Blog" useGeneratedKeys="true"keyProperty="id">
insert into t_blog(title,content,owner) values(#{title},#{content},#{owner})
insert>
<select id="selectBlog" parameterType="int" resultMap="BlogResult">
select * from t_blog where id = #{id}
select>
<update id="updateBlog" parameterType="Blog">
update t_blog set title = #{title},content = #{content},owner = #{owner} whereid = #{id}
update>
<select id="selectAll" resultType="Blog">
select * from t_blog
select>
<delete id="deleteBlog" parameterType="int">
delete from t_blog where id = #{id}
delete>
mapper>
BlogMapper.java：
Java代碼
package com.tiantian.mybatis.mapper;
import java.util.List;
import com.tiantian.mybatis.model.Blog;
publicinterface BlogMapper {
public Blog selectBlog(int id);
publicvoid insertBlog(Blog blog);
publicvoid updateBlog(Blog blog);
publicvoid deleteBlog(int id);
public List selectAll();
}
BlogServiceImpl.java：
Java代碼
package com.tiantian.mybatis.service.impl;
import java.util.List;
import javax.annotation.Resource;
import org.springframework.stereotype.Service;
import com.tiantian.mybatis.mapper.BlogMapper;
import com.tiantian.mybatis.model.Blog;
import com.tiantian.mybatis.service.BlogService;
@Service
publicclass BlogServiceImpl implements BlogService {
private BlogMapper blogMapper;
publicvoid deleteBlog(int id) {
blogMapper.deleteBlog(id);
}
public Blog find(int id) {
returnblogMapper.selectBlog(id);
}
public List find() {
returnblogMapper.selectAll();
}
publicvoid insertBlog(Blog blog) {
blogMapper.insertBlog(blog);
}
publicvoid updateBlog(Blog blog) {
blogMapper.updateBlog(blog);
}
public BlogMapper getBlogMapper() {
returnblogMapper;
}
@Resource
publicvoid setBlogMapper(BlogMapper blogMapper) {
this.blogMapper = blogMapper;
}
}
MapperScannerConfigurer
利用上面的方法進(jìn)行整合的時候，我們有一個Mapper就需要定義一個對應(yīng)的MapperFactoryBean，當(dāng)我們的Mapper比較少的時候，這樣做也還可以，但是當(dāng)我們的Mapper相當(dāng)多時我們再這樣定義一個個Mapper對應(yīng)的MapperFactoryBean就顯得速度比較慢了。為此Mybatis-Spring為我們提供了一個叫做MapperScannerConfigurer的類，通過這個類Mybatis-Spring會自動為我們注冊Mapper對應(yīng)的MapperFactoryBean對象。
如果我們需要使用MapperScannerConfigurer來幫我們自動掃描和注冊Mapper接口的話我們需要在Spring的applicationContext配置文件中定義一個MapperScannerConfigurer對應(yīng)的bean。對于MapperScannerConfigurer而言有一個屬性是我們必須指定的，那就是basePackage。basePackage是用來指定Mapper接口文件所在的基包的，在這個基包或其所有子包下面的Mapper接口都將被搜索到。多個基包之間可以使用逗號或者分號進(jìn)行分隔。最簡單的MapperScannerConfigurer定義就是只指定一個basePackage屬性，如：
Xml代碼
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.tiantian.mybatis.mapper" />
bean>
這樣MapperScannerConfigurer就會掃描指定基包下面的所有接口，并把它們注冊為一個個MapperFactoryBean對象。當(dāng)使用MapperScannerConfigurer加basePackage屬性的時候，我們上面例子的applicationContext配置文件將變?yōu)檫@樣：
Xml代碼
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:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.0.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">
<context:component-scan base-package="com.tiantian.mybatis" />
<context:property-placeholder location="classpath:config/jdbc.properties" />
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
destroy-method="close">
<property name="driverClassName" value="${jdbc.driver}" />
<property name="url" value="${jdbc.url}" />
<property name="username" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
bean>
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource" />
<property name="mapperLocations"value="classpath:com/tiantian/mybatis/mapper/*.xml" />
<property name="typeAliasesPackage" value="com.tiantian.mybatis.model" />
bean>
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.tiantian.mybatis.mapper" />
bean>
beans>
有時候我們指定的基包下面的并不全是我們定義的Mapper接口，為此MapperScannerConfigurer還為我們提供了另外兩個可以縮小搜索和注冊范圍的屬性。一個是annotationClass，另一個是markerInterface。
annotationClass：當(dāng)指定了annotationClass的時候，MapperScannerConfigurer將只注冊使用了annotationClass注解標(biāo)記的接口。
markerInterface：markerInterface是用于指定一個接口的，當(dāng)指定了markerInterface之后，MapperScannerConfigurer將只注冊繼承自markerInterface的接口。
如果上述兩個屬性都指定了的話，那么MapperScannerConfigurer將取它們的并集，而不是交集。即使用了annotationClass進(jìn)行標(biāo)記或者繼承自markerInterface的接口都將被注冊為一個MapperFactoryBean。
現(xiàn)在假設(shè)我們的Mapper接口都繼承了一個SuperMapper接口，那么我們就可以這樣來定義我們的MapperScannerConfigurer。
Xml代碼
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.tiantian.mybatis.mapper" />
<property name="markerInterface" value="com.tiantian.mybatis.mapper.SuperMapper"/>
bean>
如果是都使用了注解MybatisMapper標(biāo)記的話，那么我們就可以這樣來定義我們的MapperScannerConfigurer。
Xml代碼
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.tiantian.mybatis.mapper" />
<property name="annotationClass"value="com.tiantian.mybatis.annotation.MybatisMapper"/>
bean>
除了用于縮小注冊Mapper接口范圍的屬性之外，我們還可以指定一些其他屬性，如：
sqlSessionFactory：這個屬性已經(jīng)廢棄。當(dāng)我們使用了多個數(shù)據(jù)源的時候我們就需要通過sqlSessionFactory來指定在注冊MapperFactoryBean的時候需要使用的SqlSessionFactory，因為在沒有指定sqlSessionFactory的時候，會以Autowired的方式自動注入一個。換言之當(dāng)我們只使用一個數(shù)據(jù)源的時候，即只定義了一個SqlSessionFactory的時候我們就可以不給MapperScannerConfigurer指定SqlSessionFactory。
sqlSessionFactoryBeanName：它的功能跟sqlSessionFactory是一樣的，只是它指定的是定義好的SqlSessionFactory對應(yīng)的bean名稱。
sqlSessionTemplate：這個屬性已經(jīng)廢棄。它的功能也是相當(dāng)于sqlSessionFactory的，因為就像前面說的那樣，MapperFactoryBean最終還是使用的SqlSession的getMapper方法取的對應(yīng)的Mapper對象。當(dāng)定義有多個SqlSessionTemplate的時候才需要指定它。對于一個MapperFactoryBean來說SqlSessionFactory和SqlSessionTemplate只需要其中一個就可以了，當(dāng)兩者都指定了的時候，SqlSessionFactory會被忽略。
sqlSessionTemplateBeanName：指定需要使用的sqlSessionTemplate對應(yīng)的bean名稱。
注意：由于使用sqlSessionFactory和sqlSessionTemplate屬性時會使一些內(nèi)容在PropertyPlaceholderConfigurer之前加載，導(dǎo)致在配置文件中使用到的外部屬性信息無法被及時替換而出錯，因此官方現(xiàn)在新的Mybatis-Spring中已經(jīng)把sqlSessionFactory和sqlSessionTemplate屬性廢棄了，推薦大家使用sqlSessionFactoryBeanName屬性和sqlSessionTemplateBeanName屬性。
Xml代碼
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:mvc="http://www.springframework.org/schema/mvc"
xmlns:mybatis="http://www.mybatis.org/schema/mybatis"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
http://www.springframework.org/schema/context
http://www.springframework.org/schema/context/spring-context-3.0.xsd
http://www.mybatis.org/schema/mybatis
http://www.mybatis.org/schema/mybatis/mybatis-spring.xsd
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd">
<context:component-scan base-package="com.tiantian.mybatis" />
<context:property-placeholder location="classpath:config/jdbc.properties" />
<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
destroy-method="close">
<property name="driverClassName" value="${jdbc.driver}" />
<property name="url" value="${jdbc.url}" />
<property name="username" value="${jdbc.username}" />
<property name="password" value="${jdbc.password}" />
bean>
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource" />
<property name="mapperLocations"value="classpath:com/tiantian/mybatis/mapper/*.xml" />
<property name="typeAliasesPackage" value="com.tiantian.mybatis.model" />
bean>
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.tiantian.mybatis.mapper" />
<property name="markerInterface"value="com.tiantian.mybatis.mapper.SuperMapper"/>
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
bean>
beans>
SqlSessionTemplate
除了上述整合之后直接使用Mapper接口之外，Mybatis-Spring還為我們提供了一種直接使用SqlSession的方式。Mybatis-Spring為我們提供了一個實現(xiàn)了SqlSession接口的SqlSessionTemplate類，它是線程安全的，可以被多個Dao同時使用。同時它還跟Spring的事務(wù)進(jìn)行了關(guān)聯(lián)，確保當(dāng)前被使用的SqlSession是一個已經(jīng)和Spring的事務(wù)進(jìn)行綁定了的。而且它還可以自己管理Session的提交和關(guān)閉。當(dāng)使用了Spring的事務(wù)管理機(jī)制后，SqlSession還可以跟著Spring的事務(wù)一起提交和回滾。
使用SqlSessionTemplate時我們可以在Spring的applicationContext配置文件中如下定義：