欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

详解Java的MyBatis框架和Spring框架的整合运用

程序员文章站 2024-03-12 14:27:56
单独使用mybatis是有很多限制的(比如无法实现跨越多个session的事务),而且很多业务系统本来就是使用spring来管理的事务,因此mybatis最好与spring...

单独使用mybatis是有很多限制的(比如无法实现跨越多个session的事务),而且很多业务系统本来就是使用spring来管理的事务,因此mybatis最好与spring集成起来使用。

版本要求

项目

版本

下载地址

说明

mybatis

3.0及以上

https://github.com/mybatis/mybatis-3/releases

 

spring

3.0及以上

http://projects.spring.io/spring-framework/

 

mybatis-spring

1.0及以上

https://github.com/mybatis/spring/releases

 


spring事务配置
<!-- 自动扫描业务包 --> 
<context:component-scan base-package="com.xxx.service" /> 
 
<!-- 数据源 --> 
<jee:jndi-lookup id="jndidatasource" jndi-name="java:comp/env/jdbc/datasource" /> 
 
<!-- 配置事务 --> 
<bean id="txmanager" 
    class="org.springframework.jdbc.datasource.datasourcetransactionmanager"> 
  <property name="datasource" ref="jndidatasource" /> 
</bean> 
<!-- 配置基于注解的事物aop --> 
<tx:annotation-driven transaction-manager="txmanager" proxy-target-class="true"/> 

单个集成

<!-- 集成mybatis --> 
<bean id="sqlsessionfactory" class="org.mybatis.spring.sqlsessionfactorybean"> 
  <property name="datasource" ref="jndidatasource" /> 
  <property name="configlocation" value="classpath:/mybatis/mybatis-config.xml" /> 
  <!-- 自动配置别名 --> 
  <property name="typealiasespackage" value="com.xxx.dto" /> 
</bean> 
 
<!--创建dao bean(只需提供接口不需提供实现类 )--> 
<bean id="userdao" class="org.mybatis.spring.mapper.mapperfactorybean"> 
  <property name="mapperinterface" value="com.xxx.dao.userdao" /> 
  <property name="sqlsessionfactory" ref="sqlsessionfactory" /> 
</bean> 

我们不但要明白如何使用,更要明白为什么要这么使用。

sqlsessionfactorybean是一个工厂bean,它的作用就是解析配置(数据源、别名等)。

mapperfactorybean是一个工厂bean,在spring容器里,工厂bean是有特殊用途的,当spring将工厂bean注入到其他bean里时,它不是注入工厂bean本身而是调用bean的getobject方法。我们接下来就看看这个getobjec方法干了些什么:

public t getobject() throws exception { 
 return getsqlsession().getmapper(this.mapperinterface); 
} 

看到这里大家应该就很明白了,这个方法和我们之前单独使用mybatis的方式是一样的,都是先获取一个sqlsession对象,然后再从sqlsession里获取mapper对象(再次强调mapper是一个代理对象,它代理的是mapperinterface接口,而这个接口是用户提供的dao接口)。自然,最终注入到业务层就是这个mapper对象。

实际的项目一般来说不止一个dao,如果你有多个dao那就按照上面的配置依次配置即可。

如何使用批量更新
前一节讲了如何注入一个mapper对象到业务层, mapper的行为依赖于配置,mybatis默认使用单个更新(即executortype默认为simple而不是batch),当然我们可以通过修改mybatis配置文件来修改默认行为,但如果我们只想让某个或某几个mapper使用批量更新就不得行了。这个时候我们就需要使用模板技术:

<!--通过模板定制mybatis的行为 --> 
lt;bean id="sqlsessiontemplatesimple" class="org.mybatis.spring.sqlsessiontemplate">   
<constructor-arg index="0" ref="sqlsessionfactory" /> 
<!--更新采用单个模式 --> 
<constructor-arg index="1" value="simple"/> 
</bean> 
   
