SpringBoot集成Mybatis-Plus快速入门（详细）

迈不过友情╰ 2023-10-04 22:49 42阅读 0赞

#### 文章目录 ####

*  1、快速开始
 *   *  1.1数据库准备
     *  1.2初始化工程
     *  1.3添加Maven依赖
     *  1.4配置
     *  1.5编码
     *  1.6开始使用
 *  2、安装
 *  3、配置
 *  4、注解
 *  5、快速测试

就像官网说的一样，MyBatis-Plus (opens new window)（简称 MP）是一个 MyBatis (opens new window)的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生。  
***框架结构***  
![在这里插入图片描述][32ad6631b0304ba082bc274ae2cc0a47.png]

## 1、快速开始 ##

通过一个简单的 Demo 来阐述 MyBatis-Plus 的强大功能，在此之前，我们假设已经

*  拥有 Java 开发环境以及相应 IDE
 *  熟悉 Spring Boot
 *  熟悉 Maven

### 1.1数据库准备 ###

现有一个User表：结构如下  
![在这里插入图片描述][a951a601fedc4574b8bb514c38d6fe55.png]  
数据库 Schema 脚本：

DROP TABLE IF EXISTS user;
    
    CREATE TABLE user
    (
        id BIGINT(20) NOT NULL COMMENT '主键ID',
        name VARCHAR(30) NULL DEFAULT NULL COMMENT '姓名',
        age INT(11) NULL DEFAULT NULL COMMENT '年龄',
        email VARCHAR(50) NULL DEFAULT NULL COMMENT '邮箱',
        PRIMARY KEY (id)
    );

数据库 Data 脚本：

DELETE FROM user;
    
    INSERT INTO user (id, name, age, email) VALUES
    (1, 'Jone', 18, 'test1@baomidou.com'),
    (2, 'Jack', 20, 'test2@baomidou.com'),
    (3, 'Tom', 28, 'test3@baomidou.com'),
    (4, 'Sandy', 21, 'test4@baomidou.com'),
    (5, 'Billie', 24, 'test5@baomidou.com');

### 1.2初始化工程 ###

> 提示：  
> 可以使用 Spring Initializer (opens new window)快速初始化一个 Spring Boot 工程

### 1.3添加Maven依赖 ###

引入 Spring Boot Starter 父工程：

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

引入SpringBoot集成Mybatis-Plus所需的各种依赖：

<dependencies>
            
            <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>8.0.32</version>
            </dependency>
            
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <optional>true</optional>
            </dependency>
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
            </dependency>
            <dependency>
                <groupId>junit</groupId>
                <artifactId>junit</artifactId>
                <version>4.13.1</version>
                <scope>test</scope>
            </dependency>
    
    
        </dependencies>

这些是核心依赖，本项目还用到了mysql驱动、lombok。集成mybatis-plus要把mybatis、mybatis-spring去掉，避免冲突。lombok依赖就是简化实体类的编写getter、setter方法。

### 1.4配置 ###

在 application.yml 配置文件中添加jdbc数据库的相关配置：

mybatis-plus:
      configuration:
        log-impl: org.apache.ibatis.logging.stdout.StdOutImpl #开启sql日志
        map-underscore-to-camel-case: true
        # 该配置就是将带有下划线的表字段映射为驼峰格式的实体类属性
    spring:
      datasource:
        driver-class-name: com.mysql.cj.jdbc.Driver
        url: jdbc:mysql://localhost:3306/test?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
        username: root
        password: 20020702

在 Spring Boot 启动类中添加 @MapperScan 注解，扫描 Mapper 文件夹：

@SpringBootApplication
    @MapperScan("com.guo.demo.mapper")//自己的包名
    public class Application {
        
    
        public static void main(String[] args) {
        
            SpringApplication.run(Application.class, args);
        }
    }

### 1.5编码 ###

> 实体类

@Data
    @AllArgsConstructor
    @NoArgsConstructor
    public class User implements Serializable {
        
        private Long id;
        private String name;
        private Integer age;
        private String email;
    }

