MyBatis5中Spring集成MyBatis事物管理

更新時(shí)間：2016年05月03日 12:06:26 作者：五月的倉(cāng)頡

這篇文章主要介紹了MyBatis5中MyBatis集成Spring事物管理的相關(guān)資料,需要的朋友可以參考下

單獨(dú)使用MyBatis對(duì)事物進(jìn)行管理

前面MyBatis的文章有寫過(guò)相關(guān)內(nèi)容，這里繼續(xù)寫一個(gè)最簡(jiǎn)單的Demo，算是復(fù)習(xí)一下之前MyBatis的內(nèi)容吧，先是建表，建立一個(gè)簡(jiǎn)單的Student表：

create table student
(
student_id int auto_increment,
student_name varchar(20) not null,
primary key(student_id)
)

建立實(shí)體類Student.java：

public class Student
{
private int studentId;
private String studentName;
public int getStudentId()
{
return studentId;
}
public void setStudentId(int studentId)
{
this.studentId = studentId;
}
public String getStudentName()
{
return studentName;
}
public void setStudentName(String studentName)
{
this.studentName = studentName;
}
public String toString()
{
return "Student{[studentId:" + studentId + "], [studentName:" + studentName + "]}";
}
}

多說(shuō)一句，對(duì)實(shí)體類重寫toString()方法，打印其中每一個(gè)（或者說(shuō)是關(guān)鍵屬性）是一個(gè)推薦的做法。接著是config.xml，里面是jdbc基本配置：

<?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>
<typeAliases>
<typeAlias alias="Student" type="org.xrq.domain.Student" />
</typeAliases>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/test"/>
<property name="username" value="root"/>
<property name="password" value="root"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="student_mapper.xml"/>
</mappers>
</configuration>

然后是student_mapper.xml，主要是具體的sql語(yǔ)句：

<mapper namespace="StudentMapper">
<resultMap type="Student" id="StudentMap">
<id column="student_id" property="studentId" jdbcType="INTEGER" />
<result column="student_name" property="studentName" jdbcType="VARCHAR" />
</resultMap>
<select id="selectAllStudents" resultMap="StudentMap">
select student_id, student_name from student;
</select>
<insert id="insertStudent" useGeneratedKeys="true" keyProperty="studentId" parameterType="Student">
insert into student(student_id, student_name) values(#{studentId, jdbcType=INTEGER}, #{studentName, jdbcType=VARCHAR});
</insert>
</mapper>

建立一個(gè)MyBatisUtil.java，用于建立一些MyBatis基本元素的，后面的類都繼承這個(gè)類：

public class MyBatisUtil
{
protected static SqlSessionFactory ssf;
protected static Reader reader;
static
{
try
{
reader = Resources.getResourceAsReader("config.xml");
ssf = new SqlSessionFactoryBuilder().build(reader);
} 
catch (IOException e)
{
e.printStackTrace();
}
}
protected SqlSession getSqlSession()
{
return ssf.openSession();
}
}

企業(yè)級(jí)開(kāi)發(fā)講求：

1、定義和實(shí)現(xiàn)分開(kāi)

2、分層開(kāi)發(fā)，通常情況下為Dao-->Service-->Controller，不排除根據(jù)具體情況多一層/幾層或少一層

所以，先寫一個(gè)StudentDao.java接口：

public interface StudentDao
{
public List<Student> selectAllStudents();
public int insertStudent(Student student);
}

最后寫一個(gè)StudentDaoImpl.java實(shí)現(xiàn)這個(gè)接口，注意要繼承MyBatisUtil.java類：

public class StudentDaoImpl extends MyBatisUtil implements StudentDao
{
private static final String NAMESPACE = "StudentMapper.";
public List<Student> selectAllStudents()
{
SqlSession ss = getSqlSession();
List<Student> list = ss.selectList(NAMESPACE + "selectAllStudents");
ss.close();
return list;
}
public int insertStudent(Student student)
{
SqlSession ss = getSqlSession();
int i = ss.insert(NAMESPACE + "insertStudent", student);
// ss.commit();
ss.close();
return i;
}
}

寫一個(gè)測(cè)試類：

public class StudentTest
{
public static void main(String[] args)
{
StudentDao studentDao = new StudentDaoImpl();
Student student = new Student();
student.setStudentName("Jack");
studentDao.insertStudent(student);
System.out.println("插入的主鍵為：" + student.getStudentId());
System.out.println("-----Display students------");
List<Student> studentList = studentDao.selectAllStudents();
for (int i = 0, length = studentList.size(); i < length; i++)
System.out.println(studentList.get(i));
}
}

結(jié)果一定是空。

我說(shuō)過(guò)這個(gè)例子既是作為復(fù)習(xí)，也是作為一個(gè)引子引入我們今天的內(nèi)容，空的原因是，insert操作已經(jīng)做了，但是MyBatis并不會(huì)幫我們自動(dòng)提交事物，所以展示出來(lái)的自然是空的。這種時(shí)候就必須手動(dòng)通過(guò)SqlSession的commit()方法提交事務(wù)，即打開(kāi)StudentDaoImpl.java類第17行的注釋就可以了。

多說(shuō)一句，這個(gè)例子除了基本的MyBatis插入操作之外，在插入的基礎(chǔ)上還有返回插入的主鍵id的功能。

接下來(lái)，就利用Spring管理MyBatis事物，這也是企業(yè)級(jí)開(kāi)發(fā)中最常用的事物管理做法。

使用Spring管理MyBatis事物

關(guān)于這塊，網(wǎng)上有很多文章講解，我搜索了很多，但是要么就是相互復(fù)制黏貼，要么就是沒(méi)有把整個(gè)例子講清楚的，通過(guò)這一部分，我盡量講清楚如何使用Spring管理MyBatis事物。

使用Spring管理MyBatis事物，除了Spring必要的模塊beans、context、core、expression、commons-logging之外，還需要以下內(nèi)容：

（1）MyBatis-Spring-1.x.0.jar，這個(gè)是Spring集成MyBatis必要的jar包

（2）數(shù)據(jù)庫(kù)連接池，dbcp、c3p0都可以使用，我這里使用的是阿里的druid

（3）jdbc、tx、aop，jdbc是基本的不多說(shuō)，用到tx和aop是因?yàn)镾pring對(duì)MyBatis事物管理的支持是通過(guò)aop來(lái)實(shí)現(xiàn)的

