MyBatis入门学习(Spring整合MyBatis)

注意：

1)      务必注意整合二者以及MyBatis-Spring的版本问题，很多时候完成后却无法运行往往就是由于版本不兼容导致！

2)      由于使用注释配置更加简便，所以本人项目采用注释配置事务和注入bean。

3)      本文仅提供整合部分配置参考，具体Spring和MyBatis使用请参考其他博文。

在原生MyBatis中，操控数据库的任务最终落到sqlSession或者对应Mapper接口上。而这两种方式归根结底都需要获得SqlSessionFactory。因此在使用Spring整合MyBatis时，关键也在于获取SqlsessionFactory。

并且 Spring 中以你通常的做法来配置事务。@Transactional 注解和AOP样式的配置都是支持的。在事务处理期间,一个单独的 SqlSession 对象将会被创建和使用。当事务完成时,这个 session 会以合适的方式提交或回滚。因此你只需要关注你的业务代码而无需关注事务的提交，回滚等细节。

Spring配置：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
	xmlns:context="http://www.springframework.org/schema/context"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 
	xmlns:tx="http://www.springframework.org/schema/tx"
	xmlns:aop="http://www.springframework.org/schema/aop"
	xmlns:p="http://www.springframework.org/schema/p"
	xsi:schemaLocation="
        http://www.springframework.org/schema/beans     
        http://www.springframework.org/schema/beans/spring-beans.xsd
        http://www.springframework.org/schema/context
        http://www.springframework.org/schema/context/spring-context.xsd
        http://www.springframework.org/schema/aop
        http://www.springframework.org/schema/aop/spring-aop.xsd
        http://www.springframework.org/schema/tx
        http://www.springframework.org/schema/tx/spring-tx.xsd">
	<!-- 扫描有@component @controller @service的类包并将其归入bean内 -->
	<context:component-scan base-package="com.paditang.dao"/>
	<context:component-scan base-package="com.paditang.service"/>
	
	  
	<!-- 加载spring中的资源文件 -->
	 <context:property-placeholder location="classpath:jdbc.properties" />
	
	<bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close"	
		p:driverClassName="net.sourceforge.jtds.jdbc.Driver"
		p:url="jdbc:jtds:sqlserver://localhost:1433;DatabaseName=test_api"
		p:username="sa"
		p:password="password">
	</bean>
		
	<!-- 获取MyBatis sqlSessionFactory -->
	<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"
		p:dataSource-ref="dataSource"
		p:configLocation="classpath:MyBatis-conf.xml"
		p:mapperLocations="classpath:com/paditang/mapping/*.xml"><!-- 扫描Mapper文件 -->
	</bean>
	
	<!-- 使用提供的template -->
	<bean id="sqlSessionTemplate" class="org.mybatis.spring.SqlSessionTemplate">
		<constructor-arg ref="sqlSessionFactory"></constructor-arg>
	</bean>
	
	<!-- 扫描直接使用mapper接口类操作dao -->
	<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"
		
		p:basePackage="com.paditang.mapping">
		<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" />
		
	</bean>
	
	<!-- 配置事务管理器 -->
	<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
        <property name="dataSource" ref="dataSource" />
    </bean>

	<!-- 配置基于注解的声明式事务 -->
	<tx:annotation-driven transaction-manager="transactionManager" />
	
</beans>

MyBatis配置：

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
  PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
  "http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
  
   <!-- 使用Log4j日志 -->
  <settings>
  		<setting name="lazyLoadingEnabled" value="false"/>
		<setting name="logImpl" value="LOG4J"></setting>
  </settings>
  
  <!-- 别名，配置后可以使用别名替代完整限定名 -->
  <typeAliases>
  	<typeAlias alias="User" type="com.paditang.domain.User"/>
  </typeAliases>
  <!-- 在Spring中配置扫描后此处不得重复添加映射
  <mappers>
    <mapper resource="com/paditang/mapping/UserMapper.xml"/>
  </mappers> -->
</configuration>

实例代码：

package com.paditang.dao;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Repository;

import com.paditang.domain.User;
import com.paditang.mapping.UserMapper;

@Repository
public class UserDao {

	@Autowired
	private UserMapper userMapper;
	
	public User getUserById(int id){
		return userMapper.getUser(id);
	}
	public String getLocationByUserName(String name){
		return userMapper.getLocationByUserName(name);
	}
}

也可以使用原生API：

public class UserMapperSqlSessionImpl implements UserMapper {
  // SqlSessionFactory would normally be set by SqlSessionDaoSupport
  private SqlSessionFactory sqlSessionFactory;

  public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory) {
    this.sqlSessionFactory = sqlSessionFactory;
  }

  public User getUser(String userId) {
    // note standard MyBatis API usage - opening and closing the session manually
    SqlSession session = sqlSessionFactory.openSession();

    try {
      return (User) session.selectOne("org.mybatis.spring.sample.mapper.UserMapper.getUser", userId);
    } finally {
      session.close();
    }
  }
}

Note:

小心使用此选项,因为错误的使用会产生运行时错误,或者更糟糕的数据一致性的问题。这些是告诫:

1) 它不会参与到 Spring 的事务之中。

2) 如果 SqlSession 使用DataSource,它也会被 Spring 事务管理器使用,而且当前有事务在进行时,这段代码会抛出异常。

3 )MyBatis 的 DefaultSqlSession 是线程不安全的。如果在bean 中注入了它,就会发生错误。

4)      使用 DefaultSqlSession 创建的映射器也不是线程安全的。如果你将它们注入到 bean 中,是会发生错误的。

5)      你必须保证在 finally 块中来关闭 SqlSession。

个人源码：https://github.com/caiwuxin/MyBatisLearning/tree/master/Spring-MyBatis

参考资料：http://www.mybatis.org/spring/zh/index.html