首页 > 代码库 > Spring与MyBatis整合

Spring与MyBatis整合

序言

        在MyBatis学习中,我们会发现很多重复性的代码,例如:

//创建连接
 private SqlSessionFactory sqlSessionFactory = SessionFactoryUtils
            .getSessionfactory().getSqlSessionFactory(); 
public void xxx(){ 
//打开连接
sqlSession=sqlSessionFactory.openSession();
//SQL操作开始
//添加
sqlSession.insert("add",user);
//更新
sqlSession.update("User.updateById",id);
//删除
sqlSession.delete("User.deleteById",id);
//SQL操作结束

//提交数据库更新
sqlSession.commit();
//关闭连接
sqlSession.close();
}

        通过代码我们可以看到,创建连接、打开连接、提交数据库更新、关闭连接这些代码大量的重复。

        能不能把这些重复的操作通过Spring管理起来,让开发人员只关注具体的业务操作呢?

        答案是肯定的。

        通过将Spring 和Mybatis做整合即可。

        整合后的代码如下所示:

 @Autowired
 private SqlSessionTemplate sqlSessionTemplate;

 public void xxx(){
    //添加
    sqlSessionTemplate.insert("add",user);
    //更新
    sqlSessionTemplate.update("User.updateById",id);
    //删除
    sqlSessionTemplate.delete("User.deleteById",id);  
 }

        很明显,整合后的代码更加的简洁、高效。

        Spring与MyBatis整合的方式有很多种,本文讲述的是使用最简单的一种,使用SqlSessionTemplate整合。

        SqlSessionTemplate是接口org.apache.ibatis.session.SqlSession的实现类,全名是org.mybatis.spring.SqlSessionTemplate。Mybatis的连接可以由它来进行统一的管理。

一、Spring与MyBatis整合的步骤

(1)导入Jar包

        需要导入的Jar包有:

        mybatis-spring-1.2.2.jar

        commons-pool-1.6.jar
        commons-dbcp-1.4.jar
        commons-collections-3.2.jar

        aspectjweaver-1.8.1.jar

        完整的pom.xml内容如下所示:

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
 <modelVersion>4.0.0</modelVersion>
 <groupId>SpringAndMyBatis</groupId>
 <artifactId>Integeration</artifactId>
 <packaging>war</packaging>
 <version>0.0.1-SNAPSHOT</version>
 <name>Integeration Maven Webapp</name>
 <url>http://maven.apache.org</url>
 <dependencies>
  <dependency>
   <groupId>org.mybatis</groupId>
   <artifactId>mybatis</artifactId>
   <version>3.2.7</version>
  </dependency>
  <dependency>
   <groupId>mysql</groupId>
   <artifactId>mysql-connector-java</artifactId>
   <version>5.1.31</version>
  </dependency>
  <dependency>
   <groupId>org.springframework</groupId>
   <artifactId>spring-core</artifactId>
   <version>3.0.5.RELEASE</version>
  </dependency>
  <dependency>
   <groupId>org.springframework</groupId>
   <artifactId>spring-context</artifactId>
   <version>3.0.5.RELEASE</version>
  </dependency>
  <dependency>
   <groupId>org.springframework</groupId>
   <artifactId>spring-context-support</artifactId>
   <version>3.0.5.RELEASE</version>
  </dependency>
  <dependency>
   <groupId>org.springframework</groupId>
   <artifactId>spring-aop</artifactId>
   <version>3.0.5.RELEASE</version>
  </dependency>
  <dependency>
   <groupId>org.springframework</groupId>
   <artifactId>spring-tx</artifactId>
   <version>3.0.5.RELEASE</version>
  </dependency>
  <dependency>
   <groupId>org.springframework</groupId>
   <artifactId>spring-asm</artifactId>
   <version>3.0.5.RELEASE</version>
  </dependency>
  <dependency>
   <groupId>org.springframework</groupId>
   <artifactId>spring-beans</artifactId>
   <version>3.0.5.RELEASE</version>
  </dependency>
  <!-- end spring 核心依赖包 -->
  <!-- start spring mvc -->
  <dependency>
   <groupId>org.springframework</groupId>
   <artifactId>spring-web</artifactId>
   <version>3.0.5.RELEASE</version>
  </dependency>
  <dependency>
   <groupId>org.springframework</groupId>
   <artifactId>spring-webmvc</artifactId>
   <version>3.0.5.RELEASE</version>
  </dependency>
  <dependency>
   <groupId>javax.servlet</groupId>
   <artifactId>jstl</artifactId>
   <version>1.2</version>
  </dependency>
  <!-- START SERVLET -->
  <dependency>
   <groupId>javax.servlet</groupId>
   <artifactId>servlet-api</artifactId>
   <version>2.5</version>
   <scope>provided</scope>
  </dependency>
  <dependency>
   <groupId>javax.servlet.jsp</groupId>
   <artifactId>jsp-api</artifactId>
   <version>2.1</version>
   <scope>provided</scope>
  </dependency>
  <dependency>
   <groupId>org.aspectj</groupId>
   <artifactId>aspectjweaver</artifactId>
   <version>1.8.1</version>
  </dependency>

