SpringBoot 项目整合 MyBatisPlus 框架，附带测试示例

青灯文案

已于 2025-02-06 20:39:24 修改

阅读量3.1k

点赞数 13

CC 4.0 BY-SA版权

分类专栏： Java 组件文章标签： spring boot junit mybatisplus

于 2024-06-28 11:15:12 首次发布

本文链接：https://blog.youkuaiyun.com/Reggie97/article/details/140018367

Java 组件专栏收录该内容

15 篇文章

订阅专栏

文章目录

如果对于 MyBatisPlus 的常见基础知识不了解，可以点击 MyBatisPlus 基础原理、常见注解和注意事项简介

如果不清楚如何使用 SpringBoot 整合 MyBatis 框架，可以点击超详细的SpringBoot项目整合MyBatis框架步骤示例，并附带浏览器和Junit测试结果示例代码

一、创建 SpringBoot 项目

本文采用 idea 创建简单的 maven 项目， JDK 版本为1.8。

在这里插入图片描述

二、添加 MyBatisPlus 依赖

依赖项中的都很重要，包括 MyBatisPlus 和 MySQL 的依赖，还有 SpringBoot 项目的起步依赖，以及对实体类非常有用的 lombok 依赖。

<parent>
	<artifactId>spring-boot-starter-parent</artifactId>
	<groupId>org.springframework.boot</groupId>
	<version>2.7.10</version>
</parent>

<dependencies>
	<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>
	</dependency>
	<dependency>
		<groupId>junit</groupId>
		<artifactId>junit</artifactId>
		<scope>test</scope>
	</dependency>
	<dependency>
		<groupId>org.projectlombok</groupId>
		<artifactId>lombok</artifactId>
		<version>1.16.18</version>
	</dependency>
	<dependency>
		<groupId>com.baomidou</groupId>
		<artifactId>mybatis-plus-boot-starter</artifactId>
		<version>3.5.3.1</version>
	</dependency>
	<dependency>
		<groupId>mysql</groupId>
		<artifactId>mysql-connector-java</artifactId>
		<version>5.1.38</version>
	</dependency>
</dependencies>

三、项目结构和数据库表结构

该项目整体结构如下：

MyBatisPlus 结构
数据库表结构如下：
在这里插入图片描述

四、项目代码

1、application.yml

本文使用 yml 的配置文件，配置文件中按层级配置好数据库的信息，项目启动时，会自动根据配置信息连接到数据库。注：要保证数据库是启动状态的。mybatis-plus 这个配置如果是自定义 mapper 文件夹路径的需要进行配置。

spring:
  datasource:
    url: jdbc:mysql://10.100.5.174:8888/test?allowMultiQueries=true&amp;useUnicode=true&amp;characterEncoding=UTF-8&amp;zeroDateTimeBehavior=convertToNull
    driver-class-name: com.mysql.jdbc.Driver
    username: root
    password: 各位大佬点点赞
    
mybatis-plus:
  mapper-locations: classpath:mybatis-mapper/*.xml

2、TestController

这里没啥好说的，如果不清楚，说明基础没有学通。

@RestController
public class Controller {

    @Autowired
    private TestService testService;

    @GetMapping("/select")
    public TbUser selectById(@Param("id") int id ){
        return testService.selectById(id);
    }
}

3、TbUser

实体类，一般来说，要与数据库中的表对应上，这里使用了 @TableName @TableId @TableField 等 MyBatisPlus 中的注解进行对应。

@Data
@AllArgsConstructor
@NoArgsConstructor
@TableName("tb_user")
public class TbUser {

    @TableId(type = IdType.AUTO)
    private int id;

    @TableField("username") // 字段名和属性名相同是不用写的
    private String username;

    private String password;
}

4、TbUserMapper

@Mapper
public interface TbUserMapper extends BaseMapper<TbUser> {

    // 这里的BaseMapper是一个MyBatisPlus中提供的超类
    // 这个类里面附带了增删改查等一系列的常用方法
    // TbUserMapper中一些常见的操作就可以直接继承过来进行使用

}

5、TestServiceImpl

@Service
public class TestServiceImpl implements TestService {

    @Autowired
    private TbUserMapper tbUserMapper;

    @Override
    public TbUser selectById(int id) {
        return tbUserMapper.selectById(id);
    }
}

6、TestService

public interface Service {

    TbUser selectById(int id);

}

7、TestApplication

@MapperScan("com.wen.mapper")
@SpringBootApplication
public class TestApplication {

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

8、TbUserMapper.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.wen.mapper.TbUserMapper">

</mapper>

9、MyBatisPlusTest

用于 Junit 测试使用，这里要注意，因为需要连接数据库，所以要先启动 SpringBoot 项目，所以要添加以下两个注解。

@RunWith(SpringRunner.class)
- 因为 SpringRunner.class 继承了 SpringJUnit4ClassRunner.class 且没有进行任何修改。
- 所以 @RunWith(SpringRunner.class) 基本等同于 `@RunWith(SpringJUnit4ClassRunner.class)`` 。
- 作用是让测试在 Spring 容器环境下执行。
- 如果测试类中无此注解，将导致 service，dao 等自动注入失败。
@SpringBootTest(classes = TestApplication.class)
- 确保注解的主类（通常是包含 main 方法的类）在测试类的同一包中或者其子包中。
- @SpringBootTest 默认会从当前包中查找主类。

@RunWith(SpringRunner.class)
@SpringBootTest(classes = TestApplication.class)
public class MyBatisPlusTest {

    @Autowired
    private TbUserMapper tbUserMapper;

    @Test
    public void selectTbUser(){
        TbUser tbUser = tbUserMapper.selectById(1);
        System.out.println(tbUser.toString());
    }
}

五、浏览器测试结果

启动 TestApplication ，也就是启动 SpringBoot 项目，起步依赖会自动识别项目 application.yml 文件中的数据库配置信息，连接数据库，根据 controller 中的访问路径添加参数，就可以做到对数据库的增删改查。

如图所示，在浏览器上访问 localhost:8080/select?id=1 ，目的是查询 ID 为 1 的 TbUser 信息。

浏览器测试结果

六、Junit 测试结果

运行 selectTbUser() 方法，会出现以下结果。

junit测试结果

七、完整 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 http://maven.apache.org/xsd/maven-4.0.0.xsd">
    <modelVersion>4.0.0</modelVersion>

    <groupId>com.wen</groupId>
    <artifactId>springboot-mybatis-plus</artifactId>
    <version>1.0-SNAPSHOT</version>

    <properties>
        <maven.compiler.source>8</maven.compiler.source>
        <maven.compiler.target>8</maven.compiler.target>
        <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
    </properties>

    <parent>
        <artifactId>spring-boot-starter-parent</artifactId>
        <groupId>org.springframework.boot</groupId>
        <version>2.7.10</version>
    </parent>

    <dependencies>
        <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>
        </dependency>
        <dependency>
            <groupId>junit</groupId>
            <artifactId>junit</artifactId>
            <scope>test</scope>
        </dependency>
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.16.18</version>
        </dependency>
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.3.1</version>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>5.1.38</version>
        </dependency>
    </dependencies>
</project>