SpringBoot 系列教程 Mybatis+xml 整合篇

SpringBoot 系列教程 Mybatis+xml 整合篇

MyBatis 是一款優秀的持久層框架，它支持定製化 SQL、存儲過程以及高級映射。MyBatis 避免了幾乎全部的 JDBC 代碼和手動設置參數以及獲取結果集。MyBatis 可使用簡單的 XML 或註解來配置和映射原生類型、接口和 Java 的 POJO（Plain Old Java Objects，普通老式 Java 對象）爲數據庫中的記錄。

本文將經過實例方式，介紹下如何整合 SpringBoot + Mybatis，構建一個支持 CRUD 的 demo 工程

<!-- more -->

I. 環境

本文使用 SpringBoot 版本爲 2.2.1.RELEASE， mybatis 版本爲1.3.2，數據庫爲 mysql 5+

1. 項目搭建

推薦是用官方的教程來建立一個 SpringBoot 項目； 若是直接建立一個 maven 工程的話，將下面配置內容，拷貝到你的pom.xml中

• 主要引入的是mybatis-spring-boot-starter，能夠減小使人窒息的配置

<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.2.1.RELEASE</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>

<properties>
    <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    <project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
    <java.version>1.8</java.version>
</properties>

<dependencies>
    <dependency>
        <groupId>org.mybatis.spring.boot</groupId>
        <artifactId>mybatis-spring-boot-starter</artifactId>
        <version>1.3.2</version>
    </dependency>
    <dependency>
        <groupId>mysql</groupId>
        <artifactId>mysql-connector-java</artifactId>
    </dependency>
</dependencies>

<build>
    <pluginManagement>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </pluginManagement>
</build>
<repositories>
    <repository>
        <id>spring-snapshots</id>
        <name>Spring Snapshots</name>
        <url>https://repo.spring.io/libs-snapshot-local</url>
        <snapshots>
            <enabled>true</enabled>
        </snapshots>
    </repository>
    <repository>
        <id>spring-milestones</id>
        <name>Spring Milestones</name>
        <url>https://repo.spring.io/libs-milestone-local</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
    <repository>
        <id>spring-releases</id>
        <name>Spring Releases</name>
        <url>https://repo.spring.io/libs-release-local</url>
        <snapshots>
            <enabled>false</enabled>
        </snapshots>
    </repository>
</repositories>

2. 配置信息

在 application.yml 配置文件中，加一下 db 的相關配置

spring:
  datasource:
    url: jdbc:mysql://127.0.0.1:3306/story?useUnicode=true&characterEncoding=UTF-8&useSSL=false
    username: root
    password:

接下來準備一個測試表(依然借用以前 db 操做系列博文中的表結構)，用於後續的 CURD；表結果信息以下

DROP TABLE IF EXISTS `money`;

CREATE TABLE `money` (
  `id` int(11) unsigned NOT NULL AUTO_INCREMENT,
  `name` varchar(20) NOT NULL DEFAULT '' COMMENT '用戶名',
  `money` int(26) NOT NULL DEFAULT '0' COMMENT '有多少錢',
  `is_deleted` tinyint(1) NOT NULL DEFAULT '0',
  `create_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '建立時間',
  `update_at` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新時間',
  PRIMARY KEY (`id`),
  KEY `name` (`name`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4;

II. 實例整合

本文將介紹一下傳統的 xml 使用姿式，手動的添加PO, DAO, Mapper.xml；至於 Generator 來自動生成的 case，後面經過圖文的方式進行介紹

1. PO

建立表對應的 PO 對象: MoneyPo

@Data
public class MoneyPo {
    private Integer id;

    private String name;

    private Long money;

    private Integer isDeleted;

    private Timestamp createAt;

    private Timestamp updateAt;
}

2. DAO 接口

表的操做接口，下面簡單的寫了四個接口，分別對應 CRUID 四種操做

@Mapper
public interface MoneyMapper {

    int savePo(@Param("po") MoneyPo po);

    List<MoneyPo> findByName(@Param("name") String name);

    int addMoney(@Param("id") int id, @Param("money") int money);

    int delPo(@Param("id") int id);
}

重點觀察下上面接口的兩個註解

• @Mapper：聲明這個爲 mybatis 的 dao 接口，spring 掃描到它以後，會自動生成對應的代理類

  • 使用這個註解以後，能夠再也不啓動類上加上@MapperScan； 固然加上@MapperScan以後，也能夠不用這個註解
• @Param： 主要傳遞到 xml 文件中，方便參數綁定

這裏簡單說一下幾種常見的參數傳遞方式

a. 單參數傳遞

若是隻有一個基本類型的參數，能夠直接使用參數名的使用方式

MoneyPo findById(int id);

對應的 xml 文件以下（先忽略 include 與 resultMap）, 能夠直接用參數名

<select id="findById" parameterType="java.lang.Integer" resultMap="BaseResultMap">
    select
    <include refid="money_po"/>
    from money where id=#{id}
</select>

b. 多參數默認傳遞

當接口定義有多個參數時，就不能直接使用參數名了，使用 arg0, arg1... (或者 param1, param2...)

實例以下

List<MoneyPo> findByNameAndMoney(String name, Integer money);

對應的 xml

<select id="findByNameAndMoney" resultMap="BaseResultMap">
    select
    <include refid="money_po"/>
--         from money where name=#{param1} and money=#{param2}
    from money where name=#{arg0} and money=#{arg1}
</select>

c. @Param 方式

就是上面 case 中的方式，xml 中的參數就是註解的 value；就不給演示了（後續的 xml 中能夠看到使用姿式）

d. Map 傳參

接口定義一個 Map<String, Object> 類型的參數，而後在 xml 中，就可使用 key 的值來代表具體選中的是哪個參數

List<MoneyPo> findByMap(Map<String, Object> map);

對應的 xml 以下，關於標籤的用法主要是 mybatis 的相關知識點，這裏不詳細展開

<select id="findByMap" resultMap="BaseResultMap">
    select
    <include refid="money_po"/>
    from money
    <trim prefix="WHERE" prefixOverrides="AND | OR">
        <if test="id != null">
            id = #{id}
        </if>
        <if test="name != null">
            AND name=#{name}
        </if>
        <if test="money != null">
            AND money=#{money}
        </if>
    </trim>
</select>

e. POJO 傳參

參數爲一個 POJO 對象，實際使用中，經過成員名來肯定具體的參數

List<MoneyPo> findByPo(MoneyPo po);

對應的 xml 以下，須要添加參數parameterType 指定 POJO 的類型

此外請額外注意下面的參數使用姿式和後面savePo接口對應的實現中參數的引用區別

<select id="findByPo" parameterType="com.git.hui.boot.mybatis.entity.MoneyPo" resultMap="BaseResultMap">
        select
    <include refid="money_po"/>
    from money
    <trim prefix="WHERE" prefixOverrides="AND | OR">
        <if test="id != null">
            id = #{id}
        </if>
        <if test="name != null">
            AND name=#{name}
        </if>
        <if test="money != null">
            AND money=#{money}
        </if>
    </trim>
</select>

3. xml 實現

上面的 Mapper 接口中定義接口，具體的實現須要放在 xml 文件中，在咱們的實例 case 中，xml 文件放在 resources/sqlmapper目錄下

文件名爲money-mapper.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.git.hui.boot.mybatis.mapper.MoneyMapper">

    <resultMap id="BaseResultMap" type="com.git.hui.boot.mybatis.entity.MoneyPo">
        <id column="id" property="id" jdbcType="INTEGER"/>
        <result column="name" property="name" jdbcType="VARCHAR"/>
        <result column="money" property="money" jdbcType="INTEGER"/>
        <result column="is_deleted" property="isDeleted" jdbcType="TINYINT"/>
        <result column="create_at" property="createAt" jdbcType="TIMESTAMP"/>
        <result column="update_at" property="updateAt" jdbcType="TIMESTAMP"/>
    </resultMap>
    <sql id="money_po">
      id, name, money, is_deleted, create_at, update_at
    </sql>

    <insert id="savePo" parameterType="com.git.hui.boot.mybatis.entity.MoneyPo" useGeneratedKeys="true"
            keyProperty="po.id">
      INSERT INTO `money` (`name`, `money`, `is_deleted`)
      VALUES
      (#{po.name}, #{po.money}, #{po.isDeleted});
    </insert>

    <update id="addMoney" parameterType="java.util.Map">
        update money set money=money+#{money} where id=#{id}
    </update>

    <delete id="delPo" parameterType="java.lang.Integer">
        delete from money where id = #{id,jdbcType=INTEGER}
    </delete>

    <select id="findByName" parameterType="java.lang.String" resultMap="BaseResultMap">
        select
        <include refid="money_po"/>
        from money where name=#{name}
    </select>
</mapper>

在上面的 xml 文件中，除了四個接口對應的實現以外，還定義了一個resultMap 和 sql

• sql 標籤訂義通用的 sql 語句片斷，經過<include refid="xxx"/>方式引入，避免寫重複代碼
• resultMap: 定義表中數據與 POJO 成員的映射關係，好比將下劃線的命名映射成駝峯

4. mybatis 配置

上面基本上完成了整合工做的 99%, 可是還有一個問題沒有解決，mapper 接口如何與 xml 文件關聯起來？

• xml 文件中的 mapper 標籤的 namespace 指定了具體的 mapper 接口, 代表這個 xml 文件對應的這個 mapper

可是對於 spring 而言，並非全部的 xml 文件都會被掃描的，畢竟你又不是 web.xml 這麼有名（爲何 web.xml 就這麼特殊呢 😝, 歡迎查看個人Spring MVC 之基於 xml 配置的 web 應用構建）

爲了解決 xml 配置掃描問題，請在 application.yml 文件中添加下面這一行配置

mybatis:
  mapper-locations: classpath:sqlmapper/*.xml

5. 測試

接下來簡單測試一下上面的四個接口，看是否能夠正常工做

啓動類

@SpringBootApplication
public class Application {

    public Application(MoneyRepository repository) {
        repository.testMapper();
    }

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
}

測試類

@Repository
public class MoneyRepository {
    @Autowired
    private MoneyMapper moneyMapper;

    private Random random = new Random();

    public void testMapper() {
        MoneyPo po = new MoneyPo();
        po.setName("mybatis user");
        po.setMoney((long) random.nextInt(12343));
        po.setIsDeleted(0);

        moneyMapper.savePo(po);
        System.out.println("add record: " + po);
        moneyMapper.addMoney(po.getId(), 200);
        System.out.println("after addMoney: " + moneyMapper.findByName(po.getName()));
        moneyMapper.delPo(po.getId());
        System.out.println("after delete: " + moneyMapper.findByName(po.getName()));
    }
}

輸出結果

II. 其餘

0. 項目

• 工程：https://github.com/liuyueyi/spring-boot-demo
• 項目源碼: https://github.com/liuyueyi/spring-boot-demo/tree/master/spring-boot/103-mybatis-xml

1. 一灰灰 Blog

盡信書則不如，以上內容，純屬一家之言，因我的能力有限，不免有疏漏和錯誤之處，如發現 bug 或者有更好的建議，歡迎批評指正，不吝感激

下面一灰灰的我的博客，記錄全部學習和工做中的博文，歡迎你們前去逛逛

• 一灰灰 Blog 我的博客 https://blog.hhui.top
• 一灰灰 Blog-Spring 專題博客 http://spring.hhui.top