MyBatis Plus自动填充，逻辑删除，分页，主键策略和乐观锁

MyBatis Plus

1 MyBatis Plus简介

1.1 概述

官网：http://mp.baomidou.com/

参考教程：http://mp.baomidou.com/guide/

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

1.2 特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作
• 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求
• 支持 Lambda 形式调用：通过 Lambda 表达式，方便的编写各类查询条件，无需再担心字段写错
• 支持多种数据库：支持 MySQL、MariaDB、Oracle、DB2、H2、HSQL、SQLite、Postgre、SQLServer2005、SQLServer 等多种数据库
• 支持主键自动生成：支持多达 4 种主键策略（内含分布式唯一 ID 生成器 - Sequence），可自由配置，完美解决主键问题
• 支持 XML 热加载：Mapper 对应的 XML 支持热加载，对于简单的 CRUD 操作，甚至可以无 XML 启动
• 支持 ActiveRecord 模式：支持 ActiveRecord 形式调用，实体类只需继承 Model 类即可进行强大的 CRUD 操作
• 支持自定义全局通用操作：支持全局通用方法注入（ Write once, use anywhere ）
• 支持关键词自动转义：支持数据库关键词（order、key…）自动转义，还可自定义关键词
• 内置代码生成器：采用代码或者 Maven 插件可快速生成 Mapper 、 Model 、 Service 、 Controller 层代码，支持模板引擎，更有超多自定义配置等您来使用
• 内置分页插件：基于 MyBatis 物理分页，开发者无需关心具体操作，配置好插件之后，写分页等同于普通 List 查询
• 内置性能分析插件：可输出 Sql 语句以及其执行时间，建议开发测试时启用该功能，能快速揪出慢查询
• 内置全局拦截插件：提供全表 delete 、 update 操作智能分析阻断，也可自定义拦截规则，预防误操作
• 内置 Sql 注入剥离器：支持 Sql 注入剥离，有效预防 Sql 注入攻击

2 MyBatis Plus入门

快速开始参考：http://mp.baomidou.com/guide/quick-start.html

本次测试项目： mybatis_plus

数据库：mybatis_plus

2.1 创建数据库和表

创建数据库：mybatis_plus

CREATE DATABASE mybatis_plus DEFAULT CHARACTER SET utf8;

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

其对应的数据库 Data 脚本如下：

DELETE FROM user;

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');

2.2 创建工程

工具是IDEA，使用 Spring Initializr 快速初始化一个 Spring Boot（版本：2.2.1.RELEASE） 工程，如果没有改版本选择，可以先选择其他的，然后再修改pom文件里面的版本号即可。

注意：要在idea中安装lombok插件，因为我们要用到lombok来简化实体类。

2.2.1 pom.xml

<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.0modelVersion>
    <parent>
        <groupId>org.springframework.bootgroupId>
        <artifactId>spring-boot-starter-parentartifactId>
        <version>2.2.1.RELEASEversion>
        <relativePath/> 
    parent>
    <groupId>com.zdwhonggroupId>
    <artifactId>mybaits-plusartifactId>
    <version>0.0.1-SNAPSHOTversion>
    <name>mybaits-plusname>
    <description>Demo project for Spring Bootdescription>

    <properties>
        <java.version>1.8java.version>
    properties>

    <dependencies>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starterartifactId>
        dependency>
        <dependency>
            <groupId>org.springframework.bootgroupId>
            <artifactId>spring-boot-starter-testartifactId>
            <scope>testscope>
            <exclusions>
                <exclusion>
                    <groupId>org.junit.vintagegroupId>
                    <artifactId>junit-vintage-engineartifactId>
                exclusion>
            exclusions>
        dependency>
        
        <dependency>
            <groupId>com.baomidougroupId>
            <artifactId>mybatis-plus-boot-starterartifactId>
            <version>3.0.5version>
        dependency>
        
        <dependency>
            <groupId>mysqlgroupId>
            <artifactId>mysql-connector-javaartifactId>
        dependency>
        
        <dependency>
            <groupId>org.projectlombokgroupId>
            <artifactId>lombokartifactId>
        dependency>
    dependencies>

    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.bootgroupId>
                <artifactId>spring-boot-maven-pluginartifactId>
            plugin>
        plugins>
    build>
