MyBatis-Plus

1 简介

MyBatis-Plus（简称 MP）是一个 MyBatis的增强工具，在 MyBatis 的基础上只做增强不做改变，为简化开发、提高效率而生（官方网址)。

2 特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
• 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分，CRUD 操作，更有强大的条件构造器，满足各类使用需求
• 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
• 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
• 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
• 分页插件支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer 等多种数据库

3 环境准备

要是用MyBatis-Plus我们得准备好数据库中的表数据，所需的依赖，以及部分相关代码。

3.1 数据准备

以一张简单的单表User表为例，其结构如下

对应建表语句如下

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)
);

对应数据如下

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');

3.2 工程依赖准备

创建一个SpringBoot工程(可以使用Spring Initializer)，引入如下依赖

    <dependencies>
        <!--spring boot-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
        </dependency>
        <!--spring boot test-->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!--mybatis plus-->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.5.3.1</version>
        </dependency>
        <!--mysql驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <scope>runtime</scope>
        </dependency>
        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
    </dependencies>

注意：导入的是spring-boot-starter包而不是spring-boot-starter-web包，spring-boot-starter-web包里内嵌Tomcat依赖，而spring-boot-starter包里没有Tomcat依赖。

写一个启动类：

@SpringBootApplication
public class MybatisPlusDemoApplication {
   

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

在application.yml中添加如下配置:

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/mybatis-plus?useSSL=false&characterEncoding=utf8&serverTimezone=Asia/Shanghai
    username: root
    password: 123456
    driver-class-name: com.mysql.cj.jdbc.Driver

# 日志中输出mybatisPlus的执行SQL语句
logging:
  level:
    com.cskaoyan.mp.mapper: debug

3.3 代码准备

在启动类上加MapperScan注解

@SpringBootApplication
@MapperScan("com.cskaoyan.mp.mapper")
public class MybatisPlusDemoApplication {
   

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

定义user表对应的映射实体类User

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
   
    Long id;

    String name;

    Integer age;

    String email;
}

定义Mapper

BaseMapper是MyBatis-Plus提供的模板mapper，其中包含了基本的CRUD方法，泛型为操作的实体类型

public interface UserMapper extends BaseMapper<User> {
   
}

4 基本的CRUD

定义一个用于测试的测试类，其中包含基本CRUD的代码

@SpringBootTest(classes = MybatisPlusDemoApplication.class)
@RunWith(SpringRunner.class)    // 在高版本的springboot中， runwith是不用写的
public class BaseTest {
   
}

定义一个CRUDTest继承BaseTest，防止以后的测试类频繁加@SpringBootTest和@RunWith注解，在CRUDTest类中写测试方法进行测试。

public class CRUDTest extends BaseTest {
   

    @Autowired
    UserMapper userMapper;

4.1 新增数据

    @Test
    public void testInsert(){
   
        User user = new User();
        //user.setId(1001L);
        user.setName("金莲");
        user.setAge(35);
        user.setEmail("jinlian@qq.com");

        int affectedRows = userMapper.insert(user);
        System.out.println(affectedRows);

        System.out.println(user);
    }

关于insert，还有几点需要注意：

1. 如果id没有指定，默认策略： id 是由mybatisPlus的内置的（雪花）算法，给我们生成的唯一id
2. 如果id没有指定，那么在insert之后，mybatisPlus会给参数的user对象中的id 赋值 （相当于MyBatis中useGeneratedKeys = true）

注意： MyBatis-Plus在实现插入数据时，会默认基于雪花算法的策略生成id

4.2 删除数据

4.2.1 根据id删除

/**
 * 通过id删除
 */
@Test
public void testDeleteById(){
   
    int affectedRows = userMapper.deleteById(1788577219342254081L);
    System.out.