mybatis 初步使用（IDEA的Maven項目, 超詳細）
阿新 • • 發佈：2018-09-09
font arc conn sys water 2.3 包名 cor pri
創建 Maven 項目
1. 菜單上選擇新建項目
File | New | Project
2. 選擇左側的Maven
由於我們只是創建一個普通的項目， 此處點擊 Next即可。
3. 輸入GroupId和ArtifactId
- 在我的項目中，
GroupId 填 com.homejim.mybatis
ArtifactId 填 helloMybatis
點擊 Next。
4. Finish
通過以上步驟， 一個普通的Maven項目就創建好了。
Maven配置
為了讓mybatis在項目上跑起來，需要進行如下配置。
pom.xml
1. 配置 JDK 版本和編碼方式
<plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <version>2.3.2</version> <configuration> <source>1.8</source> <target>1.8</target> <encoding>UTF-8</encoding> </configuration> </plugin> </plugins>
設置後， 編碼方式為 UTF-8， JDK 版本為 1.8
2. 設置資源文件路徑
Maven 中默認是只會打包 resource下的資源文件。如果我們的文件不放在resource， 則需要通過配置告知Maven。
<resources> <resource> <directory>src/main/java</directory> <includes> <include>**/*.properties</include> <include>**/*.xml</include> </includes> <filtering>false</filtering> </resource> </resources>
2. 添加 mybatis 依賴
<!--mybatis-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.5</version>
</dependency>本項目的 mybatis版本為3.4.5。
3. 添加數據庫驅動依賴
<!--數據庫 mysql 驅動--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.45</version> </dependency>
本項目使用的是mysql數據庫。
4. 添加日誌依賴
<!-- 實現slf4j接口並整合 -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
<version>1.7.25</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
<version>1.7.25</version>
</dependency>
<dependency>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
<version>2.10.0</version>
</dependency>添加日誌是為了在測試時可以輸出sql語句。
5. 添加測試依賴
<!--junit 測試-->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>添加junit是為了測試更加方便。
6. 導入依賴
右鍵 pom.xml | Maven | Reimport
創建數據庫
1. 創建數據庫
CREATE DATABASE IF NOT EXISTS `mybatis` DEFAULT CHARSET utf8 COLLATE utf8_general_ci;指定編碼為 UTF8
2. 創建數據庫表
創建一個 student 表。
DROP TABLE IF EXISTS `student`;
CREATE TABLE `student` (
`student_id` INT(10) UNSIGNED NOT NULL AUTO_INCREMENT COMMENT ‘編號‘,
`name` VARCHAR(20) DEFAULT NULL COMMENT ‘姓名‘,
`phone` VARCHAR(20) DEFAULT NULL COMMENT ‘電話‘,
`email` VARCHAR(50) DEFAULT NULL COMMENT ‘郵箱‘,
`sex` TINYINT(4) DEFAULT NULL COMMENT ‘性別‘,
`locked` TINYINT(4) DEFAULT NULL COMMENT ‘狀態(0:正常,1:鎖定)‘,
`gmt_created` DATETIME DEFAULT CURRENT_TIMESTAMP COMMENT ‘存入數據庫的時間‘,
`gmt_modified` DATETIME DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT ‘修改的時間‘,
PRIMARY KEY (`student_id`)
) ENGINE=INNODB AUTO_INCREMENT=1 DEFAULT CHARSET=utf8mb4 COMMENT=‘學生表‘;3. 插入測試數據
插入一些測試數據。
INSERT INTO `student`(`name`, phone, email, sex, locked)
VALUES
(‘小明‘, 13821378270, ‘[email protected]‘, 1, 0),
(‘小麗‘, 13821378271, ‘[email protected]‘, 0, 0),
(‘小剛‘, 13821378272, ‘[email protected]‘, 1, 0),
(‘小花‘, 13821378273, ‘[email protected]‘, 0, 0),
(‘小強‘, 13821378274, ‘[email protected]‘, 1, 0),
(‘小紅‘, 13821378275, ‘[email protected]‘, 0, 0);配置Mybatis
配置mybatis的XML文件
XML 配置文件（configuration XML）中包含了對 MyBatis 系統的核心設置。
1. 復制框架
從官網中復制最基本的配置：
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE configuration
PUBLIC "-//mybatis.org//DTD Config 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-config.dtd">
<configuration>
<environments default="development">
<environment id="development">
<transactionManager type="JDBC"/>
<dataSource type="POOLED">
<property name="driver" value="${driver}"/>
<property name="url" value="${url}"/>
<property name="username" value="${username}"/>
<property name="password" value="${password}"/>
</dataSource>
</environment>
</environments>
<mappers>
<mapper resource="org/mybatis/example/BlogMapper.xml"/>
</mappers>
</configuration>2. 配置 environments
environments 對應的是數據庫相關的屬性。我們可以配置多個環境，但每個 SqlSessionFactory 實例只能選擇其一。在本項目中， 我們只配置一個即可。數據庫時剛剛我們創建的mybatis。
<environments default="development">
<environment id="development">
<transactionManager type="JDBC">
<property name="" value=""/>
</transactionManager>
<dataSource type="POOLED">
<property name="driver" value="com.mysql.jdbc.Driver"/>
<property name="url" value="jdbc:mysql://localhost:3306/mybatis"/>
<property name="username" value="root"/>
<property name="password" value="你自己的密碼"/>
</dataSource>
</environment>
</environments>3. 配置 settings
在本項目中， 主要是為了配置日誌輸出。 pom.xml中配置的是 log4j， 因此此處的日誌實現值是 LOG4J。
<settings>
<setting name="logImpl" value="LOG4J" />
</settings>4. 配置 typeAliases
類型別名是為 Java 類型設置一個短的名字。它只和 XML 配置有關，存在的意義僅在於用來減少類完全限定名的冗余。
如果我們這樣配置
<--項目中不是這樣配置的-->
<typeAliases>
<typeAlias alias="Student" type="com.homejim.mybatis.entity.Student"/>
</typeAliases>那麽在mybatis中， Student可以用在任何使用com.homejim.mybatis.entity.Student的地方。
但一般來說entity都會有很多， 因此這樣配置太繁瑣了， mybatis支持指定包名， 會使用類的首字母小寫的類限定名作為別名。
本項目中， 如下配置
<typeAliases>
<package name="com.homejim.mybatis.entity"/>
</typeAliases>5. 配置 mappers
同理， 可以單個配置， 也可以通過掃描包來識別。
<mappers>
<package name="com.homejim.mybatis.mapper"/>
</mappers>該配置會掃描指定包中的所有 .xml 文件，這些文件包含著mybatis的 SQL 語句和映射配置文件。後續會創建。
創建實體類和對應的Mapper.xml
1. 創建實體類
實體類， 屬性需要與數據庫表中的字段一一對應， 並有對應的getter和setter。
package com.homejim.mybatis.entity;
import java.util.Date;
public class Student {
private Integer studentId;
private String name;
private String phone;
private String email;
private Byte sex;
private Byte locked;
private Date gmtCreated;
private Date gmtModified;
/**
* 以下部分為setter和getter, 省略
*/
}2. 創建 Mapper 接口和 Mapper.xml
StudentMapper.java
package com.homejim.mybatis.mapper;
import com.homejim.mybatis.entity.Student;
import java.util.List;
public interface StudentMapper {
/**
*
* @return
*/
List<Student> selectAll();
}StudentMapper.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.homejim.mybatis.mapper.StudentMapper">
<resultMap id="BaseResultMap" type="com.homejim.mybatis.entity.Student">
<id column="student_id" jdbcType="INTEGER" property="studentId" />
<result column="name" jdbcType="VARCHAR" property="name" />
<result column="phone" jdbcType="VARCHAR" property="phone" />
<result column="email" jdbcType="VARCHAR" property="email" />
<result column="sex" jdbcType="TINYINT" property="sex" />
<result column="locked" jdbcType="TINYINT" property="locked" />
<result column="gmt_created" jdbcType="TIMESTAMP" property="gmtCreated" />
<result column="gmt_modified" jdbcType="TIMESTAMP" property="gmtModified" />
</resultMap>
<sql id="Base_Column_List">
student_id, name, phone, email, sex, locked, gmt_created, gmt_modified
</sql>
<select id="selectAll" resultMap="BaseResultMap">
select
<include refid="Base_Column_List" />
from student
</select>
</mapper>配置了結果映射和 sql 語句， 其中 sql 中的 id 與Mapper中的方法名一致。
測試
public class StudentMapperTest {
private static SqlSessionFactory sqlSessionFactory;
@BeforeClass
public static void init() {
try {
Reader reader = Resources.getResourceAsReader("mybatis-config.xml");
sqlSessionFactory = new SqlSessionFactoryBuilder().build(reader);
} catch (IOException e) {
e.printStackTrace();
}
}
@Test
public void testSelectList() {
SqlSession sqlSession = null;
try {
sqlSession = sqlSessionFactory.openSession();
List<Student> students = sqlSession.selectList("selectAll");
for (int i = 0; i < students.size(); i++) {
System.out.println(students.get(i));
}
} catch (Exception e) {
e.printStackTrace();
} finally {
if (sqlSession != null) {
sqlSession.close();
}
}
}
}
- 通過
Resources工具類讀取mybatis-config.xml， 存入Reader； SqlSessionFactoryBuilder使用上一步獲得的reader創建SqlSessionFactory對象;- 通過
sqlSessionFactory對象獲得SqlSession; SqlSession對象通過selectList方法找到對應的“selectAll”語句， 執行SQL查詢。- 底層通過
JDBC查詢後獲得ResultSet, 對每一條記錄， 根據resultMap的映射結果映射到Student中， 返回List。 - 最後記得關閉
SqlSession。
獲得的結果如下
有SQL輸出， 以及SQL的執行情況
源碼
請訪問我的 Github 主頁獲取。
mybatis 初步使用（IDEA的Maven項目, 超詳細）