mybatis整合spring的三种方式（详细）

文章内容由博主自己整理，链接：http://mybatis.org/spring/zh/index.html

1.什么是 MyBatis-Spring

  MyBatis-Spring 会帮助你将 MyBatis 代码无缝地整合到 Spring 中。它将允许 MyBatis 参与到 Spring 的事务管理之中，创建映射器 mapper 和 SqlSession 并注入到 bean 中，以及将 Mybatis 的异常转换为 Spring 的 DataAccessException。最终，可以做到应用代码不依赖于 MyBatis，Spring 或 MyBatis-Spring

2.MyBatis-Spring配置（展示第一种方法：注册映射器）

  要和 Spring 一起使用 MyBatis，除了依赖支持以外，还需要在 Spring 应用上下文中定义至少两样东西：一个 SqlSessionFactory 和至少一个数据映射器类

1. 除基础mybatis和spring依赖外，添加整合依赖

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

2. 将会话工厂对象托管给spring（xml或annotation方式）

   SqlSessionFactoryBean会调用类中的getObject()方法，返回SqlSessionFactory

   <!-- dataSource可用spring提供的配置注入 -->
   <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
     <property name="dataSource" ref="dataSource" />
   </bean>
   

   @Bean
   public SqlSessionFactory sqlSessionFactory() throws Exception {
     SqlSessionFactoryBean factoryBean = new SqlSessionFactoryBean();
     factoryBean.setDataSource(dataSource());
     return factoryBean.getObject();
   }
   

3. 定义映射器接口

    // 实体类
    public class User implements Serializable {
        private static final long serialVersionUID = -4360762632228312301L;
    
        private String name;
        private String password;
        
        // setter、getter、toString...
    }
   

   package com.liu.dao;
   
   // mybatis映射器接口。sql部分也可以使用mybatis的xml配置，与接口在同一路径下，会被 MapperFactoryBean自动解析
   public interface UserMapper {
       @Select("select * from user where id = #{userId}")
       User getUser(String userId);
   }
   

4. 注册映射器：将映射器接口托管到Spring中（xml或annotation方式）

   1. 注入接口和会话工厂，生成接口的实现类对象MapperFactoryBean
   2. MapperFactoryBean 负责 SqlSession 的创建和关闭，如果使用了 Spring 事务，当事务完成时，session 将会被提交或回滚。最终任何异常都会被转换成 Spring 的 DataAccessException 异常

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

   /*
   大概的流程如下：
   	SqlSessionTemplate sqlSessionTemplate = new SqlSessionTemplate(sqlSessionFactory());
       return sqlSessionTemplate.getMapper(UserMapper.class);
   注意：不能认为创建实现类对象的过程就完全是这样的，因为这是个普通接口，mybatis不认为它是MapperRegisty，
   	所有在这个过程中还做了其它的一些事情
   */
   @Bean
   public MapperFactoryBean<UserMapper> userMapper() throws Exception {
       MapperFactoryBean<UserMapper> factoryBean = new MapperFactoryBean<>(UserMapper.class);
       factoryBean.setSqlSessionFactory(sqlSessionFactory());
       return factoryBean;
   }
   

5. 测试类

   @RunWith(SpringRunner.class)
   @ContextConfiguration("/beans.xml")
   public class AppTest {
   
       @Resource
       private UserMapper userMapper;
   
       @Test
       public void test1() {
           User user = userMapper.getUser(1);
           System.out.println("user: " + user);
       }
   }
   

3.改进注册映射器方式：使用发现映射器方式（2种方式）

以上第4步MapperFactoryBean注册映射器的最大问题，就是需要一个个注册所有的映射器，而实际上mybatis-spring提供了扫描包下所有映射器接口的方法

注意：以下两种配置方法，均可替换上述第4点MapperFactoryBean配置，而其余代码与配置不变

1. 配置扫描器标签（xml或annotation方式）

   • 该配置类似<context:component-scan />，直接扫描包，将包下所有接口注入spring
   • 与上面配置MapperFactoryBean的不同，该配置无需注入SqlSessionFactory，它会自动匹配已有的会话工厂bean
   • 如果配置了多个DataSource，也就是多个sqlSessionFactory时，可以使用factory-ref参数指定需要的会话工厂

   <beans xmlns="http://www.springframework.org/schema/beans"
     xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
     xmlns:mybatis="http://mybatis.org/schema/mybatis-spring"
     xsi:schemaLocation="
     http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd
     http://mybatis.org/schema/mybatis-spring http://mybatis.org/schema/mybatis-spring.xsd">
     
       <!-- 注解配置类：@MapperScan(basePackages = "com.liu.dao", sqlSessionFactoryRef = "sqlSessionFactory") -->
       <mybatis:scan base-package="com.liu.dao" factory-ref="sqlSessionFactory" />
       
   	<!-- 省略其他... -->
   </beans>
   

2. 注入MapperScannerConfigurer类（xml或annotation方式）

   • 与上面标签的功能差不多，同样是扫描基准包，自动注入会话工厂
   • 如果要更换注入的会话工厂，不同于常用的ref引入bean，而是使用value指定bean名，且属性是sqlSessionFactoryBeanName，而不是已经不建议使用的sqlSessionFactory

   <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="com.liu.dao" />
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
    </bean>
   

   @Bean
   public MapperScannerConfigurer mapperScannerConfigurer() {
       MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer();
       mapperScannerConfigurer.setBasePackage("com.liu.dao");
       mapperScannerConfigurer.setSqlSessionFactoryBeanName("sqlSessionFactory");
   
       return mapperScannerConfigurer;
   }