Spring Boot（六）整合 MyBatis 操作 MySQL 8

一、簡介

1.1 MyBatis介紹

MyBatis 是一款優秀的持久層框架，它支援定製化 SQL、儲存過程以及高階對映。MyBatis 避免了幾乎所有的 JDBC程式碼和手動設定引數以及獲取結果集。

1.2 MyBatis發展史

MyBatis 原本是apache的一個開源專案iBatis, 2010年這個專案由apache software foundation 遷移到了google code，並且改名為MyBatis ，2013年11月遷移到Github。

1.3 MyBatis和Hibernate的區別

MyBatis 和 Hibernate 都是優秀的持久化框架，都支援JDBC（Java DataBase Connection）和JTA（Java Transaction API）事務處理。

MyBatis 優點

• 更加輕量級，如果說Hibernate是全自動的框架，MyBatis就是半自動的框架；
• 入門簡單，即學即用，並且延續了很好的SQL使用經驗；

Hibernate 優點

• 開發簡單、高效，不需要編寫SQL就可以進行基礎的資料庫操作；
• 可移植行好，大大降低了MySQL和Oracle之間切換的成本（因為使用了HQL查詢，而不是直接寫SQL語句）；
• 快取機制上Hibernate也好於MyBatis；

1.4 MyBatis整合方式

Mybatis整合方式分為兩種：

• 註解版整合
• XML版本整合

XML版本為老式的配置整合方式，重度整合XML檔案，SQL語句也是全部寫在XML中的；註解版版本，相對來說比較簡約，不需要XML配置，只需要使用註解和程式碼來運算元據。

二、註解版 MyBatis 整合

開發環境

• MySQL 8.0.12
• Spring Boot 2.0.4
• MyBatis Spring Boot 1.3.2（等於 MyBatis 3.4.6）
• JDK 8
• IDEA 2018.2

MyBatis Spring Boot 是 MyBatis 官方為了整合 Spring Boot 而推出的MyBatis版本。

2.1 新增依賴

設定pom.xml檔案，新增如下配置

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.12</version>
</dependency>

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.3.2</version>
</dependency>
複製程式碼

新增 MySQL 和 MyBatis 支援。

2.2 配置資料庫連線

設定application.properties檔案，新增如下配置

# MyBatis 配置
spring.datasource.url=jdbc:mysql://172.16.10.79:3306/mytestdb?serverTimezone=UTC&useSSL=false&allowPublicKeyRetrieval=true
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
mybatis.type-aliases-package=com.hello.springboot.mapper
複製程式碼

• spring.datasource.url 資料庫連線字串
• spring.datasource.username 資料庫使用者名稱
• spring.datasource.password 資料庫密碼
• spring.datasource.driver-class-name 驅動型別（注意MySQL 8.0的值是com.mysql.cj.jdbc.Driver和之前不同）
• mybatis.type-aliases-package 配置mapper包名

Mapper檔案說明

Mapper是MyBatis的核心，是SQL儲存的地方，也是配置資料庫對映的地方。

2.3 設定 MapperScan 包路徑

直接在啟動檔案SpringbootApplication.java的類上配置@MapperScan，這樣就可以省去，單獨給每個Mapper上標識@Mapper的麻煩。

@SpringBootApplication
@MapperScan("com.hello.springboot.mapper")
public class SpringbootApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootApplication.class, args);
    }
}
複製程式碼

2.4 新增程式碼

為了演示的簡潔性，我們不做太多的分層處理了，我們這裡就分為：實體類、Mapper介面、Controller類，使用Controller直接呼叫Mapper介面進行資料持久化處理。

User 類：

public class User {
    private Long id;
    private String name;
    private int age;
    private String pwd;
    //省去set、get方法
}
複製程式碼

UserMapper 介面：

public interface UserMapper {
    @Select("select * from user")
    @Results({
            @Result(property = "name", column = "name")
    })
    List<User> getAll();

    @Select("select * from user where id=#{id}")
    User getById(Long id);

