MyBatis學習總結(八)——Mybatis3.x與Spring4.x整合
一、搭建開發環境
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>