> 编写 Mapper 包下的 UserMapper接口

@Mapper
    public interface UserMapper extends BaseMapper<User> {
        
    }

### 1.6开始使用 ###

添加测试类，进行功能测试：

@SpringBootTest
    public class UserServiceImplTest {
        
    
        @Autowired
        UserServiceImpl userService;
    
        @Test
        public void queryAll() {
        
            userService.selectAll().forEach(System.out::println);
        }
    }

> 提示  
> UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper，所以不填写就是无任何条件

控制台输出：

User(id=1, name=Jone, age=18, email=test1@baomidou.com)
    User(id=2, name=Jack, age=20, email=test2@baomidou.com)
    User(id=3, name=Tom, age=28, email=test3@baomidou.com)
    User(id=4, name=Sandy, age=21, email=test4@baomidou.com)
    User(id=5, name=Billie, age=24, email=test5@baomidou.com)

## 2、安装 ##

全新的 MyBatis-Plus 3.0 版本基于 JDK8，提供了 lambda 形式的调用，所以安装集成 MP3.0 要求如下：

*  JDK 8+
 *  Maven or Gradle  
    **Spring Boot**  
    Maven：

<dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>最新版本</version>
    </dependency>

Spring  
Maven:

<dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus</artifactId>
        <version>最新版本</version>
    </dependency>

## 3、配置 ##

MyBatis-Plus 的配置异常的简单，我们仅需要一些简单的配置即可使用 MyBatis-Plus 的强大功能！  
***Spring Boot 工程***

> 配置 MapperScan 注解

@SpringBootApplication
    @MapperScan("com.baomidou.mybatisplus.samples.quickstart.mapper")
    public class Application {
        
    
        public static void main(String[] args) {
        
            SpringApplication.run(Application.class, args);
        }
    }

***Spring 工程***

> 配置 MapperScan

> 调整 SqlSessionFactory 为 MyBatis-Plus 的 SqlSessionFactory

通常来说，一般的简单工程，通过以上配置即可正常使用 MyBatis-Plus，具体可参考以下项目：Spring Boot 快速启动示例 (opens new window)、Spring MVC 快速启动示例 (opens new window)。

## 4、注解 ##

多看官网，总是有好处的。  
具体参考官网注解详说：[https://baomidou.com/pages/223848/][https_baomidou.com_pages_223848]

## 5、快速测试 ##

自动导入 MyBatis-Plus 测试所需相关配置，通过 @MybatisPlusTest 注解快速配置测试类。  
***示例工程***  
官方源码：[https://github.com/baomidou/mybatis-plus/tree/master/mybatis-plus-boot-starter-test][https_github.com_baomidou_mybatis-plus_tree_master_mybatis-plus-boot-starter-test]  
**添加测试依赖**  
Maven:

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

**编写测试用例**  
通过 @MybatisPlusTest 可快速编写 Mapper 对应的测试类，实现快速测试代码

import org.junit.jupiter.api.Test;
    import org.springframework.beans.factory.annotation.Autowired;
    
    import static org.assertj.core.api.Assertions.assertThat;
    
    @MybatisPlusTest
    class MybatisPlusSampleTest {
        
    
        @Autowired
        private SampleMapper sampleMapper;
    
        @Test
        void testInsert() {
        
            Sample sample = new Sample();
            sampleMapper.insert(sample);
            assertThat(sample.getId()).isNotNull();
        }
    }

[32ad6631b0304ba082bc274ae2cc0a47.png]: https://img-blog.csdnimg.cn/32ad6631b0304ba082bc274ae2cc0a47.png
[a951a601fedc4574b8bb514c38d6fe55.png]: https://img-blog.csdnimg.cn/a951a601fedc4574b8bb514c38d6fe55.png
[https_baomidou.com_pages_223848]: https://baomidou.com/pages/223848/
[https_github.com_baomidou_mybatis-plus_tree_master_mybatis-plus-boot-starter-test]: https://github.com/baomidou/mybatis-plus/tree/master/mybatis-plus-boot-starter-test