單獨使用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事務配置
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
<!-- 自動掃描業務包 --><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"/> |
單個集成
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
<!-- 集成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方法干了些什么：
|
1
2
3
|
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使用批量更新就不得行了。這個時候我們就需要使用模板技術：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
<!--通過模板定制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的行為方式了：
|
1
2
3
4
|
<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的工具類，這樣我們就可以使用這個功能簡化配置：
|
1
2
3
4
5
6
7
8
9
10
11
12
13
|
<!-- 采用自動掃描方式創建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是與的作用。
除了使用接口過濾外，還可使用注解過濾：
|
1
2
3
4
5
6
|
<!-- 采用自動掃描方式創建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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
|
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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
|
<?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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
|
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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
|
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
|
1
2
3
4
5
6
7
|
package com.lixing.scm.test.service;import com.lixing.scm.entity.Emp;public interface EmpService { void insertEmp(Emp emp);} |
Service層接口實現類:EmpServiceImpl.java
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
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
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
|
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); }} |