    @Insert({"insert into user(name,age,pwd) values(#{name},#{age},#{pwd})"})
    void install(User user);

    @Update({"update user set name=#{name} where id=#{id}"})
    void Update(User user);

    @Delete("delete from user where id=#{id}")
    void delete(Long id);
}
複製程式碼

可以看出來，所有的SQL都是寫在Mapper介面裡面的。

Mapper裡的註解說明

• @Select 查詢註解
• @Result 結果集標識，用來對應資料庫列名的，如果實體類屬性和資料庫屬性名保持一致，可以忽略此引數
• @Insert 插入註解
• @Update 修改註解
• @Delete 刪除註解

Controller 控制器：

@RestController
@RequestMapping("/")
public class UserController {
    @Autowired
    private UserMapper userMapper;
    @RequestMapping("/")
    public ModelAndView index() {
        User user = new User();
        user.setAge(18);
        user.setName("Adam");
        user.setPwd("123456");
        userMapper.install(user);
        ModelAndView modelAndView = new ModelAndView("/index");
        modelAndView.addObject("count", userMapper.getAll().size());
        return modelAndView;
    }
}
複製程式碼

到此為止，已經完成了MyBatis專案的配置了，可以執行除錯了。

註解版GitHub原始碼下載：github.com/vipstone/sp…

三、XML 版 MyBatis 整合

3.1 新增依賴

設定pom.xml檔案，新增如下配置

<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.12</version>
</dependency>

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>1.3.2</version>
</dependency>
複製程式碼

新增 MySQL 和 MyBatis 支援。

3.2 配置資料庫連線

設定application.properties檔案，新增如下配置

# MyBatis 配置
spring.datasource.url=jdbc:mysql://172.16.10.79:3306/mytestdb?serverTimezone=UTC&useSSL=false&allowPublicKeyRetrieval=true
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
mybatis.type-aliases-package=com.hello.springboot.entity
mybatis.config-locations=classpath:mybatis/mybatis-config.xml
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml
複製程式碼

• spring.datasource.url 資料庫連線字串
• spring.datasource.username 資料庫使用者名稱
• spring.datasource.password 資料庫密碼
• spring.datasource.driver-class-name 驅動型別（注意MySQL 8.0的值是com.mysql.cj.jdbc.Driver和之前不同）
• mybatis.type-aliases-package 實體類包路徑
• mybatis.config-locations 配置MyBatis基礎屬性
• mybatis.mapper-locations 配置Mapper XML檔案

3.3 設定 MapperScan 包路徑

直接在啟動檔案SpringbootApplication.java的類上配置@MapperScan，這樣就可以省去，單獨給每個Mapper上標識@Mapper的麻煩。

@SpringBootApplication
@MapperScan("com.hello.springboot.mapper")
public class SpringbootApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootApplication.class, args);
    }
}
複製程式碼

3.4 配置XML檔案

本示例設定兩個xml檔案，在resource/mybatis下的mybatis-config.xml（配置MyBatis基礎屬性）和在resource/mybatis/mapper下的UserMapper.xml（使用者和資料互動的SQL語句）。

mybatis-config.xml

<?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>
    <typeAliases>
        <typeAlias alias="Integer" type="java.lang.Integer"/>
        <typeAlias alias="Long" type="java.lang.Long"/>
        <typeAlias alias="HashMap" type="java.util.HashMap"/>
        <typeAlias alias="LinkedHashMap" type="java.util.LinkedHashMap"/>
        <typeAlias alias="ArrayList" type="java.util.ArrayList"/>
        <typeAlias alias="LinkedList" type="java.util.LinkedList"/>
    </typeAliases>
</configuration>
複製程式碼

UserMapper.xml

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">