<!--通过模板定制mybatis的行为 --> 
lt;bean id="sqlsessiontemplatebatch" class="org.mybatis.spring.sqlsessiontemplate">   
<constructor-arg index="0" ref="sqlsessionfactory" /> 
<!--更新采用批量模式 --> 
<constructor-arg index="1" value="batch"/> 
</bean> 

这里笔者定义了两个模板对象,一个使用单个更新,一个使用批量更新。有了模板之后我们就可以改变mapper的行为方式了:

<bean id="userdao" class="org.mybatis.spring.mapper.mapperfactorybean"> 
  <property name="mapperinterface" value="com.xxx.dao.userdao" /> 
  <property name="sqlsessiontemplate" ref=" sqlsessiontemplatebatch " /> 
</bean> 

 
跟上一节的mapper配置不同的是,这里不需要配置sqlsessionfactory属性,只需要配置sqlsessiontemplate(sqlsessionfactory属性在模板里已经配置好了)。

通过自动扫描简化mapper的配置
前面的章节可以看到,我们的dao需要一个一个的配置在配置文件中,如果有很多个dao的话配置文件就会非常大,这样管理起来就会比较痛苦。幸好mybatis团队也意识到了这点,他们利用spring提供的自动扫描功能封装了一个自动扫描dao的工具类,这样我们就可以使用这个功能简化配置:

<!-- 采用自动扫描方式创建mapper bean(单个更新模式) --> 
<bean class="org.mybatis.spring.mapper.mapperscannerconfigurer"> 
  <property name="basepackage" value="com.xxx.dao" /> 
  <property name="sqlsessiontemplatebeanname" value="sqlsessiontemplatesimple" /> 
  <property name="markerinterface" value="com.xxx.dao.simpledao" /> 
</bean> 
    
<!-- 采用自动扫描方式创建mapper bean(批量更新模式) --> 
<bean class="org.mybatis.spring.mapper.mapperscannerconfigurer"> 
  <property name="basepackage" value="com.xxx.dao" /> 
  <property name="sqlsessiontemplatebeanname" value="sqlsessiontemplatebatch" /> 
  <property name="markerinterface" value="com.xxx.dao.batchdao" /> 
</bean> 

mapperscannerconfigurer本身涉及的spring的技术我就不多讲了,感兴趣且对spring原理比较了解的可以去看下它的源码。我们重点看一下它的三个属性:

  • basepackage:扫描器开始扫描的基础包名,支持嵌套扫描;
  • sqlsessiontemplatebeanname:前文提到的模板bean的名称;
  • markerinterface:基于接口的过滤器,实现了该接口的dao才会被扫描器扫描,与basepackage是与的作用。

除了使用接口过滤外,还可使用注解过滤:

<!-- 采用自动扫描方式创建mapper bean(批量更新模式) --> 
<bean class="org.mybatis.spring.mapper.mapperscannerconfigurer"> 
  <property name="basepackage" value="com.xxx.dao" /> 
  <property name="sqlsessiontemplatebeanname" value="sqlsessiontemplatebatch" /> 
  <property name="annotationclass" value="com.xxx.dao.batchannotation" /> 
</bean> 

annotationclass:配置了该注解的dao才会被扫描器扫描,与basepackage是与的作用。

需要注意的是,两个过滤条件只能配一个。

实例:事务管理
定义一个实体类:emp.java

package com.lixing.scm.entity;

public class emp {
 private string id;
 private string name;
 private string sex;
 private int age;
 private string phone;
 public string getid() {
  return id;
 }
 public void setid(string id) {
  this.id = id;
 }
 public string getname() {
  return name;
 }
 public void setname(string name) {
  this.name = name;
 }
 public string getsex() {
  return sex;
 }
 public void setsex(string sex) {
  this.sex = sex;
 }
 public int getage() {
  return age;
 }
 public void setage(int age) {
  this.age = age;
 }
 public string getphone() {
  return phone;
 }
 public void setphone(string phone) {
  this.phone = phone;
 }
}