project>

**注意：**引入 MyBatis-Plus 之后请不要再次引入 MyBatis 以及 MyBatis-Spring，以避免因版本差异导致的问题。

2.2.2 application.properties

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

mysql5的配置：

#mysql数据库连接
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://192.168.56.102:3306/mybatis_plus
spring.datasource.username=root
spring.datasource.password=123456

192.168.56.102是我的虚拟机的IP，我的mysql是安装在虚拟机的docker容器中

mysql8以上（spring boot 2.1） **注意：**driver和url的变化

spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://192.168.56.102:3306/mybatis_plus?serverTimezone=GMT%2B8
spring.datasource.username=root
spring.datasource.password=123456

注意：

1、这里的 url 使用了 ?serverTimezone=GMT%2B8 后缀，因为Spring Boot 2.1 集成了 8.0版本的jdbc驱动，这个版本的 jdbc 驱动需要添加这个后缀，否则运行测试用例报告如下错误：

java.sql.SQLException: The server time zone value ‘Öйú±ê׼ʱ¼ä’ is unrecognized or represents more

2、这里的 driver-class-name 使用了 com.mysql.cj.jdbc.Driver ，在 jdbc 8 中 建议使用这个驱动，之前的 com.mysql.jdbc.Driver 已经被废弃，否则运行测试用例的时候会有 WARN 信息

2.2.3 主启动类

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

**注意：**扫描的包名根据实际情况修改

package com.zdwhong.mybaitsplus;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;

@SpringBootApplication
@MapperScan("com.zdwhong.mybaitsplus.mapper")
public class MybaitsPlusApplication {
    public static void main(String[] args) {
        SpringApplication.run(MybaitsPlusApplication.class, args);
    }
}

2.3 代码编写

2.3.1 实体类

创建包 entity 编写实体类 User.java（此处使用了 Lombok 简化代码）

package com.zdwhong.mybaitsplus.entity;

import lombok.Data;

/**
 * @author zdwhong
 * @create 2020-05-13 22:25
 */
@Data
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

Lombok使用参考：https://blog.csdn.net/motui/article/details/79012846

2.3.2 mapper

创建包 mapper 编写Mapper 接口： UsjerMapper.java

package com.zdwhong.mybaitsplus.mapper;

import com.baomidou.mybatisplus.core.mapper.BaseMapper;
import com.zdwhong.mybaitsplus.entity.User;

/**
 * @author zdwhong
 * @create 2020-05-13 22:27
 */
public interface UserMapper extends BaseMapper<User> {
}

UserMapper.java 继承了 BaseMapper，他是Mybatis Plus提供的，封装了增删改查，分页等方法。

2.3.3 测试

在SpringBoot自动生成的测试类中，进行功能测试：

package com.zdwhong.mybaitsplus;

import com.zdwhong.mybaitsplus.entity.User;
import com.zdwhong.mybaitsplus.mapper.UserMapper;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

import java.util.List;

@SpringBootTest
class MybaitsPlusApplicationTests {

    @Autowired
    UserMapper userMapper;

