詳解Java的MyBatis架構和Spring架構的整合運用_java

單獨使用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); }}