<!--namespace是名稱空間，是mapper介面的全路徑-->
<mapper namespace="com.hello.springboot.mapper.UserMapper">

    <!--resultMap – 是最複雜也是最強大的元素，用來描述如何從資料庫結果集中來載入物件-->
    <resultMap id="userResultMap" type="com.hello.springboot.entity.User">
        <id property="name" column="username"></id>
    </resultMap>

    <!--sql – 可被其他語句引用的可重用語句塊-->
    <sql id="colums">
        id,username,age,pwd
    </sql>

    <select id="findAll" resultMap="userResultMap">
        select
        <include refid="colums" />
        from  user
    </select>

    <select id="findById" resultMap="userResultMap">
        select
        <include refid="colums" />
        from  user
        where  id=#{id}
    </select>

    <insert id="insert" parameterType="com.hello.springboot.entity.User" >
       INSERT INTO
       		user
       		(username,age,pwd)
       	VALUES
       		(#{name}, #{age}, #{pwd})
    </insert>

    <update id="update" parameterType="com.hello.springboot.entity.User" >
        UPDATE
        users
        SET
        <if test="username != null">username = #{username},</if>
        <if test="pwd != null">pwd = #{pwd},</if>
        username = #{username}
        WHERE
        id = #{id}
    </update>

    <delete id="delete" parameterType="java.lang.Long" >
       DELETE FROM
       		 user
       WHERE
       		 id =#{id}
    </delete>

</mapper>
複製程式碼

SQL 對映檔案有很少的幾個頂級元素（按照它們應該被定義的順序）：

• cache – 給定名稱空間的快取配置。
• cache-ref – 其他名稱空間快取配置的引用。
• resultMap – 是最複雜也是最強大的元素，用來描述如何從資料庫結果集中來載入物件。
• parameterMap – 已廢棄！老式風格的引數對映。內聯引數是首選,這個元素可能在將來被移除，這裡不會記錄。
• sql – 可被其他語句引用的可重用語句塊。
• insert – 對映插入語句
• update – 對映更新語句
• delete – 對映刪除語句
• select – 對映查詢語句

注意： MyBatis中 config 和 mapper 的 XML 標頭檔案是不一樣的。

config 標頭檔案

<?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">
複製程式碼

mapper 標頭檔案

<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
複製程式碼

Mapper XML 更多配置：www.mybatis.org/mybatis-3/z…

3.5 新增程式碼

為了演示的便捷性，我們新增3個類用於功能的展示，分別是實體類User.java、mapper介面UserMapper.java和控制器類UserController.java，使用控制器類直接呼叫UserMapper的方法，進行資料儲存和查詢。

User.java

package com.hello.springboot.entity;
public class User {
    private Long id;
    private String name;
    private int age;
    private String pwd;
	//省略set/get方法
}

複製程式碼

UserMapper.java

package com.hello.springboot.mapper;
import com.hello.springboot.entity.User;
import java.util.List;
public interface UserMapper {
    List<User> findAll();
    User findById(Long id);
    void insert(User user);
    void update(User user);
    void delete(Long id);
}
複製程式碼

注意： Mapper裡的方法名必須和Mapper XML裡的一致，不然會找不到執行的SQL。

UserController.java

@RestController
@RequestMapping("/")
public class UserController {
    @Resource
    private UserMapper userMapper;

    @RequestMapping("/")
    public ModelAndView index() {
        User user = new User();
        user.setAge(18);
        user.setName("Adam");
        user.setPwd("123456");
        userMapper.insert(user);
        ModelAndView modelAndView = new ModelAndView("/index");
        modelAndView.addObject("count", userMapper.findAll().size());
        return modelAndView;
    }

}
複製程式碼

到此為止，已經完成了MyBatis專案的配置了，可以執行除錯了。

XML版GitHub原始碼下載：github.com/vipstone/sp…

四、總結

到目前為止我們已經掌握了MyBatis的兩種整合方式，註解整合和XML整合，註解版更符合程式設計師的程式碼書寫習慣，適用於簡單快速查詢；XML版可以靈活的動態調整SQL，更適合大型專案開發，具體的選擇還要看開發場景以及個人喜好了。