（4）aopalliance.jar，這個(gè)是使用Spring AOP必要的一個(gè)jar包

上面的jar包會(huì)使用Maven的可以使用Maven下載，沒(méi)用過(guò)Maven的可以去CSDN上下載，一搜索就有的。

MyBatis的配置文件config.xml里面，關(guān)于jdbc連接的部分可以都去掉，只保留typeAliases的部分：

<?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>
<typeAliases>
<typeAlias alias="Student" type="org.xrq.domain.Student" />
</typeAliases>
</configuration>

多提一句，MyBatis另外一個(gè)配置文件student_mapper.xml不需要改動(dòng)。接著，寫Spring的配置文件，我起名字叫做spring.xml：

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://www.springframework.org/schema/beans"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:aop="http://www.springframework.org/schema/aop"
xsi:schemaLocation="
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.2.xsd 
http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc-4.2.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.2.xsd 
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.2.xsd">
<!-- 注解配置 -->
<tx:annotation-driven transaction-manager="transactionManager" />
<context:annotation-config /> 
<context:component-scan base-package="org.xrq" />
<!-- 數(shù)據(jù)庫(kù)連接池,這里使用alibaba的Druid -->
<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource" init-method="init" destroy-method="close">
<property name="url" value="jdbc:mysql://localhost:3306/test" /> 
<property name="username" value="root" /> 
<property name="password" value="root" /> 
</bean>
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="configLocation" value="classpath:config.xml" />
<property name="mapperLocations" value="classpath:*_mapper.xml" />
<property name="dataSource" ref="dataSource" />
</bean>
<!-- 事務(wù)管理器 --> 
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"> 
<property name="dataSource" ref="dataSource" /> 
</bean> 
</beans>

這里面主要就是事務(wù)管理器和數(shù)據(jù)庫(kù)連接池兩部分的內(nèi)容。

另外我們看到有一個(gè)SqlSessionFactory，使用過(guò)MyBatis的朋友們一定對(duì)這個(gè)類不陌生，它是用于配置MyBatis環(huán)境的，SqlSessionFactory里面有兩個(gè)屬性configLocation、mapperLocations，顧名思義分別代表配置文件的位置和映射文件的位置，這里只要路徑配置正確，Spring便會(huì)自動(dòng)去加載這兩個(gè)配置文件了。

然后要修改的是Dao的實(shí)現(xiàn)類，此時(shí)不再繼承之前的MyBatisUtil這個(gè)類，而是繼承MyBatis-Spring-1.x.0.jar自帶的SqlSessionDaoSupport.java，具體代碼如下：

