Mybatis整合Spring-CFANZ编程社区

Mybatis整合Spring

根据官方的说法，在ibatis3，也就是Mybatis3问世之前，Spring3的开发工作就已经完成了，所以Spring3中还是没有对Mybatis3的支持。因此由Mybatis社区自己开发了一个Mybatis-Spring用来满足Mybatis用户整合Spring的需求。下面就将通过Mybatis-Spring来整合Mybatis跟Spring的用法做一个简单的介绍。

MapperFactoryBean

首先，我们需要从Mybatis官网上下载Mybatis-Spring的jar包添加到我们项目的类路径下，当然也需要添加Mybatis的相关jar包和Spring的相关jar包。我们知道在Mybatis的所有操作都是基于一个SqlSession的，而SqlSession是由SqlSessionFactory来产生的，SqlSessionFactory又是由SqlSessionFactoryBuilder来生成的。但是Mybatis-Spring是基于SqlSessionFactoryBean的。在使用Mybatis-Spring的时候，我们也需要SqlSession，而且这个SqlSession是内嵌在程序中的，一般不需要我们直接访问。SqlSession也是由SqlSessionFactory来产生的，但是Mybatis-Spring给我们封装了一个SqlSessionFactoryBean，在这个bean里面还是通过SqlSessionFactoryBuilder来建立对应的SqlSessionFactory，进而获取到对应的SqlSession。通过SqlSessionFactoryBean我们可以通过对其指定一些属性来提供Mybatis的一些配置信息。所以接下来我们需要在Spring的applicationContext配置文件中定义一个SqlSessionFactoryBean。

Xml代码

1. <bean  id="sqlSessionFactory"  class="org.mybatis.spring.SqlSessionFactoryBean"> 
2. <property  name="dataSource"  ref="dataSource" /> 
3. <property  name="mapperLocations"
4. value="classpath:com/tiantian/ckeditor/mybatis/mappers/*Mapper.xml" /> 
5. <property  name="typeAliasesPackage"  value="com.tiantian.ckeditor.model" /> 
6. </bean>

在定义SqlSessionFactoryBean的时候，dataSource属性是必须指定的，它表示用于连接数据库的数据源。当然，我们也可以指定一些其他的属性，下面简单列举几个：

mapperLocations：它表示我们的Mapper文件存放的位置，当我们的Mapper文件跟对应的Mapper接口处于同一位置的时候可以不用指定该属性的值。
configLocation：用于指定Mybatis的配置文件位置。如果指定了该属性，那么会以该配置文件的内容作为配置信息构建对应的SqlSessionFactoryBuilder，但是后续属性指定的内容会覆盖该配置文件里面指定的对应内容。
typeAliasesPackage：它一般对应我们的实体类所在的包，这个时候会自动取对应包中不包括包名的简单类名作为包括包名的别名。多个package之间可以用逗号或者分号等来进行分隔。
typeAliases：数组类型，用来指定别名的。指定了这个属性后，Mybatis会把这个类型的短名称作为这个类型的别名，前提是该类上没有标注@Alias注解，否则将使用该注解对应的值作为此种类型的别名。

Xml代码

1. <property  name="typeAliases"> 
2. <array> 
3. <value>com.tiantian.mybatis.model.Blog</value> 
4. <value>com.tiantian.mybatis.model.Comment</value> 
5. </array> 
6. </property>

plugins：数组类型，用来指定Mybatis的Interceptor。
typeHandlersPackage：用来指定TypeHandler所在的包，如果指定了该属性，SqlSessionFactoryBean会自动把该包下面的类注册为对应的TypeHandler。多个package之间可以用逗号或者分号等来进行分隔。
typeHandlers：数组类型，表示TypeHandler。

接下来就是在Spring的applicationContext文件中定义我们想要的Mapper对象对应的MapperFactoryBean了。通过MapperFactoryBean可以获取到我们想要的Mapper对象。MapperFactoryBean实现了Spring的FactoryBean接口，所以MapperFactoryBean是通过FactoryBean接口中定义的getObject方法来获取对应的Mapper对象的。在定义一个MapperFactoryBean的时候有两个属性需要我们注入，一个是Mybatis-Spring用来生成实现了SqlSession接口的SqlSessionTemplate对象的sqlSessionFactory；另一个就是我们所要返回的对应的Mapper接口了。