定义实体内操作接口:empmapper.java

package com.lixing.scm.test.mapper;

import java.util.list;
import java.util.map;

import com.lixing.scm.entity.emp;

public interface empmapper {
 void insertemp(emp emp);
 list<emp> getallemp();
 emp getbyid(string id);
 void deleteemp(string id);
 void updateemp(map<string,object> map);
}

定义实体类操作接口的映射文件:empmapper.xml

<?xml version="1.0" encoding="utf-8" ?> 
<!doctype mapper    public "-//mybatis.org//dtd mapper 3.0//en"    
    "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> 
<mapper namespace="com.lixing.scm.test.mapper.empmapper"> 
 <parametermap type="com.lixing.scm.entity.emp" id="parametermapemp">
  <parameter property="id"/>
  <parameter property="name"/>
  <parameter property="sex"/>
  <parameter property="age"/>
  <parameter property="phone"/>
 </parametermap>
 
 <resultmap type="com.lixing.scm.entity.emp" id="resultmapemp">
  <result property="id" column="id"/>
  <result property="name" column="name"/>
  <result property="sex" column="sex"/>
  <result property="age" column="age"/>
  <result property="phone" column="phone"/>
 </resultmap>
 
 <insert id="insertemp" parametermap="parametermapemp">
  insert into emp(id,name,sex,age,phone)
  values(?,?,?,?,?)
 </insert>
 <select id="getallemp"  resultmap="resultmapemp">
  select * from emp
 </select>
 <select id="getbyid" parametertype="string" resultmap="resultmapemp">
  select * from emp
  where id=#{value}
 </select>
 <delete id="deleteemp" parametertype="string">
  delete from emp 
  where id=#{value}
 </delete>
 <update id="updateemp" parametertype="java.util.map">
  update emp
  set name=#{name},sex=#{sex},age=#{age},phone=#{phone}
  where id=#{id}
 </update>
</mapper>
spring3.0.6定义:applicationcontext.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: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/context
     http://www.springframework.org/schema/context/spring-context-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/aop 
     http://www.springframework.org/schema/aop/spring-aop-3.0.xsd">

 <!--  -->
 <context:annotation-config />
 <context:component-scan base-package="com.lixing.scm.test.*" />


 <!-- jdbc.propertis directory -->
 <bean
  class="org.springframework.beans.factory.config.propertyplaceholderconfigurer">
  <property name="locations" value="classpath:jdbc.properties" />
 </bean>

 <bean id="mydatasource" destroy-method="close"
  class="org.apache.commons.dbcp.basicdatasource">
  <property name="driverclassname" value="${jdbc.driverclassname}" />
  <property name="url" value="${jdbc.url}" />
  <property name="username" value="${jdbc.username}" />
  <property name="password" value="${jdbc.password}" />
 </bean>

 <!-- sqlsessionfactory -->
 <bean id="sqlsessionfactory" class="org.mybatis.spring.sqlsessionfactorybean">
  <property name="datasource" ref="mydatasource" />
 </bean>
 <!-- scanmapperfiles -->
 <bean class="org.mybatis.spring.mapper.mapperscannerconfigurer">
  <property name="basepackage" value="com.lixing.scm.test.mapper" />
 </bean>



 <!-- ================================事务相关控制=================================================  -->
 <bean name="transactionmanager" class="org.springframework.jdbc.datasource.datasourcetransactionmanager">   
     <property name="datasource" ref="mydatasource"></property>
  </bean>   
 
 <tx:advice id="usertxadvice" transaction-manager="transactionmanager">
  <tx:attributes>
   <tx:method name="delete*" propagation="required" read-only="false" 
              rollback-for="java.lang.exception" no-rollback-for="java.lang.runtimeexception"/>
   <tx:method name="insert*" propagation="required" read-only="false" 
              rollback-for="java.lang.runtimeexception" />
   <tx:method name="update*" propagation="required" read-only="false" 
              rollback-for="java.lang.exception" />
   
   <tx:method name="find*" propagation="supports"/>
   <tx:method name="get*" propagation="supports"/>
   <tx:method name="select*" propagation="supports"/>
  </tx:attributes>
 </tx:advice>
 
 <aop:config>  
  <aop:pointcut id="pc" expression="execution(public * com.lixing.scm.test.service.*.*(..))" /> <!--把事务控制在service层-->
  <aop:advisor pointcut-ref="pc" advice-ref="usertxadvice" />
 </aop:config>
 
 
 <!-- 以下为自定义bean-->
 <bean id="empdao" class="com.lixing.scm.test.dao.impl.empdaoimpl"
  autowire="byname" /> 
 <bean id="empservice" class="com.lixing.scm.test.service.impl.empserviceimpl"  autowire="byname"/>
