Mybatis整合Spring(新)

1. <?
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 = #{id}  
13.     </select>  
14. <!--  修改记录  -->  
15.     <update id="updateBlog" parameterType="Blog">  
16.         update t_blog set title = #{title},content = #{content},owner = #{owner} where id = #{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 = #{id}  
25.     </delete>  
26.      
27. </mapper>  

BlogMapper.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：

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属性，如：

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

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

1. <?
2. <beans 
3.     
4.     
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"   
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" >  
22.        <property name="dataSource" ref="dataSource" />  
23.        <property name="mapperLocations" value="classpath:com/tiantian/mybatis/mapper/*.
24.        <property name="typeAliasesPackage" value="com.tiantian.mybatis.model" />  
25.     </bean>  
26.     <bean >  
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。

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

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

1. <bean >  
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属性。

1. <?
2. <beans 
3.     
4.     
5.     
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"   
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" >  
25.        <property name="dataSource" ref="dataSource" />  
26.        <property name="mapperLocations" value="classpath:com/tiantian/mybatis/mapper/*.
27.        <property name="typeAliasesPackage" value="com.tiantian.mybatis.model" />  
28.     </bean>  
29.     <bean >  
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配置文件中如下定义：

    <bean id="sqlSession" class="org.mybatis.spring.SqlSessionTemplate">

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

    </bean>

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

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写的。

 整理的比较粗略，将代码分享给大家，【源码地址获取】

原标题：Mybatis整合Spring(新)

关键词：Spring