定义好相应Mapper接口对应的MapperFactoryBean之后，我们就可以把我们对应的Mapper接口注入到由Spring管理的bean对象中了，比如Service bean对象。这样当我们需要使用到相应的Mapper接口时，MapperFactoryBean会从它的getObject方法中获取对应的Mapper接口，而getObject内部还是通过我们注入的属性调用SqlSession接口的getMapper(Mapper接口)方法来返回对应的Mapper接口的。这样就通过把SqlSessionFactory和相应的Mapper接口交给Spring管理实现了Mybatis跟Spring的整合。

Spring的applicationContext.xml配置文件：

Xml代码

1. <?xml  version="1.0"  encoding="UTF-8"?> 
2. <beans  xmlns="http://www.springframework.org/schema/beans"
3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
4. xmlns:mvc="http://www.springframework.org/schema/mvc"
5. xsi:schemaLocation="http://www.springframework.org/schema/beans 
6. http://www.springframework.org/schema/beans/spring-beans-3.0.xsd 
7. http://www.springframework.org/schema/context 
8. http://www.springframework.org/schema/context/spring-context-3.0.xsd 
9. http://www.springframework.org/schema/mvc 
10. http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd"> 
11. <context:component-scan  base-package="com.tiantian.mybatis"/> 
12. <context:property-placeholder location="classpath:config/jdbc.properties"/> 
13. <bean  id="dataSource"  class="org.apache.commons.dbcp.BasicDataSource"
14. destroy-method="close"> 
15. <property  name="driverClassName"  value="${jdbc.driver}" /> 
16. <property  name="url"  value="${jdbc.url}" /> 
17. <property  name="username"  value="${jdbc.username}" /> 
18. <property  name="password"  value="${jdbc.password}" /> 
19. </bean> 
20. 
21. <bean  id="sqlSessionFactory"  class="org.mybatis.spring.SqlSessionFactoryBean"> 
22. <property  name="dataSource"  ref="dataSource" /> 
23. <property  name="mapperLocations"  value="classpath:com/tiantian/mybatis/mapper/*.xml"/> 
24. <property  name="typeAliasesPackage"  value="com.tiantian.mybatis.model" /> 
25. </bean> 
26. 
27. <bean  id="blogMapper"  class="org.mybatis.spring.mapper.MapperFactoryBean"> 
28. <property  name="mapperInterface"
29. value="com.tiantian.mybatis.mapper.BlogMapper" /> 
30. <property  name="sqlSessionFactory"  ref="sqlSessionFactory" /> 
31. </bean> 
32. 
33. </beans>

BlogMapper.xml文件：

Xml代码