    @Test
    void contextLoads() {
        System.out.println(("----- selectAll method test ------"));
        //UserMapper 中的 selectList() 方法的参数为 MP 内置的条件封装器 Wrapper
        //所以不填写就是无任何条件
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

}

注意：

IDEA在 userMapper 处报错，因为找不到注入的对象，因为类是动态创建的，但是程序可以正确的执行。为了避免报错，可以在 dao 层 的接口上添加 @Repository 注解。不过不加也没事，不会影响程序运行。

通过以上几个简单的步骤，我们就实现了 User 表的 CRUD 功能，甚至连 XML 文件都不用编写！

2.4 查看sql输出日志

在配置文件中加上下面的配置，就能打出完整的sql：

#mybatis日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

3 主键策略

3.1 ID_WORKER

MyBatis-Plus默认的主键策略是：ID_WORKER 全局唯一ID

**参考资料：分布式系统唯一ID生成方案汇总：**https://www.cnblogs.com/haoxinyue/p/5208136.html

3.2 自增策略

• 要想主键自增需要配置如下主键策略

• • 需要在创建数据表的时候设置主键自增
  • 实体字段中配置 @TableId(type = IdType.AUTO)

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

要想影响所有实体的配置，可以设置全局主键配置：

#全局设置主键生成策略
mybatis-plus.global-config.db-config.id-type=auto

其它主键策略：分析 IdType 源码可知：

package com.baomidou.mybatisplus.annotation;

public enum IdType {
    AUTO(0),//数据库自增
    NONE(1),// 该类型为未设置主键类型
    INPUT(2),//用户输入ID，该类型可以通过自己注册自动填充插件进行填充
    
    /* 以下3种类型、只有当插入对象ID 为空，才自动填充。 */
    ID_WORKER(3),//全局唯一ID (idWorker)，通过雪花算法实现
    
    
    UUID(4),//全局唯一ID (UUID)
    ID_WORKER_STR(5);//字符串全局唯一ID (idWorker 的字符串表示)

    private int key;

    private IdType(int key) {
        this.key = key;
    }

    public int getKey() {
        return this.key;
    }
}

3.3 测试新增操作

@Test
public void testInsert(){
    User user = new User();
    user.setName("Helen");
    user.setAge(18);
    user.setEmail("[email protected]");
    int result = userMapper.insert(user);
    System.out.println(result); //影响的行数
    System.out.println(user); //id自动回填
}

执行之后，插入到数据库的记录，id的值是一个19位的：1260586983642681345 （Long），这是MP默认的主键策略。

4 自动填充

项目中经常会遇到一些数据，每次都使用相同的方式填充，例如记录的创建时间，更新时间等。

我们可以使用MyBatis Plus的自动填充功能，完成这些字段的赋值工作：

4.1 数据库表中添加自动填充字段

在User表中添加datetime类型的新的字段 create_time、update_time

ALTER TABLE `mybatis_plus`.`user`   
  ADD COLUMN `create_time` DATETIME NULL   COMMENT '创建时间' AFTER `create_time`;

ALTER TABLE `mybatis_plus`.`user`   
  ADD COLUMN `update_time` DATETIME NULL   COMMENT '修改时间' AFTER `create_time`;

4.2 实体修改

package com.zdwhong.mybaitsplus.entity;

import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.TableField;
import lombok.Data;

import java.util.Date;

/**
 * @author zdwhong
 * @create 2020-05-13 22:25
 */
@Data
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
    
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    
    //@TableField(fill = FieldFill.UPDATE)
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
}

在createTime 上添加主键 @TableField(fill = FieldFill.INSERT) 表示新增操作的时候，会自动填充时间，在updateTime 上添加主键 @TableField(fill = FieldFill.INSERT_UPDATE) 表示新增胡或修改操作的时候，会自动填充时间。

4.3 实现元对象处理器接口

注意：不要忘记添加 @Component 注解，必须要交给IOC容器管理：

package com.zdwhong.mybaitsplus.config;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.util.Date;

/**
 * @author zdwhong
 * @create 2020-05-13 23:21
 */
@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill ....");
        //这里的 createTime 和updateTime是User实体的属性名称，而不是表里面的字段名称
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

4.4 测试修改

@Test
public void testUpdateById(){
    User user = new User();
    user.setId(1L);
    user.setAge(28);
    int result = userMapper.updateById(user);
    System.out.println(result);
}

执行修改操作的话，我们的updateTime会更新，我们也可以再次执行上面的新增操作，发现createTime和updateTime都会插入数据。

5 乐观锁

5.1 简介

**主要适用场景：**当要更新一条记录的时候，希望这条记录没有被别人更新，也就是说实现线程安全的数据更新；

乐观锁实现方式：

• 取出记录时，获取当前version
• 更新时，带上这个version
• 执行更新时， set version = newVersion where version = oldVersion
• 如果version不对，就更新失败

