Spring Boot数据访问——整合MyBatis-Plus篇！超详细！

前言

        MyBatis是半自动化的ORM实现,支持定制化 SQL、存储过程和高级映射,其封装性低于Hibemate,但性能优秀、小巧、简单易学,在国内备受开发人员的喜爱。MyBatis本身也存在些许不足,例如,配置文件繁多,以及当编写一个业务逻辑时需要在DAO层写一个方法，再创建一个与之对应的映射文件或 SQL语句。针对 MyBatis 的这些不足，MyBatis-lus 诞生了。

        MyBatis-Plus是MyBatis 的增强工具，在MyBatis 的基础上只做增强不做改变，支持MyBatis 所有原生的特性，旨在简化开发、提高效率。

1、项目目录

图1-1

2、环境配置

JDK：17

IDEA：2024.3.3

Spring Boot：3.4.3

---

一、创建项目

        在IDEA中创建Spring Boot项目chapter05，可以根据自己当前情况选择使用 Spring Initializr 方式或者Maven方式进行创建，这里使用 Maven方式创建项目。

---

二、配置依赖

        在项目 chapter05 的pom.xml 文件中配置Spring Boot 整合 MyBatis-Plus 的依赖,包括Spring Boot 父工程的依赖、MySQL驱动依赖和 MyBatis-Plus整合 Spring Boot 的启动器依赖，具体内容如文件1-1所示。

文件1-1丨pom.xml

<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>3.4.3</version>
        <relativePath/>
    </parent>
    <groupId>org.example</groupId>
    <artifactId>chapter05-MP</artifactId>
    <version>0.0.1-SNAPSHOT</version>
    <name>chapter05-mp</name>
    <description>chapter05-mp</description>
    <url/>
    <licenses>
        <license/>
    </licenses>
    <developers>
        <developer/>
    </developers>
    <scm>
        <connection/>
        <developerConnection/>
        <tag/>
        <url/>
    </scm>
    <properties>
        <java.version>17</java.version>
    </properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>

        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.6</version>
        </dependency>

        <!-- 强制使用兼容的 MyBatis-Spring -->
        <dependency>
            <groupId>org.mybatis</groupId>
            <artifactId>mybatis-spring</artifactId>
            <version>3.0.3</version>
        </dependency>
   
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.33</version>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
    </dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
    </build>

</project>

---

三、设置配置信息

        在项目的resources目录下创建application.yml文件，在该文件中指定数据库连接信息，具体如文件1-2所示。

文件1-2丨application.yml

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/springbootdata（数据库名）?characterEncoding=utf-8&serverTimezone=Asia/Shanghai
    username: XXXXX   #用户名
    password: XXXXX   #数据库连接密码
  jpa:
    show-sql: true

        ！注：上述代码中，数据库名(eg:springbootdata)、用户名、数据库连接密码等，大家根据自己的实际情况进行填写。  

---

四、创建实体类

        MyBatis-Plus标注实体类的注解与Spring Data JPA不一样,所以需要使用MyBatis-Plus的注解标注实体类。在org.example.chapter05mp.entity包下创建实体类EBook，具体如文件1-3所示。

文件1-3丨EBook.java

import com.baomidou.mybatisplus.annotation.*;

@TableName("bookmp")
public class EBook {
    @TableId(type = IdType.AUTO)
    private Integer id;        //图书编号
    private String name;       //图书名称
    private String author;     //图书作者
    private String press;      //图书出版社
    private String status;     //图书状态

    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 getPress() {
        return press;
    }

    public void setPress(String press) {
        this.press = press;
    }

    public String getAuthor() {
        return author;
    }

    public void setAuthor(String author) {
        this.author = author;
    }

    public String getStatus() {
        return status;
    }

    public void setStatus(String status) {
        this.status = status;
    }

    public EBook() {
    }

    public EBook(Integer id, String name, String author, String press, String status) {
        this.id = id;
        this.name = name;
        this.author = author;
        this.press = press;
        this.status = status;
    }

