mybatis 初步使用（IDEA的Maven項目, 超詳細）

建立 Maven 項目
Maven配置
- pom.xml
- 建立資料庫
配置Mybatis
- 配置mybatis的XML檔案
- 建立實體類和對應的Mapper.xml
測試
源碼

1. 菜單上選擇建立項目

File | New | Project

2. 選擇左側的

Maven

由于我們隻是建立一個普通的項目，此處點選

Next

即可。

3. 輸入

GroupId

和

ArtifactId

在我的項目中，

GroupId 填 com.homejim.mybatis

ArtifactId 填 helloMybatis

點選

Next

。

Finish

通過以上步驟，一個普通的

Maven

項目就建立好了。

為了讓

mybatis

在項目上跑起來，需要進行如下配置。

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);

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 語句和映射配置檔案。後續會建立。

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

與

Mappe

r中的方法名一緻。

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 首頁擷取。

作者：阿進的寫字台

出處：https://www.cnblogs.com/homejim/

本文版權歸作者和部落格園共有，歡迎轉載，但未經作者同意必須保留此段聲明，且在文章頁面明顯位置給出原文連接配接，否則保留追究法律責任的權利。

mybatis 初步使用（IDEA的Maven項目, 超詳細）

繼續閱讀

nginx location中斜線的位置的重要性

27 Best Free Eclipse Plug-ins for Java Developer to be ProductiveCode Quality PluginsText Editor PluginsDependency ManagementVersion Control Integration PluginsFramework Development Continuous Integration Related PluginsOther Utility Plugins

Java String.format方法的簡單使用

neo4j之cypher使用文檔

GitHub連夜封殺！這份阿裡 10W 字内部 Java 字面試手冊到底有多強？

用mybatis的generator插件在項目中自動生成dao及entity

spark/scala關于【資源檔案】加載方法概述外部檔案加載方案測試資源檔案打包入jar包中小結

mybatis_入門程式Mybatis入門

AOP程式設計_Android優雅權限架構(1)概念基礎，2021金三銀四前言正文大綱正文

Effective Java 8:通用程式設計

OOM三種類型

工廠模式-三種類型

【遞歸】高效率求2的n次幂

從mybatis到mybatis plus(mp)

win10本地scala和spark安裝安裝scala安裝spark

scala (3) Function 和 Method