5.2 演示乐观锁

5.2.1 数据库表中添加version字段

ALTER TABLE `user` ADD COLUMN `version` INT

我们手动把第一条记录的version字段改为1；

5.2.2 实体类添加version字段

User实体类添加version字段，并添加 @Version 注解

@Version
@TableField(fill = FieldFill.INSERT)
private Integer version;

5.2.3 元对象处理器接口添加version的insert默认值

package com.zdwhong.mybaitsplus.config;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.util.Date;

/**
 * @author zdwhong
 * @create 2020-05-13 23:21
 */
@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill ....");
        //这里的 createTime 和updateTime是User实体的属性名称，而不是表里面的字段名称
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);

        //乐观锁version，新增记录的时候，默认填充 version的值为：1
        this.setFieldValByName("version", 1, metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

this.setFieldValByName("version", 1, metaObject);

特别说明:

• 支持的数据类型只有 int，Integer，long，Long，Date，Timestamp，LocalDateTime

• 整数类型下 `newVersion = oldVersion + 1``

• ``newVersion会回写到entity` 中

• 仅支持 updateById(id) 与 update(entity, wrapper) 方法

• 在 update(entity, wrapper) 方法下, wrapper 不能复用!!!

5.2.4 在 MybatisPlusConfig 中注册 Bean

创建配置类MybatisPlusConfig ，在MybatisPlusConfig 中配置乐观锁插件 OptimisticLockerInterceptor ：

package com.zdwhong.mybaitsplus.config;

import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.transaction.annotation.EnableTransactionManagement;

/**
 * @author zdwhong
 * @create 2020-05-14 21:12
 */
@Configuration
@EnableTransactionManagement
public class MybatisPlusConfig {

    /**
     * 乐观锁插件
     */
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
}

5.2.4 测试乐观锁修改成功

测试后分析打印的sql语句，将version的数值进行了加1操作

/**
     * 测试 乐观锁插件
     */
@Test
public void testOptimisticLocker() {
    //查询
    User user = userMapper.selectById(1L);
    //修改数据
    user.setName("Helen Yao");
    user.setEmail("[email protected]");
    //执行更新
    userMapper.updateById(user);
}

5.2.5 测试乐观锁修改失败

模拟取出数据后，数据库中version实际数据比取出的值大，即已被其它线程修改并更新了version

/**
     * 测试乐观锁插件 失败
     */
@Test
public void testOptimisticLockerFail() {
    //查询
    User user = userMapper.selectById(1L);
    //修改数据
    user.setName("Helen Yao1");
    user.setEmail("[email protected]");
    //模拟取出数据后，数据库中version实际数据比取出的值大，即已被其它线程修改并更新了version
    user.setVersion(user.getVersion() - 1);
    //执行更新
    userMapper.updateById(user);
}

6 逻辑删除

6.1简介

• 物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除数据；

• 逻辑删除：假删除，将对应数据中代表是否被删除字段状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录；

MyBatis Plus可以配置来实现逻辑删除；

6.2 演示逻辑删除

6.2.1 数据库中添加 deleted字段

deleted字段是一个逻辑删除的标识位，1表示已删除，0表示未删除，默认值是0.

ALTER TABLE `user` ADD COLUMN `deleted` boolean

我们手动把第一条记录的deleted字段改为0；

6.2.2 实体类添加deleted 字段

实体类添加deleted 字段，并加上 @TableLogic 注解 和 @TableField(fill = FieldFill.INSERT) 注解

@TableLogic
@TableField(fill = FieldFill.INSERT)
private Integer deleted;

6.2.3 元对象处理器接口添加deleted的insert默认值

package com.zdwhong.mybaitsplus.config;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import lombok.extern.slf4j.Slf4j;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.util.Date;

/**
 * @author zdwhong
 * @create 2020-05-13 23:21
 */
@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill ....");
        //这里的 createTime 和updateTime是User实体的属性名称，而不是表里面的字段名称
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);

        //乐观锁version，新增记录的时候，默认填充 version的值为：1
        this.setFieldValByName("version", 1, metaObject);

        //乐观锁deleted，新增记录的时候，默认填充 deleted的值为：0 表示未删除
        this.setFieldValByName("deleted",0,metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

this.setFieldValByName("deleted",0,metaObject);

6.2.4 application.properties 加入配置

此为默认值，如果你的默认值和mp默认的一样,该配置可无

#逻辑删除的配置，1表示逻辑已删除，0表示未删除
mybatis-plus.global-config.db-config.logic-delete-value=1
mybatis-plus.global-config.db-config.logic-not-delete-value=0

6.2.5 在 MybatisPlusConfig 中注册 ISqlInjector

 /**
     * 配置逻辑删除插件
     */
@Bean
public ISqlInjector sqlInjector(){
    return new LogicSqlInjector();
}

6.2.6 测试逻辑删除

• 测试后发现，数据并没有被删除，deleted字段的值由0变成了1
• 测试后分析打印的sql语句，是一条update
• **注意：**被删除数据的deleted 字段的值必须是 0，才能被选取出来执行逻辑删除的操作

 /**
     * 测试 逻辑删除
     */
@Test
public void testLogicDelete() {
    int result = userMapper.deleteById(1L);
    System.out.println(result);
}

==>  Preparing: UPDATE user SET deleted=1 WHERE id=? AND deleted=0 
==> Parameters: 1(Long)
<==    Updates: 1

6.2.7 测试逻辑删除后的查询

MyBatis Plus中查询操作也会自动添加逻辑删除字段的判断

/**
     * 测试 逻辑删除后的查询：
     * 不包括被逻辑删除的记录
     */
@Test
public void testLogicDeleteSelect() {
    User user = new User();
    List<User> users = userMapper.selectList(null);
    users.forEach(System.out::println);
}

测试后分析打印的sql语句，包含 WHERE deleted=0

==>  Preparing: SELECT id,name,age,email,create_time,update_time,version,deleted FROM user WHERE deleted=0 
==> Parameters: 
<==    Columns: id, name, age, email, create_time, update_time, version, deleted
<==        Row: 2, Jack, 20, test2@baomidou.com, null, null, null, 0
<==        Row: 3, Tom, 28, test3@baomidou.com, null, null, null, 0
<==        Row: 4, Sandy, 21, test4@baomidou.com, null, null, null, 0
<==        Row: 5, Billie, 24, test5@baomidou.com, null, null, null, 0
<==      Total: 4

7 性能分析

性能分析拦截器，用于输出每条 SQL 语句及其执行时间

SQL 性能执行分析，开发环境使用，超过指定时间，停止运行。有助于发现问题

7.1 配置插件

7.1.1 在 MybatisPlusConfig 中配置插件PerformanceInterceptor

/**
     * SQL 执行性能分析插件
     * 开发环境使用，线上不推荐。 maxTime 指的是 sql 最大执行时长
     */
@Bean
@Profile({"dev","test"})// 设置 dev test 环境开启
public PerformanceInterceptor performanceInterceptor() {
    PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
    performanceInterceptor.setMaxTime(100);//ms，超过此处设置的ms则sql不执行
    performanceInterceptor.setFormat(true);
    return performanceInterceptor;
}

参数：maxTime： SQL 执行最大时长，超过自动停止运行，有助于发现问题。

参数：format： SQL是否格式化，默认false。

7.1.2 Spring Boot 中设置dev环境

#环境设置：dev、test、prod
spring.profiles.active=dev

可以针对各环境新建不同的配置文件application-dev.properties、application-test.properties、application-prod.properties

也可以自定义环境名称：如test1、test2

7.2 测试性能分析插件

7.2.1 常规测试

/**
     * 测试 性能分析插件
     */
@Test
public void testPerformance() {
    User user = new User();
    user.setName("我是Helen");
    user.setEmail("[email protected]");
    user.setAge(18);
    userMapper.insert(user);
}

控制台日志输出

==>  Preparing: INSERT INTO user ( id, name, age, email, create_time, update_time, version, deleted ) VALUES ( ?, ?, ?, ?, ?, ?, ?, ? ) 
==> Parameters: 1260930137399005186(Long), 我是Helen(String), 18(Integer), helen@sina.com(String), 2020-05-14 21:49:06.364(Timestamp), 2020-05-14 21:49:06.364(Timestamp), 1(Integer), 0(Integer)
<==    Updates: 1
 Time：14 ms - ID：com.zdwhong.mybaitsplus.mapper.UserMapper.insert
Execute SQL：
    INSERT 
    INTO
        user
        ( id, name, age, email, create_time, update_time, version, deleted ) 
    VALUES
        ( 1260930137399005186, '??Helen', 18, '[email protected]', '2020-05-14 21:49:06.364', '2020-05-14 21:49:06.364', 1, 0 )

Time：14 ms

7.2.2 将maxTime 改小之后再次进行测试

将maxTime 改小之后再次进行测试

performanceInterceptor.setMaxTime(5);//ms，超过此处设置的ms则sql不执行

然后再次执行上面的测试方法，如果执行时间过长，则抛出异常：The SQL execution time is too large，控制台日志输出：

### SQL: INSERT INTO user  ( id, name, age, email, create_time, update_time, version, deleted )  VALUES  ( ?, ?, ?, ?, ?, ?, ?, ? )
### Cause: com.baomidou.mybatisplus.core.exceptions.MybatisPlusException:  The SQL execution time is too large, please optimize ! 

8 其他操作查询和删除操作

8.1 select操作

8.1.1 根据ID查询

@Test
public void testSelectById(){
    User user = userMapper.selectById(1L);
    System.out.println(user);
}

8.1.2 通过多个ID批量查询

完成了动态sql的foreach的功能

@Test
public void testSelectBatchIds(){
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1, 2, 3));
    users.forEach(System.out::println);
}