    @Override
    public String toString() {
        return "Book{" +
                "id=" + id +
                ", name='" + name + '\'' +
                ", author='" + author + '\'' +
                ", press='" + press + '\'' +
                ", status='" + status + '\'' +
                '}';
    }
}

        在上述代码中，第3代码使用@TableName注解指定当前实体类对应的数据表名称，建立实体类和数据表的映射关系；第5行代码使用@TableId注解声明当前属性对应数据表的主键，并指定主键策略为自动增长。

---

五、自定义Mapper接口

        在org.example.chapter05mp.dao包下创建自定义接口BookMapper，并使用该接口继BaseMapper接口，具体如文件1-4所示。

文件1-4丨BookMapper.java

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import org.example.chapter05mp.entity.EBook;
public interface BookMapper extends BaseMapper<EBook> {
}

        在上述代码中，第3行代码指定操作的实体类为EBook。 

---

六、创建Service接口和实现类

        在项目的 java 目录下创建包 org.example.chapter05mp.service,并在该包下创建Service接口
和实现类，具体如文件1-5和文件1-6所示。

文件1-5丨BookService.java

import com.baomidou.mybatisplus.extension.service.IService;
import org.example.chapter05mp.entity.EBook;
public interface BookService  extends IService<EBook> {
}

        在上述代码中，第3行代码表示自定义的BookService接口继承了 IService 接口，并指定操作的实体类为EBook。

文件1-6丨BookServiceImpl.java

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.example.chapter05mp.dao.BookMapper;
import org.example.chapter05mp.entity.EBook;
import org.springframework.stereotype.Service;
public class BookServiceImpl extends ServiceImpl<BookMapper, EBook>
        implements BookService {
}

         在上述代码中，第5~6行代码表示自定义的BookServiceImpl类继承了ServiceImpl类，并且实现了BookService，指定注入的BaseMapper实例对象为BookMapper，操作的实例对象的类型为EBook。

---

七、扫描Mapper接口

在启动类Chapter05MpApplication上方使用@MapperScan注解扫描指定路径的Mapper并交由Spring管理，具体如文件1-7所示。

文件1-7丨Chapter05MpApplication.java

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@MapperScan("org.example.chapter05mp.dao")
@SpringBootApplication
public class Chapter05MpApplication {
    public static void main(String[] args) {
        SpringApplication.run(Chapter05MpApplication.class, args);
    }
}

        在上述代码中，第4行代码用于指定扫描org.example.chapter05mp.dao包下的Mapper,运行时会为该包下面的所有 Mapper生成相应的实现类。

---

 八、创建数据库

        测试对图书信息的操作需要先创建对应的数据库和数据表，并插人对应的测试数据，相关SQL如文件1-5所示。

文件1-8丨bookmq.sql

-- 创建数据库
CREATE DATABASE springboot-mp;

-- 使用数据库
USE springboot-mp;

-- 创建表
CREATE TABLE bookmp (
  id INT NOT NULL AUTO_INCREMENT,
  name VARCHAR(32),
  author VARCHAR(32),
  press VARCHAR(32),
  status VARCHAR(1),
  PRIMARY KEY (id) USING BTREE
);

-- 插入数据
INSERT INTO book VALUES (1, '楚辞', '屈原', '中国文联出版社', '0');
INSERT INTO book VALUES (2, '纳兰词', '纳兰性德', '中国文联出版社', '1');
INSERT INTO book VALUES (3, '西游记', '吴承恩', '中国文联出版社', '2');

运行结果如图 1-2所示：

图1-2

---

九、定义测试方法

        在src\test\java目录的org.example.chapter05mp包下创建测试类Chapter05MpApplicationTests,在Chapter05MpApplicationTests测试类中定义操作图书信息的测试方法，具体如文件1-8所示。

文件1-9丨Chapter05MpApplicationTests.java

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import org.example.chapter05mp.dao.BookMapper;
import org.example.chapter05mp.entity.EBook;
import org.example.chapter05mp.service.BookService;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import java.util.List;
import java.util.Optional;
import static org.junit.jupiter.api.Assertions.*;
@SpringBootTest
class Chapter05MpApplicationTests {
    @Autowired
    private BookMapper bookMapper;
    @Autowired
    private BookService bookService;

