Spring集成Mybatis配置文件的简单理解

详情可见官方文档http://www.mybatis.org/spring/zh/index.html

一、需要配置的对象实例

1.SqlSessionFactoryBean

在 MyBatis-Spring配置中,SqlSessionFactoryBean 是用于创建 SqlSessionFactory 的。

要配置这个工厂 bean,放置下面的代码在 Spring 的 XML 配置文件中:

 <!-- 指定数据源和配置文件路径 -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource" />
        <!-- 自动扫描mapping.xml文件 -->
        <property name="mapperLocations" value="classpath:com/mapping/*.xml"></property>
    </bean>

要注意 SqlSessionFactory 需要一个 DataSource

2.DataSourceTransactionManager 事务管理器

要 开 启 Spring 的 事 务 处 理 , 在 Spring 的 XML 配 置 文 件 中 简 单 创 建 一 个 DataSourceTransactionManager 对象:

<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
  <property name="dataSource" ref="dataSource" />
</bean>

 3.MapperFactoryBean 

通过MapperFactoryBean指定对应的Dao层接口(也就是Mapper接口)，还有sqlSessionFactory

MapperFactoryBean 创建的代理类实现了Mapper 接口,并且注入到应用程序中。

如果 Mapper 有一个对应的 MyBatis 的 XML 映射器文件, 如果 XML 文件在类路径的 位置和映射器类相同时, 它会被 MapperFactoryBean 自动解析。

<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>

 4.MapperScannerConfigurer

指定Dao层所在的包，以及sqlSessionFactoryBeanName

没有必要在 Spring 的 XML 配置文件中注册所有的映射器。

相反,你可以使用一个 MapperScannerConfigurer , 它将会查找类路径下所有的 映 射 器 并 自 动 将 它 们 创 建 成 MapperFactoryBean。

注 意 , 没 有 必 要 去 指 定 SqlSessionFactory 或 SqlSessionTemplate , 因 为 MapperScannerConfigurer 将会创建 MapperFactoryBean,之后自动装配。

但是,如果你使 用了一个以上的 DataSource ,那 么自动装配可能会失效 。这种 情况下 ,你可以使用 sqlSessionFactoryBeanName 或 sqlSessionTemplateBeanName 属性来设置正确的 bean 名 称来使用。

<!-- DAO接口所在包名，Spring会自动查找其下的类，并将其定义为一个Spring Bean --> 
 <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="com.dao" />
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
  </bean>

二、Mybatis中的重要对象

1.SqlSession

SqlSession是用于执行持久化操作的对象，类似于JDBC中的Connection。

它提供了面向数据库执行SQL命令所需的所有方法，可以通过SqlSession实例直接运行已映射的SQL语句。

SqlSession对应着一次数据库回话。

由于数据库会话不是永久的，因此SqlSession的生命周期也不应该是永久的。相反，在每次访问数据库时都需要创建它。

需要注意的是，每个线程都有自己的SqlSession实例，SqlSession实例不能被共享，也不是线程安全的。

因此最佳的作用域范围是request作用域或者方法体作用域内。

2.SqlSessionFactory。

每个数据库对应一个 SqlSessionFactory。
所以，如果你想连接两个数据库，你需要创建两个 SqlSessionFactory 实例。以此类推。

3，关于SqlSession，SqlSessionFactory，SqlSessionFactoryBean的关系。

Mybatis核心是获取 SqlSession 实例。

要获得 SqlSession 实例，则需要依赖 SqlSessionFactory 实例,通过openSession()方法获得。

而 SqlSessionFactory 是 SqlSessionFactoryBuilder 依据 MyBatis 配置文件中的数据源、Sql映射文件等信息来构建的。

在 MyBatis 中，SqlSessionFactory 的实例需要使用 SqlSessionFactoryBuilder 创建；

而在集成环境中，则可以使用 MyBatis-Spring 整合包中的 SqlSessionFactoryBean 来代替。

SqlSessionFactoryBean 封装了使用 SqlSessionFactoryBuilder 创建 SqlSessionFactory 的过程，

我们可以在 Spring 中以配置文件的形式，通过配置 SqlSessionFactoryBean 获得 SqlSessionFactory 实例。

源码细节，类似如下所示：

public class MybatisTest {   
    @Test
    public void findUserByIdTest(){
        InputStream inputStream=null;
        SqlSession sqlSession=null;
        try {
            inputStream=Resources.getResourceAsStream("SqlMapConfig.xml");
            //1.创建会话工厂，传入mybatis的配置文件信息
            SqlSessionFactory factory=new SqlSessionFactoryBuilder().build(inputStream);
            //2.通过工厂得到SqlSession
            sqlSession=factory.openSession();
            //3.通过SqlSession操作数据库
            User user=sqlSession.selectOne("test.findUserById", 1);
            System.out.println(user.toString());
        } catch (IOException e) {
            e.printStackTrace();
        }finally{
            if(sqlSession!=null){
                sqlSession.close();
            }
            if(inputStream!=null){
                try {
                    inputStream.close();
                } catch (IOException e) {
                    e.printStackTrace();
                }
            }
        }        
    }
}

三、示例如下：

spring-mybatis.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:p="http://www.springframework.org/schema/p"
       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.1.xsd
                        http://www.springframework.org/schema/context
                        http://www.springframework.org/schema/context/spring-context-3.1.xsd
                        http://www.springframework.org/schema/mvc
                        http://www.springframework.org/schema/mvc/spring-mvc-4.0.xsd">


    <!-- 引入配置文件 -->
    <bean id="propertyConfigurer"
                  class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
    <property name="locations" >
        <list>
            <value>classpath:jdbc.properties </value>
            <value>classpath:generator.properties </value>
        </list>

    </property>
</bean>

   <!-- 配置数据源 -->
    <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource"
          destroy-method="close">
        <property name="driverClassName" value="${driver}" />
        <property name="url" value="${url}" />
        <property name="username" value="${username}" />
        <property name="password" value="${password}" />
        <!-- 初始化连接大小 -->
        <property name="initialSize" value="${initialSize}"></property>
        <!-- 连接池最大数量 -->
        <property name="maxActive" value="${maxActive}"></property>
        <!-- 连接池最大空闲 -->
        <property name="maxIdle" value="${maxIdle}"></property>
        <!-- 连接池最小空闲 -->
        <property name="minIdle" value="${minIdle}"></property>
        <!-- 获取连接最大等待时间 -->
        <property name="maxWait" value="${maxWait}"></property>
    </bean>

    <!-- 指定数据源和配置文件路径 -->
    <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
        <property name="dataSource" ref="dataSource" />
        <!-- 自动扫描mapping.xml文件 -->
        <property name="mapperLocations" value="classpath:com/mapping/*.xml"></property>
    </bean>

    <!-- DAO接口所在包名，Spring会自动查找其下的类，并将其定义为一个Spring Bean -->
    <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
        <property name="basePackage" value="com.dao" />
        <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>
    </bean>

    <!-- (事务管理)transaction manager -->
    <bean id="transactionManager"
          class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource" />
    </bean>

</beans>