8.1.3 简单的条件查询

通过map封装查询条件

@Test
public void testSelectByMap(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name", "Helen");
    map.put("age", 18);
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

**注意：**map中的key对应的是数据库中的列名。例如数据库user_id，实体类是userId，这时map的key需要填写user_id

8.1.4 分页查询

MyBatis Plus自带分页插件，只要简单的配置即可实现分页功能：

1、配置类中配置分页插件

/**
     * 分页插件
     */
@Bean
public PaginationInterceptor paginationInterceptor() {
    return new PaginationInterceptor();
}

2、测试selectPage分页

**测试：**最终的分页查询结果都会封装到Page对象中，通过page对象获取相关数据，

@Test
public void testSelectPage() {
    Page<User> page = new Page<>(1,5);
    userMapper.selectPage(page, null);
    page.getRecords().forEach(System.out::println);
    System.out.println(page.getCurrent());
    System.out.println(page.getPages());
    System.out.println(page.getSize());
    System.out.println(page.getTotal());
    System.out.println(page.hasNext());
    System.out.println(page.hasPrevious());
}

3、测试selectMapsPage分页：结果集是Map

@Test
public void testSelectMapsPage() {
    Page<User> page = new Page<>(1, 5);
    IPage<Map<String, Object>> mapIPage = userMapper.selectMapsPage(page, null);
    //注意：此行必须使用 mapIPage 获取记录列表，否则会有数据类型转换错误
    mapIPage.getRecords().forEach(System.out::println);
    System.out.println(page.getCurrent());
    System.out.println(page.getPages());
    System.out.println(page.getSize());
    System.out.println(page.getTotal());
    System.out.println(page.hasNext());
    System.out.println(page.hasPrevious());
}

8.2 delete操作

这里的删除都是逻辑删除了，因为我们前面配置了逻辑删除。

8.2.1 根据ID删除

@Test
public void testDeleteById(){
    int result = userMapper.deleteById(8L);
    System.out.println(result);
}

8.2.2 批量删除

@Test
public void testDeleteBatchIds() {
    int result = userMapper.deleteBatchIds(Arrays.asList(3, 4));
    System.out.println(result);
}

8.2.3 简单的Map条件删除

@Test
public void testDeleteByMap() {
    HashMap<String, Object> map = new HashMap<>();
    map.put("name", "Helen");
    map.put("age", 18);
    int result = userMapper.deleteByMap(map);
    System.out.println(result);
}

9 添加构造器wapper

9.1 简介

Wrapper ： 条件构造抽象类，最顶端父类

AbstractWrapper ： 用于查询条件封装，生成 sql 的 where 条件

​ QueryWrapper ： Entity 对象封装操作类，不是用lambda语法

​ UpdateWrapper ： Update 条件封装，用于Entity对象更新操作

AbstractLambdaWrapper ： Lambda 语法使用 Wrapper统一处理解析 lambda 获取 column。

LambdaQueryWrapper ：看名称也能明白就是用于Lambda语法使用的查询Wrapper

​ LambdaUpdateWrapper ： Lambda 更新封装Wrapper

9.2 AbstractWrapper

**注意：**以下条件构造器的方法入参中的 column均表示数据库字段

9.2.1 ge、gt、le、lt、isNull、isNotNull

@Test
public void testDelete() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper
        .isNull("name")
        .ge("age", 12)
        .isNotNull("email");
    int result = userMapper.delete(queryWrapper);
    System.out.println("delete return count = " + result);
}

SQL：UPDATE user SET deleted=1 WHERE deleted=0 AND name IS NULL AND age >= ? AND email IS NOT NULL

9.2.2 eq、ne

注意：seletOne返回的是一条实体记录，当出现多条时会报错

@Test
public void testSelectOne() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.eq("name", "Tom");
    User user = userMapper.selectOne(queryWrapper);
    System.out.println(user);
}

9.2.3 between、notBetween

包含大小边界

@Test
public void testSelectCount() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.between("age", 20, 30);
    Integer count = userMapper.selectCount(queryWrapper);
    System.out.println(count);
}

9.2.4 allEq

@Test
public void testSelectList() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    Map<String, Object> map = new HashMap<>();
    map.put("id", 2);
    map.put("name", "Jack");
    map.put("age", 20);
    queryWrapper.allEq(map);
    List<User> users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}

SELECT id,name,age,email,create_time,update_time,deleted,version 
FROM user WHERE deleted=0 AND name = ? AND id = ? AND age = ? 

9.2.5 like、notLike、likeLeft、likeRight

selectMaps返回Map集合列表

@Test
public void testSelectMaps() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper
        .notLike("name", "e")
        .likeRight("email", "t");
    List<Map<String, Object>> maps = userMapper.selectMaps(queryWrapper);//返回值是Map列表
    maps.forEach(System.out::println);
}

SELECT id,name,age,email,create_time,update_time,deleted,version 
FROM user WHERE deleted=0 AND name NOT LIKE ? AND email LIKE ? 

9.2.6 in、notIn、inSql、notinSql、exists、notExists

in、notIn：

• notIn("age",{1,2,3})—>age not in (1,2,3)
• notIn("age", 1, 2, 3)—>age not in (1,2,3)

inSql、notinSql：可以实现子查询

• 例: inSql("age", "1,2,3,4,5,6")—>age in (1,2,3,4,5,6)
• 例: inSql("id", "select id from table where id < 3")—>id in (select id from table where id < 3)

@Test
public void testSelectObjs() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    //queryWrapper.in("id", 1, 2, 3);
    queryWrapper.inSql("id", "select id from user where id < 3");
    List<Object> objects = userMapper.selectObjs(queryWrapper);//返回值是Object列表
    objects.forEach(System.out::println);
}

SELECT id,name,age,email,create_time,update_time,deleted,version 
FROM user WHERE deleted=0 AND id IN (select id from user where id < 3) 

9.2.7 or and

**注意：**这里使用的是 UpdateWrapper

不调用or则默认为使用 and连

@Test
public void testUpdate1() {
    //修改值
    User user = new User();
    user.setAge(99);
    user.setName("Andy");
    //修改条件
    UpdateWrapper<User> userUpdateWrapper = new UpdateWrapper<>();
    userUpdateWrapper
        .like("name", "h")
        .or()
        .between("age", 20, 30);
    int result = userMapper.update(user, userUpdateWrapper);
    System.out.println(result);
  }  

UPDATE user SET name=?, age=?, update_time=? WHERE deleted=0 AND name LIKE ? OR age BETWEEN ? AND ?

嵌套or、嵌套and

这里使用了lambda表达式，or中的表达式最后翻译成sql时会被加上圆括号

@Test
public void testUpdate2() {
    //修改值
    User user = new User();
    user.setAge(99);
    user.setName("Andy");
    //修改条件
    UpdateWrapper<User> userUpdateWrapper = new UpdateWrapper<>();
    userUpdateWrapper
        .like("name", "h")
        .or(i -> i.eq("name", "李白").ne("age", 20));
    int result = userMapper.update(user, userUpdateWrapper);
    System.out.println(result);
}

UPDATE user SET name=?, age=?, update_time=? 
WHERE deleted=0 AND name LIKE ? 
OR ( name = ? AND age <> ? ) 

9.2.8 orderBy、orderByDesc、orderByAsc

@Test
public void testSelectListOrderBy() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.orderByDesc("id");
    List<User> users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}

SELECT id,name,age,email,create_time,update_time,deleted,version 
FROM user WHERE deleted=0 ORDER BY id DESC 

9.2.9 last

直接拼接到 sql 的最后

**注意：**只能调用一次，多次调用以最后一次为准 ，有sql注入的风险，请谨慎使用

@Test
public void testSelectListLast() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.last("limit 1");
    List<User> users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}

SELECT id,name,age,email,create_time,update_time,deleted,version 
FROM user WHERE deleted=0 limit 1 

9.2.10 指定要查询的列

@Test
public void testSelectListColumn() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.select("id", "name", "age");
    List<User> users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}

SELECT id,name,age FROM user WHERE deleted=0 

9.2.11 set、setSql

最终的sql会合并 user.setAge()，以及 userUpdateWrapper.set() 和 setSql() 中 的字段

@Test
public void testUpdateSet() {
    //修改值
    User user = new User();
    user.setAge(99);
    //修改条件
    UpdateWrapper<User> userUpdateWrapper = new UpdateWrapper<>();
    userUpdateWrapper
        .like("name", "h")
        .set("name", "老李头")//除了可以查询还可以使用set设置修改的字段
        .setSql(" email = '[email protected]'");//可以有子查询
    int result = userMapper.update(user, userUpdateWrapper);
}

UPDATE user SET age=?, update_time=?, name=?, email = '[email protected]' WHERE deleted=0 AND name LIKE ? 

QueryWrapper queryWrapper = new QueryWrapper<>();
queryWrapper.last("limit 1");
List users = userMapper.selectList(queryWrapper);
users.forEach(System.out::println);

}

```sql
SELECT id,name,age,email,create_time,update_time,deleted,version 
FROM user WHERE deleted=0 limit 1 

9.2.10 指定要查询的列

@Test
public void testSelectListColumn() {
    QueryWrapper<User> queryWrapper = new QueryWrapper<>();
    queryWrapper.select("id", "name", "age");
    List<User> users = userMapper.selectList(queryWrapper);
    users.forEach(System.out::println);
}

SELECT id,name,age FROM user WHERE deleted=0 

9.2.11 set、setSql

最终的sql会合并 user.setAge()，以及 userUpdateWrapper.set() 和 setSql() 中 的字段

@Test
public void testUpdateSet() {
    //修改值
    User user = new User();
    user.setAge(99);
    //修改条件
    UpdateWrapper<User> userUpdateWrapper = new UpdateWrapper<>();
    userUpdateWrapper
        .like("name", "h")
        .set("name", "老李头")//除了可以查询还可以使用set设置修改的字段
        .setSql(" email = '[email protected]'");//可以有子查询
    int result = userMapper.update(user, userUpdateWrapper);
}

UPDATE user SET age=?, update_time=?, name=?, email = '[email protected]' WHERE deleted=0 AND name LIKE ?