    private void printBooks(String title) {
        System.out.println("\n===== " + title + " =====");
        List<EBook> books = bookMapper.selectList(null);
        if (books.isEmpty()) {
            System.out.println("当前没有图书数据");
        } else {
            books.forEach(System.out::println);
        }
        System.out.println("========================");
    }

    @Test
    void saveEBook() {
        printBooks("新增前数据");

        // 新增图书
        EBook newBook = new EBook(null, "人间词话", "王国维", "四川文艺出版社", "1");
        int result = bookMapper.insert(newBook);
        assertEquals(1, result);

        printBooks("新增后数据");
        System.out.println("新增图书ID: " + newBook.getId());
    }

    @Test
    void findEBook() {
        printBooks("当前所有图书");

        // 查询状态为1且名称包含"词"的图书
        QueryWrapper<EBook> wrapper = new QueryWrapper<>();
        wrapper.eq("status", "1").like("name", "词");
        List<EBook> results = bookMapper.selectList(wrapper);

        System.out.println("\n查询结果:");
        assertFalse(results.isEmpty(), "应找到符合条件的图书");
        results.forEach(System.out::println);
    }

    @Test
    void editEBook() {
        printBooks("修改前数据");

        // 查找第一条存在的图书进行修改
        Optional<EBook> optionalBook = bookMapper.selectList(null).stream().findFirst();

        if (optionalBook.isPresent()) {
            EBook toUpdate = optionalBook.get();
            System.out.println("将修改的图书: " + toUpdate);

            String originalName = toUpdate.getName();
            toUpdate.setName(originalName + "(修订版)");
            toUpdate.setPress("中华书局");

            boolean updated = bookService.updateById(toUpdate);
            assertTrue(updated, "更新应成功");

            printBooks("修改后数据");
        } else {
            System.out.println("没有找到可修改的图书");
            fail("数据库中不存在可修改的图书");
        }
    }

    @Test
    void delEBook() {
        printBooks("删除前数据");

        // 查找第一条存在的图书进行删除
        Optional<EBook> optionalBook = bookMapper.selectList(null).stream().findFirst();

        if (optionalBook.isPresent()) {
            EBook toDelete = optionalBook.get();
            System.out.println("将删除的图书: " + toDelete);

            boolean removed = bookService.removeById(toDelete.getId());
            assertTrue(removed, "删除应成功");

            printBooks("删除后数据");

            // 验证删除结果
            EBook deletedBook = bookMapper.selectById(toDelete.getId());
            assertNull(deletedBook, "图书应已被删除");
        } else {
            System.out.println("没有找到可删除的图书");
            fail("数据库中不存在可删除的图书");
        }
    }
}

        在上述代码中，第13~16行代码注人了BookMapper 对象和 BookService 对象；第18~104
行代码定义了5个方法。其中，第18~27 行代码的printBooks()方法中调用 BookMapper的select -List()方法查询所有图书信息,并输出到控制台。
        第30~40行代码的saveEBook()方法用于测试新增图书信息,新增图书后调用 printBooks()方法查询所有图书信息。
        第43~54行代码的findEBook()方法用于测试查询图书信息,第47行代码用于创建一个条件构造器，第48行代码用于设置条件构造器的条件，第49行代码用于根据条件构造器中设置的条件查询图书信息。

---

 十、测试操作图书信息

         运行文件1-8中的saveBook()方法，测试新增图书信息，控制台输出如图2-1所示。

图2-1

        运行文件1-8中的findBook()方法，测试查询图书信息，控制台输出如图2-2所示。

图2-2

         运行文件1-8中的editBook()方法，测试修改图书信息，控制台输出如图2-3所示。

图2-3

        运行文件1-8中的delBook()方法，测试删除图书信息，控制台输出如图2-4所示。

图2-4

---

📢 互动时间
        本文的代码和思路是否解决了你的问题？欢迎在评论区分享你的想法或疑问！无论是更好的实现方式，还是遇到的其他问题，都可以详细描述，我会第一时间与你交流探讨。你的点赞/收藏是我持续创作的动力，技术无边界，让我们一起进步！🚀💬