1. <?xml  version="1.0"  encoding="UTF-8" ?> 
2. <!DOCTYPE mapper 
3. PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" 
4. "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> 
5. <mapper  namespace="com.tiantian.mybatis.mapper.BlogMapper"> 
6. <!-- 新增记录 --> 
7. <insert  id="insertBlog"  parameterType="Blog"  useGeneratedKeys="true"  keyProperty="id"> 
8. insert into t_blog(title,content,owner) values(#{title},#{content},#{owner}) 
9. </insert> 
10. <!-- 查询单条记录 --> 
11. <select  id="selectBlog"  parameterType="int"  resultMap="BlogResult"> 
12. select * from t_blog where id
13. </select> 
14. <!-- 修改记录 --> 
15. <update  id="updateBlog"  parameterType="Blog"> 
16. update t_blog set title = #{title},content = #{content},owner = #{owner} where id
17. </update> 
18. <!-- 查询所有记录 --> 
19. <select  id="selectAll"  resultType="Blog"> 
20. select * from t_blog 
21. </select> 
22. <!-- 删除记录 --> 
23. <delete  id="deleteBlog"  parameterType="int"> 
24. delete from t_blog where id
25. </delete> 
26. 
27. </mapper>

BlogMapper.java：

Java代码

1. package com.tiantian.mybatis.mapper; 
2. 
3. import java.util.List; 
4. import com.tiantian.mybatis.model.Blog; 
5. 
6. publicinterface BlogMapper { 
7. 
8. public Blog selectBlog(int id); 
9. 
10. publicvoid insertBlog(Blog blog); 
11. 
12. publicvoid updateBlog(Blog blog); 
13. 
14. publicvoid deleteBlog(int id); 
15. 
16. public List<Blog> selectAll(); 
17. 
18. }

BlogServiceImpl.java：

Java代码

1. package com.tiantian.mybatis.service.impl; 
2. 
3. import java.util.List; 
4. import javax.annotation.Resource; 
5. import org.springframework.stereotype.Service; 
6. import com.tiantian.mybatis.mapper.BlogMapper; 
7. import com.tiantian.mybatis.model.Blog; 
8. import com.tiantian.mybatis.service.BlogService; 
9. 
10. @Service
11. publicclass BlogServiceImpl implements BlogService { 
12. 
13. private BlogMapper blogMapper; 
14. 
15. publicvoid deleteBlog(int id) { 
16. blogMapper.deleteBlog(id); 
17. } 
18. 
19. public Blog find(int id) { 
20. returnblogMapper.selectBlog(id); 
21. } 
22. 
23. public List<Blog> find() { 
24. returnblogMapper.selectAll(); 
25. } 
26. 
27. publicvoid insertBlog(Blog blog) { 
28. blogMapper.insertBlog(blog); 
29. } 
30. 
31. publicvoid updateBlog(Blog blog) { 
32. blogMapper.updateBlog(blog); 
33. } 
34. 
35. public BlogMapper getBlogMapper() { 
36. returnblogMapper; 
37. } 
38. 
39. @Resource
40. publicvoid setBlogMapper(BlogMapper blogMapper) { 
41. this.blogMapper = blogMapper; 
42. } 
43. 
44. }

MapperScannerConfigurer

利用上面的方法进行整合的时候，我们有一个Mapper就需要定义一个对应的MapperFactoryBean，当我们的Mapper比较少的时候，这样做也还可以，但是当我们的Mapper相当多时我们再这样定义一个个Mapper对应的MapperFactoryBean就显得速度比较慢了。为此Mybatis-Spring为我们提供了一个叫做MapperScannerConfigurer的类，通过这个类Mybatis-Spring会自动为我们注册Mapper对应的MapperFactoryBean对象。

如果我们需要使用MapperScannerConfigurer来帮我们自动扫描和注册Mapper接口的话我们需要在Spring的applicationContext配置文件中定义一个MapperScannerConfigurer对应的bean。对于MapperScannerConfigurer而言有一个属性是我们必须指定的，那就是basePackage。basePackage是用来指定Mapper接口文件所在的基包的，在这个基包或其所有子包下面的Mapper接口都将被搜索到。多个基包之间可以使用逗号或者分号进行分隔。最简单的MapperScannerConfigurer定义就是只指定一个basePackage属性，如：

Xml代码

1. <bean  class="org.mybatis.spring.mapper.MapperScannerConfigurer"> 
2. <property  name="basePackage"  value="com.tiantian.mybatis.mapper" /> 
3. </bean>

这样MapperScannerConfigurer就会扫描指定基包下面的所有接口，并把它们注册为一个个MapperFactoryBean对象。当使用MapperScannerConfigurer加basePackage属性的时候，我们上面例子的applicationContext配置文件将变为这样：

Xml代码


  
 
 
1. <?xml  version="1.0"  encoding="UTF-8"?> 
2. <beans  xmlns="http://www.springframework.org/schema/beans"
3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
4. xmlns:mvc="http://www.springframework.org/schema/mvc"
5. xsi:schemaLocation="http://www.springframework.org/schema/beans 
6. http://www.springframework.org/schema/beans/spring-beans-3.0.xsd 
7. http://www.springframework.org/schema/context 
8. http://www.springframework.org/schema/context/spring-context-3.0.xsd 
9. http://www.springframework.org/schema/mvc 
10. http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd"> 
11. 
12. <context:component-scan  base-package="com.tiantian.mybatis" /> 
13. <context:property-placeholder location="classpath:config/jdbc.properties" /> 
14. <bean  id="dataSource"  class="org.apache.commons.dbcp.BasicDataSource"
15. destroy-method="close"> 
16. <property  name="driverClassName"  value="${jdbc.driver}" /> 
17. <property  name="url"  value="${jdbc.url}" /> 
18. <property  name="username"  value="${jdbc.username}" /> 
19. <property  name="password"  value="${jdbc.password}" /> 
20. </bean> 
21. <bean  id="sqlSessionFactory"  class="org.mybatis.spring.SqlSessionFactoryBean"> 
22. <property  name="dataSource"  ref="dataSource" /> 
23. <property  name="mapperLocations"  value="classpath:com/tiantian/mybatis/mapper/*.xml" /> 
24. <property  name="typeAliasesPackage"  value="com.tiantian.mybatis.model" /> 
25. </bean> 
26. <bean  class="org.mybatis.spring.mapper.MapperScannerConfigurer"> 
27. <property  name="basePackage"  value="com.tiantian.mybatis.mapper" /> 
28. </bean> 
29. </beans>

有时候我们指定的基包下面的并不全是我们定义的Mapper接口，为此MapperScannerConfigurer还为我们提供了另外两个可以缩小搜索和注册范围的属性。一个是annotationClass，另一个是markerInterface。

annotationClass：当指定了annotationClass的时候，MapperScannerConfigurer将只注册使用了annotationClass注解标记的接口。
markerInterface：markerInterface是用于指定一个接口的，当指定了markerInterface之后，MapperScannerConfigurer将只注册继承自markerInterface的接口。

如果上述两个属性都指定了的话，那么MapperScannerConfigurer将取它们的并集，而不是交集。即使用了annotationClass进行标记或者继承自markerInterface的接口都将被注册为一个MapperFactoryBean。

现在假设我们的Mapper接口都继承了一个SuperMapper接口，那么我们就可以这样来定义我们的MapperScannerConfigurer。

Xml代码


   
 
1. <bean  class="org.mybatis.spring.mapper.MapperScannerConfigurer"> 
2. <property  name="basePackage"  value="com.tiantian.mybatis.mapper" /> 
3. <property  name="markerInterface"  value="com.tiantian.mybatis.mapper.SuperMapper"/> 
4. </bean>

如果是都使用了注解MybatisMapper标记的话，那么我们就可以这样来定义我们的MapperScannerConfigurer。

Xml代码


 
1. <bean  class="org.mybatis.spring.mapper.MapperScannerConfigurer"> 
2. <property  name="basePackage"  value="com.tiantian.mybatis.mapper" /> 
3. <property  name="annotationClass"  value="com.tiantian.mybatis.annotation.MybatisMapper"/> 
4. </bean>

除了用于缩小注册Mapper接口范围的属性之外，我们还可以指定一些其他属性，如：

sqlSessionFactory：这个属性已经废弃。当我们使用了多个数据源的时候我们就需要通过sqlSessionFactory来指定在注册MapperFactoryBean的时候需要使用的SqlSessionFactory，因为在没有指定sqlSessionFactory的时候，会以Autowired的方式自动注入一个。换言之当我们只使用一个数据源的时候，即只定义了一个SqlSessionFactory的时候我们就可以不给MapperScannerConfigurer指定SqlSessionFactory。
sqlSessionFactoryBeanName：它的功能跟sqlSessionFactory是一样的，只是它指定的是定义好的SqlSessionFactory对应的bean名称。
sqlSessionTemplate：这个属性已经废弃。它的功能也是相当于sqlSessionFactory的，因为就像前面说的那样，MapperFactoryBean最终还是使用的SqlSession的getMapper方法取的对应的Mapper对象。当定义有多个SqlSessionTemplate的时候才需要指定它。对于一个MapperFactoryBean来说SqlSessionFactory和SqlSessionTemplate只需要其中一个就可以了，当两者都指定了的时候，SqlSessionFactory会被忽略。
sqlSessionTemplateBeanName：指定需要使用的sqlSessionTemplate对应的bean名称。

注意：由于使用sqlSessionFactory和sqlSessionTemplate属性时会使一些内容在PropertyPlaceholderConfigurer之前加载，导致在配置文件中使用到的外部属性信息无法被及时替换而出错，因此官方现在新的Mybatis-Spring中已经把sqlSessionFactory和sqlSessionTemplate属性废弃了，推荐大家使用sqlSessionFactoryBeanName属性和sqlSessionTemplateBeanName属性。

Xml代码

1. <?xml  version="1.0"  encoding="UTF-8"?> 
2. <beans  xmlns="http://www.springframework.org/schema/beans"
3. xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context"
4. xmlns:mvc="http://www.springframework.org/schema/mvc"
5. xmlns:mybatis="http://www.mybatis.org/schema/mybatis"
6. xsi:schemaLocation="http://www.springframework.org/schema/beans 
7. http://www.springframework.org/schema/beans/spring-beans-3.0.xsd 
8. http://www.springframework.org/schema/context 
9. http://www.springframework.org/schema/context/spring-context-3.0.xsd 
10. http://www.mybatis.org/schema/mybatis 
11. http://www.mybatis.org/schema/mybatis/mybatis-spring.xsd 
12. http://www.springframework.org/schema/mvc 
13. http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd"> 
14. 
15. <context:component-scan  base-package="com.tiantian.mybatis" /> 
16. <context:property-placeholder location="classpath:config/jdbc.properties" /> 
17. <bean  id="dataSource"  class="org.apache.commons.dbcp.BasicDataSource"
18. destroy-method="close"> 
19. <property  name="driverClassName"  value="${jdbc.driver}" /> 
20. <property  name="url"  value="${jdbc.url}" /> 
21. <property  name="username"  value="${jdbc.username}" /> 
22. <property  name="password"  value="${jdbc.password}" /> 
23. </bean> 
24. <bean  id="sqlSessionFactory"  class="org.mybatis.spring.SqlSessionFactoryBean"> 
25. <property  name="dataSource"  ref="dataSource" /> 
26. <property  name="mapperLocations"  value="classpath:com/tiantian/mybatis/mapper/*.xml" /> 
27. <property  name="typeAliasesPackage"  value="com.tiantian.mybatis.model" /> 
28. </bean> 
29. <bean  class="org.mybatis.spring.mapper.MapperScannerConfigurer"> 
30. <property  name="basePackage"  value="com.tiantian.mybatis.mapper" /> 
31. <property  name="markerInterface"  value="com.tiantian.mybatis.mapper.SuperMapper"/> 
32. <property  name="sqlSessionFactoryBeanName"  value="sqlSessionFactory"/> 
33. </bean> 
34. </beans>

SqlSessionTemplate

除了上述整合之后直接使用Mapper接口之外，Mybatis-Spring还为我们提供了一种直接使用SqlSession的方式。Mybatis-Spring为我们提供了一个实现了SqlSession接口的SqlSessionTemplate类，它是线程安全的，可以被多个Dao同时使用。同时它还跟Spring的事务进行了关联，确保当前被使用的SqlSession是一个已经和Spring的事务进行绑定了的。而且它还可以自己管理Session的提交和关闭。当使用了Spring的事务管理机制后，SqlSession还可以跟着Spring的事务一起提交和回滚。

使用SqlSessionTemplate时我们可以在Spring的applicationContext配置文件中如下定义：

<constructor-arg index="0" ref="sqlSessionFactory" />

</bean>

这样我们就可以通过Spring的依赖注入在Dao中直接使用SqlSessionTemplate来编程了，这个时候我们的Dao可能是这个样子：

Java代码

1. package com.tiantian.mybatis.dao; 
2. 
3. import java.util.List; 
4. import javax.annotation.Resource; 
5. import org.mybatis.spring.SqlSessionTemplate; 
6. import org.springframework.stereotype.Repository; 
7. import com.tiantian.mybatis.model.Blog; 
8. 
9. @Repository
10. publicclass BlogDaoImpl implements BlogDao { 
11. 
12. private SqlSessionTemplate sqlSessionTemplate; 
13. 
14. publicvoid deleteBlog(int id) { 
15. sqlSessionTemplate.delete("com.tiantian.mybatis.mapper.BlogMapper.deleteBlog", id); 
16. } 
17. 
18. public Blog find(int id) { 
19. returnsqlSessionTemplate.selectOne("com.tiantian.mybatis.mapper.BlogMapper.selectBlog", id); 
20. } 
21. 
22. public List<Blog> find() { 
23. returnthis.sqlSessionTemplate.selectList("com.tiantian.mybatis.mapper.BlogMapper.selectAll"); 
24. } 
25. 
26. publicvoid insertBlog(Blog blog) { 
27. this.sqlSessionTemplate.insert("com.tiantian.mybatis.mapper.BlogMapper.insertBlog", blog); 
28. } 
29. 
30. publicvoid updateBlog(Blog blog) { 
31. this.sqlSessionTemplate.update("com.tiantian.mybatis.mapper.BlogMapper.updateBlog", blog); 
32. } 
33. 
34. public SqlSessionTemplate getSqlSessionTemplate() { 
35. returnsqlSessionTemplate; 
36. } 
37. 
38. @Resource
39. publicvoid setSqlSessionTemplate(SqlSessionTemplate sqlSessionTemplate) { 
40. this.sqlSessionTemplate = sqlSessionTemplate; 
41. } 
42. 
43. }

注：

本文是基于Mybatis3.2.1、Mybatis-Spring1.1.0和Spring3.1写的。