<dependency>
 <groupId>org.springframework</groupId>
 <artifactId>spring-jdbc</artifactId>
 <version>3.0.5.RELEASE</version>
</dependency>
  <dependency>
   <groupId>org.mybatis</groupId>
   <artifactId>mybatis-spring</artifactId>
   <version>1.2.2</version>
  </dependency>
  <dependency>
   <groupId>org.springframework</groupId>
   <artifactId>spring-test</artifactId>
   <version>3.0.5.RELEASE</version>
  </dependency>
  <dependency>
   <groupId>commons-pool</groupId>
   <artifactId>commons-pool</artifactId>
   <version>1.6</version>
  </dependency>
  <dependency>
   <groupId>commons-dbcp</groupId>
   <artifactId>commons-dbcp</artifactId>
   <version>1.4</version>
  </dependency>
  <dependency>
   <groupId>commons-collections</groupId>
   <artifactId>commons-collections</artifactId>
   <version>3.2</version>
  </dependency>
 </dependencies>
 <build>
  <finalName>Integeration</finalName>
  <sourceDirectory>src/main/java</sourceDirectory>
  <testSourceDirectory>src/test/java</testSourceDirectory>
  <resources>
   <resource>
    <directory>src/main/java</directory>
   </resource>
  </resources>
  <testResources>
   <testResource>
    <directory>src/test/java</directory>
   </testResource>
  </testResources>
 </build>
</project>

(2)迁移mybatis主配置文件中的配置至Spring配置文件

        由于需要Spring来管理MyBatis的连接,因此,与连接有关的配置需要从Mybatis迁移至Spring配置文件。

        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>
 <typeAliases>
  <typeAlias alias="user" type="com.uni2uni.model.User"/>
 </typeAliases>
 <mappers>
  <mapper resource="com/uni2uni/model/sqlmapper/user.xml" />
 </mappers>
</configuration>

(3)在Spring配置文件中配置SqlSessionTemplate的Bean

        Spring的配置关键代码如下所示:

 <!-- 配置mybitasSqlSessionFactoryBean -->
 <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
  <property name="dataSource" ref="dataSource" />
  <property name="configLocation" value=http://www.mamicode.com/"classpath:mybatis.xml">> 

        Spring配置文件完整如下所示:

<?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:context="http://www.springframework.org/schema/context"
 xmlns:aop="http://www.springframework.org/schema/aop"
 xmlns:tx="http://www.springframework.org/schema/tx"
 xsi:schemaLocation="http://www.springframework.org/schema/beans
           http://www.springframework.org/schema/beans/spring-beans-3.0.xsd
           http://www.springframework.org/schema/aop 
           http://www.springframework.org/schema/aop/spring-aop-3.0.xsd
           http://www.springframework.org/schema/tx
         http://www.springframework.org/schema/tx/spring-tx-3.0.xsd
           http://www.springframework.org/schema/context
           http://www.springframework.org/schema/context/spring-context-3.0.xsd">
 
 <!-- 采用注释的方式配置bean -->
 <context:annotation-config />
 <!-- 配置要扫描的包 -->
 <context:component-scan base-package="com.uni2uni.*"></context:component-scan>
 
 <!--proxy-target-class="true"强制使用cglib代理   如果为false则spring会自动选择-->
 <aop:aspectj-autoproxy  proxy-target-class="true"/>
 
 <!-- 数据库配置文件位置 -->
 <context:property-placeholder location="classpath:jdbc.properties" />
 
 <!-- 配置dbcp数据源 -->
 <bean id="dataSource" class="org.apache.commons.dbcp.BasicDataSource" destroy-method="close">
  <property name="driverClassName" value=http://www.mamicode.com/"${jdbc.driverClassName}" />> 

        jdbc.properties中的代码如下所示:

jdbc.driverClassName=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/ibatisdatabase
jdbc.username=root
jdbc.password=root
jdbc.maxActive=2
jdbc.maxIdle=5
jdbc.minIdle=1
jdbc.initialSize=3
jdbc.maxWait=3000

(4)编写数据库实现类

        数据库的实现类关键代码如下所示:

@Repository
public class UserDaoImpl implements UserDao {
 @Autowired
 private SqlSessionTemplate sqlSessionTemplate;

 public void add(User user) {
  sqlSessionTemplate.insert("add", user);
 }
}

(5)Demo下载

        本例中完整Demo下载:http://pan.baidu.com/s/1pJuNnJH

        单元测试类在/src/test/java/UserDaoUnit.java类中。

二、知识扩展

(1)Spring与MyBatis整合方式。

        Spring与MyBatis整合常用的有三种方式:SqlSessionTemplate、SqlSessionDaoSupport、MapperFactoryBean(数据映射器)。

        本文采用的是SqlSessionTemplate方式,也是相比其它两种更简单的方式。

        SqlSessionDaoSupport是一个抽象类,全名为org.mybatis.spring.support.SqlSessionDaoSupport。使用中需要在实现类中继承它。

        采用MapperFactoryBean(数据映射器)的方式,不用写mybatis映射文件,采用注解方式提供相应的sql语句和输入参数。