[转]Mybatis3.x与Spring4.x整合
Posted
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了[转]Mybatis3.x与Spring4.x整合相关的知识，希望对你有一定的参考价值。
原文地址:http://www.cnblogs.com/xdp-gacl/p/4271627.html
一、搭建开发环境
1.1、使用Maven创建Web项目
执行如下命令：
mvn archetype:create -DgroupId=me.gacl -DartifactId=spring4-mybatis3 -DarchetypeArtifactId=maven-archetype-webapp -DinteractiveMode=false
如下图所示：
创建好的项目如下：
编辑pom.xml文件
1 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
3 <modelVersion>4.0.0</modelVersion>
4 <groupId>me.gacl</groupId>
5 <artifactId>spring4-mybatis3</artifactId>
6 <packaging>war</packaging>
7 <version>1.0-SNAPSHOT</version>
8 <name>spring4-mybatis3 Maven Webapp</name>
9 <url>http://maven.apache.org</url>
10 <dependencies>
11 <dependency>
12 <groupId>junit</groupId>
13 <artifactId>junit</artifactId>
14 <version>3.8.1</version>
15 <scope>test</scope>
16 </dependency>
17 </dependencies>
18 <build>
19 <finalName>spring4-mybatis3</finalName>
20 </build>
21 </project>
修改 <name>spring4-mybatis3 Maven Webapp</name> 部分，把" Maven Webapp"这部分包含空格的内容去掉，否则Maven在编译项目时会因为空格的原因导致一些莫名其妙的错误出现，修改成： <name>spring4-mybatis3</name> 。
另外，把以下内容删掉：
1 <dependency>
2 <groupId>junit</groupId>
3 <artifactId>junit</artifactId>
4 <version>3.8.1</version>
5 <scope>test</scope>
6 </dependency>
这部分是junit的jar包依赖信息，这个版本太低了，我们不使用这个Junit测试版本，修改过后的pom.xml内容如下：
1 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
3 <modelVersion>4.0.0</modelVersion>
4 <groupId>me.gacl</groupId>
5 <artifactId>spring4-mybatis3</artifactId>
6 <packaging>war</packaging>
7 <version>1.0-SNAPSHOT</version>
8 <name>spring4-mybatis3</name>
9 <url>http://maven.apache.org</url>
10 <dependencies>
11
12 </dependencies>
13 <build>
14 <finalName>spring4-mybatis3</finalName>
15 </build>
16 </project>
1.2、将创建好的项目导入MyEclipse中
具体操作步骤如下图所示：
手动创建【src/main/java】、【src/test/resources】、【src/test/java】这三个source folder，如下图所示：
到此，项目搭建的工作就算是全部完成了。
二、创建数据库和表(针对mysql)
SQL脚本如下：
Create DATABASE spring4_mybatis3;
USE spring4_mybatis3;
DROP TABLE IF EXISTS t_user;
CREATE TABLE t_user (
user_id char(32) NOT NULL,
user_name varchar(30) DEFAULT NULL,
user_birthday date DEFAULT NULL,
user_salary double DEFAULT NULL,
PRIMARY KEY (user_id)
) ENGINE=InnoDB DEFAULT CHARSET=utf8;
创建好的数据库和表如下：
三、使用generator工具生成代码
在网上找到了一个generator工具可以根据创建好的数据库表生成MyBatis的表对应的实体类，SQL映射文件和dao，找到generator工具根目录下的generator.xml文件，这个文件是用来配置代码生成规则的，如下图所示：
编辑generator.xml文件，内容如下：
1 <?xml version="1.0" encoding="UTF-8"?>
2 <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
3 <generatorConfiguration>
4 <!-- 数据库驱动包位置 -->
5 <classPathEntry location="E:\\repository\\mysql\\mysql-connector-java\\5.1.34\\mysql-connector-java-5.1.34.jar" />
6 <!-- <classPathEntry location="C:\\oracle\\product\\10.2.0\\db_1\\jdbc\\lib\\ojdbc14.jar" />-->
7 <context id="DB2Tables" targetRuntime="MyBatis3">
8 <commentGenerator>
9 <property name="suppressAllComments" value="true" />
10 </commentGenerator>
11 <!-- 数据库链接URL、用户名、密码 -->
12 <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/spring4_mybatis3" userId="root" password="XDP">
13 <!--<jdbcConnection driverClass="oracle.jdbc.driver.OracleDriver" connectionURL="jdbc:oracle:thin:@localhost:1521:orcl" userId="msa" password="msa">-->
14 </jdbcConnection>
15 <javaTypeResolver>
16 <property name="forceBigDecimals" value="false" />
17 </javaTypeResolver>
18 <!-- 生成实体类的包名和位置，这里配置将生成的实体类放在me.gacl.domain这个包下 -->
19 <javaModelGenerator targetPackage="me.gacl.domain" targetProject="C:\\Users\\gacl\\spring4-mybatis3\\src\\main\\java">
20 <property name="enableSubPackages" value="true" />
21 <property name="trimStrings" value="true" />
22 </javaModelGenerator>
23 <!-- 生成的SQL映射文件包名和位置，这里配置将生成的SQL映射文件放在me.gacl.mapping这个包下 -->
24 <sqlMapGenerator targetPackage="me.gacl.mapping" targetProject="C:\\Users\\gacl\\spring4-mybatis3\\src\\main\\java">
25 <property name="enableSubPackages" value="true" />
26 </sqlMapGenerator>
27 <!-- 生成DAO的包名和位置，这里配置将生成的dao类放在me.gacl.dao这个包下 -->
28 <javaClientGenerator type="XMLMAPPER" targetPackage="me.gacl.dao" targetProject="C:\\Users\\gacl\\spring4-mybatis3\\src\\main\\java">
29 <property name="enableSubPackages" value="true" />
30 </javaClientGenerator>
31 <!-- 要生成那些表(更改tableName和domainObjectName就可以) -->
32 <table tableName="t_user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false" />
33 </context>
34 </generatorConfiguration>
打开命令行窗口，切换到生成工具的根目录下，执行如下命令：
java -jar mybatis-generator-core-1.3.2.jar -configfile generator.xml -overwrite
如下图所示：
刚才我们在generator.xml文件中配置将生成的代码和SQL映射文件放到"C:\\Users\\gacl\\spring4- mybatis3\\src\\main\\java"这个目录下，这个目录就是我们的spring4-mybatis3项目所在目录，我们刷新一下 src/main/java目录，就可以看到生成的代码和映射文件了，如下图所示：
生成的代码和映射文件一行都不用改，可以直接应用到项目当中。下面我们看一眼由generator工具生成的代码和映射文件：
1、生成的dao类
1 package me.gacl.dao;
2
3 import me.gacl.domain.User;
4
5 public interface UserMapper {
6 int deleteByPrimaryKey(String userId);
7
8 int insert(User record);
9
10 int insertSelective(User record);
11
12 User selectByPrimaryKey(String userId);
13
14 int updateByPrimaryKeySelective(User record);
15
16 int updateByPrimaryKey(User record);
17 }
生成的UserMapper是一个接口，里面定义了一些操作t_user表的增删改查方法。
2、生成的实体类
1 package me.gacl.domain;
2
3 import java.util.Date;
4
5 public class User {
6 private String userId;
7
8 private String userName;
9
10 private Date userBirthday;
11
12 private Double userSalary;
13
14 public String getUserId() {
15 return userId;
16 }
17
18 public void setUserId(String userId) {
19 this.userId = userId == null ? null : userId.trim();
20 }
21
22 public String getUserName() {
23 return userName;
24 }
25
26 public void setUserName(String userName) {
27 this.userName = userName == null ? null : userName.trim();
28 }
29
30 public Date getUserBirthday() {
31 return userBirthday;
32 }
33
34 public void setUserBirthday(Date userBirthday) {
35 this.userBirthday = userBirthday;
36 }
37
38 public Double getUserSalary() {
39 return userSalary;
40 }
41
42 public void setUserSalary(Double userSalary) {
43 this.userSalary = userSalary;
44 }
45 }
User类是t_user表的对应的实体类，User类中定义的属性和t_user表中的字段一一对应。
3、生成的SQL映射文件
1 <?xml version="1.0" encoding="UTF-8" ?>
2 <!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd" >
3 <mapper namespace="me.gacl.dao.UserMapper" >
4 <resultMap id="BaseResultMap" type="me.gacl.domain.User" >
5 <id column="user_id" property="userId" jdbcType="CHAR" />
6 <result column="user_name" property="userName" jdbcType="VARCHAR" />
7 <result column="user_birthday" property="userBirthday" jdbcType="DATE" />
8 <result column="user_salary" property="userSalary" jdbcType="DOUBLE" />
9 </resultMap>
10 <sql id="Base_Column_List" >
11 user_id, user_name, user_birthday, user_salary
12 </sql>
13 <select id="selectByPrimaryKey" resultMap="BaseResultMap" parameterType="java.lang.String" >
14 select
15 <include refid="Base_Column_List" />
16 from t_user
17 where user_id = #{userId,jdbcType=CHAR}
18 </select>
19 <delete id="deleteByPrimaryKey" parameterType="java.lang.String" >
20 delete from t_user
21 where user_id = #{userId,jdbcType=CHAR}
22 </delete>
23 <insert id="insert" parameterType="me.gacl.domain.User" >
24 insert into t_user (user_id, user_name, user_birthday,
25 user_salary)
26 values (#{userId,jdbcType=CHAR}, #{userName,jdbcType=VARCHAR}, #{userBirthday,jdbcType=DATE},
27 #{userSalary,jdbcType=DOUBLE})
28 </insert>
29 <insert id="insertSelective" parameterType="me.gacl.domain.User" >
30 insert into t_user
31 <trim prefix="(" suffix=")" suffixOverrides="," >
32 <if test="userId != null" >
33 user_id,
34 </if>
35 <if test="userName != null" >
36 user_name,
37 </if>
38 <if test="userBirthday != null" >
39 user_birthday,
40 </if>
41 <if test="userSalary != null" >
42 user_salary,
43 </if>
44 </trim>
45 <trim prefix="values (" suffix=")" suffixOverrides="," >
46 <if test="userId != null" >
47 #{userId,jdbcType=CHAR},
48 </if>
49 <if test="userName != null" >
50 #{userName,jdbcType=VARCHAR},
51 </if>
52 <if test="userBirthday != null" >
53 #{userBirthday,jdbcType=DATE},
54 </if>
55 <if test="userSalary != null" >
56 #{userSalary,jdbcType=DOUBLE},
57 </if>
58 </trim>
59 </insert>
60 <update id="updateByPrimaryKeySelective" parameterType="me.gacl.domain.User" >
61 update t_user
62 <set >
63 <if test="userName != null" >
64 user_name = #{userName,jdbcType=VARCHAR},
65 </if>
66 <if test="userBirthday != null" >
67 user_birthday = #{userBirthday,jdbcType=DATE},
68 </if>
69 <if test="userSalary != null" >
70 user_salary = #{userSalary,jdbcType=DOUBLE},
71 </if>
72 </set>
73 where user_id = #{userId,jdbcType=CHAR}
74 </update>
75 <update id="updateByPrimaryKey" parameterType="me.gacl.domain.User" >
76 update t_user
77 set user_name = #{userName,jdbcType=VARCHAR},
78 user_birthday = #{userBirthday,jdbcType=DATE},
79 user_salary = #{userSalary,jdbcType=DOUBLE}
80 where user_id = #{userId,jdbcType=CHAR}
81 </update>
82 </mapper>
UserMapper.xml这个文件的内容是编写操作t_user表的SQL语句，重点说一下UserMapper.xml配置中需要注意的几个小细节问题：
1、UserMapper.xml的<mapper>标签的namespace必须是UserMapper接口的全类名，既<mapper namespace="me.gacl.dao.UserMapper" >
2、UserMapper.xml的定义操作数据库的<select><delete><update><insert>这些标签的id属性的值必须和UserMapper接口定义的方法名一致，如下图所示：
之所以有上述说的这两点要求，就是为了能够让MyBatis能够根据UserMapper接口和UserMapper.xml文件去自动实现UserMapper接口中定义的相关方法，这样我们就不再需要针对UserMapper接口去编写具体的实现代码了。
四、Spring与MyBatis整合
首先我们要在项目中加入我们需要的相关jar包，我们可以到Maven的中央仓库：http://search.maven.org/ 找到我们要的相关jar包，如下图所示：
我们只需要在搜索框中输入要找的jar包的名称，点击【SEARCH】按钮，就可以找到我们要的jar包了。
4.1、添加Spring与Mybatis的相关jar包
1、添加spring-core，输入spring-core关键字进行查找，如下图所示：
找到关于spring-core的依赖描述信息，如下图所示：
将
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>4.1.4.RELEASE</version>
</dependency>
复制到项目的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>me.gacl</groupId>
<artifactId>spring4-mybatis3</artifactId>
<packaging>war</packaging>
<version>1.0-SNAPSHOT</version>
<name>spring4-mybatis3</name>
<url>http://maven.apache.org</url>
<dependencies>
<!-- 添加Spring4.1.4的核心包 -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>4.1.4.RELEASE</version>
</dependency>
</dependencies>
<build>
<finalName>spring4-mybatis3</finalName>
</build>
</project>
这样Maven就会自动帮我们从Maven的中央仓库中下载spring-core这个jar包到我们的本地仓库，然后将spring-core这个jar包以及它的相关依赖包加入到我们的项目当中，如下所示：
spring4.x与mybatis3.x所需要的相关jar包都可以采用上述所说的方式进行查找，然后添加到项目当中，添加完spring4.x与mybatis3.x相关jar包后，pom.xml文件内容最终如下：
1 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
2 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd">
3 <modelVersion>4.0.0</modelVersion>
4 <groupId>me.gacl</groupId>
5 <artifactId>spring4-mybatis3</artifactId>
6 <packaging>war</packaging>
7 <version>1.0-SNAPSHOT</version>
8 <name>spring4-mybatis3</name>
9 <url>http://maven.apache.org</url>
10 <dependencies>
11 <!-- 添加Spring-core包 -->
12 <dependency>
13 <groupId>org.springframework</groupId>
14 <artifactId>spring-core</artifactId>
15 <version>4.1.4.RELEASE</version>
16 </dependency>
17 <!-- 添加spring-context包 -->
18 <dependency>
19 <groupId>org.springframework</groupId>
20 <artifactId>spring-context</artifactId>
21 <version>4.1.4.RELEASE</version>
22 </dependency>
23 <!-- 添加spring-tx包 -->
24 <dependency>
25 <groupId>org.springframework</groupId>
26 <artifactId>spring-tx</artifactId>
27 <version>4.1.4.RELEASE</version>
28 </dependency>
29 <!-- 添加spring-jdbc包 -->
30 <dependency>
31 <groupId>org.springframework</groupId>
32 <artifactId>spring-jdbc</artifactId>
33 <version>4.1.4.RELEASE</version>
以上是关于[转]Mybatis3.x与Spring4.x整合的主要内容，如果未能解决你的问题，请参考以下文章
MyBatis学习总结——Mybatis3.x与Spring4.x整合
MyBatis学习总结——Mybatis3.x与Spring4.x整合
MyBatis学习总结——Mybatis3.x与Spring4.x整合