</beans>

dao接口:empdao.java

package com.lixing.scm.test.dao;

import java.util.list;
import java.util.map;

import com.lixing.scm.entity.emp;

public interface empdao {
 void insertemp(emp emp);
 list<emp> getallemp();
 emp getbyid(string id);
 void deleteemp(string id);
 void updateemp(map<string, object> map);
}

dao接口实现类:empdaoimpl.java

package com.lixing.scm.test.dao.impl;

import java.util.list;
import java.util.map;

import com.lixing.scm.entity.emp;
import com.lixing.scm.test.dao.empdao;
import com.lixing.scm.test.mapper.empmapper;

public class empdaoimpl implements empdao {
 private empmapper empmapper;  //在此处注入一个empmapper
   //这个empmapper由 spring自动生成   //不需要我们自己手工去定义
 @override
 public void insertemp(emp emp) {
  this.empmapper.insertemp(emp);
  throw new runtimeexception("error");  //测试抛出runtimeexception    //异常查看数据库是否存在记录
 }

 @override
 public void deleteemp(string id) {
  this.empmapper.deleteemp(id);
 }

 @override
 public list<emp> getallemp() {
  return this.empmapper.getallemp();
 }

 @override
 public emp getbyid(string id) {
  return this.empmapper.getbyid(id);
 }

 @override
 public void updateemp(map<string, object> map) {
  this.empmapper.updateemp(map);
 }

 
 public empmapper getempmapper() {
  return empmapper;
 }

 public void setempmapper(empmapper empmapper) {
  this.empmapper = empmapper;
 }
}

service层接口:empservice.java

package com.lixing.scm.test.service;

import com.lixing.scm.entity.emp;

public interface empservice {
 void insertemp(emp emp);
}

service层接口实现类:empserviceimpl.java

package com.lixing.scm.test.service.impl;

import com.lixing.scm.entity.emp;
import com.lixing.scm.test.dao.empdao;
import com.lixing.scm.test.service.empservice;

public class empserviceimpl implements empservice {
 private empdao empdao;

 @override
 public void insertemp(emp emp) {
  empdao.insertemp(emp);

 }

 public empdao getempdao() {
  return empdao;
 }

 public void setempdao(empdao empdao) {
  this.empdao = empdao;
 }
}

测试类:testempservice.java

import org.junit.test;
import org.springframework.context.applicationcontext;
import org.springframework.context.support.classpathxmlapplicationcontext;

import com.lixing.scm.entity.emp;
import com.lixing.scm.test.service.empservice;


public class testempservice {
 @test
 public void testtrasaction(){
  emp emp=new emp();
  emp.setid("00000003");
  emp.setname("某某某");
  emp.setage(50);
  emp.setsex("男");
  emp.setphone("566666");
  
  applicationcontext ctx=new classpathxmlapplicationcontext("classpath:applicationcontext.xml");
  empservice service=ctx.getbean(empservice.class);
  service.insertemp(emp);
 }
}