@Repository
public class StudentDaoImpl extends SqlSessionDaoSupport implements StudentDao
{
private static final String NAMESPACE = "StudentMapper.";
@Resource
public void setSqlSessionFactory(SqlSessionFactory sqlSessionFactory)
{
super.setSqlSessionFactory(sqlSessionFactory);
}
public List<Student> selectAllStudents()
{
return getSqlSession().selectList(NAMESPACE + "selectAllStudents");
}
public int insertStudent(Student student)
{
return getSqlSession().insert(NAMESPACE + "insertStudent", student);
}
}

這里用到了兩個(gè)注解，分別說(shuō)一下。

（1）@Repository，這個(gè)注解和@Component、@Controller和我們最常見(jiàn)的@Service注解是一個(gè)作用，都可以將一個(gè)類聲明為一個(gè)Spring的Bean。它們的區(qū)別到不在于具體的語(yǔ)義上，更多的是在于注解的定位上。之前說(shuō)過(guò)，企業(yè)級(jí)應(yīng)用注重分層開(kāi)發(fā)的概念，因此，對(duì)這四個(gè)相似的注解應(yīng)當(dāng)有以下的理解：

•@Repository注解，對(duì)應(yīng)的是持久層即Dao層，其作用是直接和數(shù)據(jù)庫(kù)交互，通常來(lái)說(shuō)一個(gè)方法對(duì)應(yīng)一條具體的Sql語(yǔ)句
•@Service注解，對(duì)應(yīng)的是服務(wù)層即Service層，其作用是對(duì)單條/多條Sql語(yǔ)句進(jìn)行組合處理，當(dāng)然如果簡(jiǎn)單的話就直接調(diào)用Dao層的某個(gè)方法了
•@Controller注解，對(duì)應(yīng)的是控制層即MVC設(shè)計(jì)模式中的控制層，其作用是接收用戶請(qǐng)求，根據(jù)請(qǐng)求調(diào)用不同的Service取數(shù)據(jù)，并根據(jù)需求對(duì)數(shù)據(jù)進(jìn)行組合、包裝返回給前端
•@Component注解，這個(gè)更多對(duì)應(yīng)的是一個(gè)組件的概念，如果一個(gè)Bean不知道屬于拿個(gè)層，可以使用@Component注解標(biāo)注

這也體現(xiàn)了注解的其中一個(gè)優(yōu)點(diǎn)：見(jiàn)名知意，即看到這個(gè)注解就大致知道這個(gè)類的作用即它在整個(gè)項(xiàng)目中的定位。

（2）@Resource，這個(gè)注解和@Autowired注解是一個(gè)意思，都可以自動(dòng)注入屬性屬性。由于SqlSessionFactory是MyBatis的核心，它在spring.xml中又進(jìn)行過(guò)了聲明，因此這里通過(guò)@Resource注解將id為"sqlSessionFactory"的Bean給注入進(jìn)來(lái)，之后就可以通過(guò)getSqlSession()方法獲取到SqlSession并進(jìn)行數(shù)據(jù)的增、刪、改、查了。

最后無(wú)非就是寫一個(gè)測(cè)試類測(cè)試一下：

public class StudentTest
{
public static void main(String[] args)
{
ApplicationContext ac = new ClassPathXmlApplicationContext("spring.xml");
StudentDao studentDao = (StudentDao)ac.getBean("studentDaoImpl");
Student student = new Student();
student.setStudentName("Lucy");
int j = studentDao.insertStudent(student);
System.out.println("j = " + j + "\n");
System.out.println("-----Display students------");
List<Student> studentList = studentDao.selectAllStudents();
for (int i = 0, length = studentList.size(); i < length; i++)
System.out.println(studentList.get(i));
}
}

由于StudentDaoImpl.java類使用了@Repository注解且沒(méi)有指定別名，因此StudentDaoImpl.java在Spring容器中的名字為"首字母小寫+剩余字母"即"studentDaoImpl"。

運(yùn)行一下程序，可以看見(jiàn)控制臺(tái)上遍歷出了new出來(lái)的Student，即該Student直接被插入了數(shù)據(jù)庫(kù)中，整個(gè)過(guò)程中沒(méi)有任何的commit、rollback，全部都是由Spring幫助我們實(shí)現(xiàn)的，這就是利用Spring對(duì)MyBatis進(jìn)行事物管理。

后記

本文復(fù)習(xí)了MyBatis的基本使用與使用Spring對(duì)MyBatis進(jìn)行事物管理，給出了比較詳細(xì)的代碼例子，有需要的朋友們可以照著代碼研究一下。在本文的基礎(chǔ)上，后面還會(huì)寫一篇文章，講解一下多數(shù)據(jù)在單表和多表之間的事物管理實(shí)現(xiàn)，這種需求也是屬于企業(yè)及應(yīng)用中比較常見(jiàn)的需求。

您可能感興趣的文章: