SpringBoot學習之整合Mybatis

TIOXY發表於2020-07-31
Spring BootMyBatis

本部落格使用IDEA開發工具，通過Maven構建SpringBoot專案，初始化專案新增的依賴有：spring-boot-starter-jdbc、spring-boot-starter-web、mysql-connector-java，這裡為了演示整合SpringBoot，初始時只勾選了這幾項，其他的啟動器根據自己實際專案選擇新增，如何使用IDEA構建SpringBoot專案這就不再過多贅述了。

版本：

  • IDEA 2020.1.3
  • Maven 3.6.3
  • MySql 8.0.19
  • SpringBoot 2.3.2

這裡構建專案使用的是SpringBoot自帶的Hikari資料來源，也可以根據自己專案選擇Druid、c3p0等。

如果使用Druid資料來源可以參考上一篇部落格：SpringBoot學習之整合Druid的簡單應用

1.環境搭建

首先在SpringBoot專案的pom.xml檔案中新增 mybatis-spring-boot-starter 依賴

<dependency>
    <groupId>org.mybatis.spring.boot</groupId>
    <artifactId>mybatis-spring-boot-starter</artifactId>
    <version>2.1.3</version>
</dependency>

Maven倉庫地址：https://mvnrepository.com/artifact/org.mybatis.spring.boot/mybatis-spring-boot-starter

配置application.yaml中的資料來源,這裡使用更加直觀的yaml格式檔案，也可以使用properties格式檔案

spring:
  datasource:
    username: root
    password: 970628
    url: jdbc:mysql://localhost:3306/school?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8
    driver-class-name: com.mysql.cj.jdbc.Driver

1.url中在mysql的8版本以上的可能需要設定時區： serverTimezone=UTC
2.driver-class-name 資料庫驅動，如果是mysql8版本以上的使用 com.mysql.cj.jdbc.Driver,低版本的使用 com.mysql.jdbc.Driver

2.編寫pojo類

這裡我使用我自建資料表user來做業務例子

編寫user對應的pojo類，包括有參無參構造及Getter、Setter方法

package com.tioxy.pojo;

public class User {
    private Integer id;
    private String name;
    private String pwd;

    public User() {
    }

    public User(Integer id, String name, String pwd) {
        this.id = id;
        this.name = name;
        this.pwd = pwd;
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getPwd() {
        return pwd;
    }

    public void setPwd(String pwd) {
        this.pwd = pwd;
    }

    @Override
    public String toString() {
        return "User{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", pwd='" + pwd + '\'' +
                '}';
    }
}

3.編寫Mapper及對應的Mapper.xml檔案

這裡我使用Mapper.xml編寫SQL語句，也可以使用註解方式，兩種方式都可以，看個人喜好。我選擇xml檔案的原因是編寫SQL語句靈活、擴充套件性好，我以xml檔案為例

編寫UserMapper介面，這裡新增了@Mapper則省去寫Mapper實現類了

package com.tioxy.mapper;

import com.tioxy.pojo.User;
import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;

import java.util.List;
@Mapper
@Repository
public interface UserMapper {
    /**
     * 查詢所有的使用者
     * @return
     */
    List<User> queryUserList();
}

在resources新增了mybatis.mapper包，在mapper下新增UserMapper.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.tioxy.mapper.UserMapper">
    <select id="queryUserList" resultType="User">
        select * from user
    </select>
</mapper>

由於這裡我們將Mapper介面與Mapper.xml檔案放在了不同的包下，需要我們在application.yaml新增Mapper自動掃描包的配置

# 整合Mybatis
mybatis:
  type-aliases-package: com.tioxy.pojo
  # 原來mapper與mapper.xml在同一路徑，現在不在同一路徑需要設定下面的引數，目的就是告訴*.xml檔案的路徑
  mapper-locations: classpath:mybatis/mapper/*.xml

完整的配置檔案如下圖：

如果將Mapper介面與Mapper.xml檔案放在了相同的包下，需要在POM.xml檔案新增maven配置資源過濾問題

<resources>
    <resource>
        <directory>src/main/java</directory>
        <includes>
            <include>**/*.xml</include>
        </includes>
        <filtering>true</filtering>
    </resource>
</resources>

4.測試驗證

新增一個控制器請求，進行驗證，程式碼如下：

@RestController
public class UserController {
    @Autowired
    private UserMapper userMapper;

    @GetMapping("/queryUserList")
    public List<User> queryUserList(){
        return userMapper.queryUserList();
    }
}

啟動專案執行輸入：http://localhost:8080/queryUserList

測試成功！

最後附上我的專案結構

文章參考：
狂神說Java之SpringBoot整合Mybatis課程學習：https://www.bilibili.com/video/BV1PE411i7CV?p=33

相關文章