MyBatis-Plus

提示：为了记录知识点，将本人CSDN博客作为笔记使用，所以有些文章可能一字不差的拷贝自其它好心大神，本文拷贝地址：https://blog.csdn.net/zdsg45/article/details/105138493/

简介

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

愿景

我们的愿景是称为MyBatis的最好搭档，就像魂斗罗中的 1P、2P，基友搭配，效率翻倍。

特性

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

快速指南

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

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

使用第三方组件：

1. 导入对应的依赖
2. 研究依赖如何配置
3. 代码如何编写
4. 提高技术能力

步骤 1.创建数据库表

现有一张 User 表，其表结构如下： 其对应的 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 脚本如下：

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

2.导入相应的依赖

         mysql
         mysql-connector-java
         runtime
     

	
        com.baomidou
        mybatis-plus-boot-starter
        3.3.1.tmp
    

	 
         org.projectlombok
         lombok
         1.18.10
         provided
     

说明：我们使用 MyBatis-Plus 可以节省我们大量的代码，尽量不要同时导入 Mybatis 和 MyBatis-Plus！版本差异！

3.连接数据库

# mysql 5 驱动不同 com.mysql.jsbc.Driver

# mysql 8 驱动不同 com.mysql.cj.jsbc.Driver、需要增加时区的配置
spring.datasource.username=root
spring.datasource.password=123
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

4.编写代码

pojo->dao->(连接MyBatis，配置mapper.xml文件)->service、controller(传统方式) 使用Mybatis-Plus之后

* pojo
* dao接口（不用写mapper.xml文件）
* 使用

编写实体类 User.java （此处使用Lombok简化代码）

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

编写 Mapper 类 UserMapper.java

//在对应的Mapper上继承基本的类baseMapper
public interface UserMapper extends BaseMapper {
    //所有的CRUD已经编写完成
    //不需要像以前的配置一些xml

}

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

@SpringBootApplication
@MapperScan("com.baomidou.mybatisplus.mapper")//扫描mapper文件夹
public class Application {

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

}

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

@RunWith(SpringRunner.class)
@SpringBootTest
public class SampleTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    public void testSelect() {
        System.out.println(("----- selectAll method test ------"));
        //参数是一个Wrapper，条件结构器，这里先不用 填null
        //查询所有的用户 
        List userList = userMapper.selectList(null);
        Assert.assertEquals(5, userList.size());
        userList.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)

5.小结

通过以上几个简单的步骤，我们实现了 User 表的 CRUD 功能，甚至连 XML 文件都不用编写！ 从以上步骤中，我们可以看到 MyBatis-Plus 非常的简单，只需要引入 starter 工程，并配置 mapper 扫描路径即可。 但 MyBatis-Plus 的强大远不止这些功能，想要详细了解 MyBatis-Plus 的强大功能继续往下看吧！

配置日志

我们所用的SQL现在是不可见的，我们希望知道他是怎么执行的，所以我们必须要查看日志！

mybatis-plus:
  configuration:
    #打印SQL语句
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

常用注解

@TableName(“表名”)：当表名与实体类名不一致时，可以在实体类上加入 @TableName() 声明 @TableId：声明属性为表中的主键（若属性名称不为默认id） @TableField(“字段”)：当实体类属性与表字段不一致时，可以用来声明

@TableName("表名")
public class User{
    
    @TableId
    private Long userId;
    @TableFieId("name")
    private String realName
        
}  

CURD扩展 insert 插入

// 插入一条记录
int insert(T entity);

举例测试

@Test
    public void testInsert() {
        System.out.println(("----- selectAll method test ------"));
        User user = new User();
        user.setName=("shuishui");
        user.setAge(3);
        user.setEmail("12434141@qq.com");
        
        userMapper.insert(user);
    }

数据库插入的id为全局默认的id（ID_WORKER）

主键生成策略

public enum IdType {
    AUTO(0),   //数据库自增
    NONE(1),   //自动生成主键，使用雪花算法
    INPUT(2),   //开发者手动赋值，如果插入操作中没有对id进行赋值，那么存进数据库中的将为0(long)
    ID_WORKER(3), //默认的全局唯一id
    UUID(4),  //要求主键必须是String类型，全局唯一id uuid
    ID_WORKER_STR(5); // ID_WORKEK 字符串表示法

    private int key;

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

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

分布式系统唯一ID生成：雪花算法 SnowFlake 算法，是 Twitter 开源的分布式 id 生成算法。其核心思想就是：使用一个 64bit 的 long 类型的数字作为全局唯一id。在分布式系统中应用十分广泛，且 ID 引入了时间戳，基本上保持自增的。 这 64 个 bit 中，其中 1 个 bit 是不用的，然后用其中的 41 bit 作为毫秒数，用 10 bit 作为工作机器 id，12 bit 作为序列号。

更新操作

// 根据 whereEntity 条件，更新记录
int update(@Param(Constants.ENTITY) T entity, @Param(Constants.WRAPPER) Wrapper updateWrapper);
// 根据 ID 修改
int updateById(@Param(Constants.ENTITY) T entity);

举例说明

@Test
    public void testUpdate() {
        //sql自动动态配置
        User user = new User();
        user.setName=("shui");
        user.setId(3L);
        user.setAge("18");
        
        //注意：updateById的参数是一个对象
        userMapper.updateById(user);
    }

自动填充

创建时间、修改时间，这些操作一般都是自动化完成，我们不希望手动更新！ 阿里巴巴开发手册：所有的数据库表：gmt_create、gmt_modified几乎所有的表都要配置上！而且需要自动化 方式一：数据库级别 在表中新增字段 create_time、update_time(默认CURRENT_TIMESIAMP) 方式二：代码级别 实体类上的属性需要增加注解 @TableField

//创建时间
@TableField(fill = FieldFill.INSERT)
private Date createTime;

//更新时间 
@TableField(fill = FieldFill.INSERT_UPDATE)
private Date updateTime;

编写处理器来处理这个注释即可！

@Slf4j
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    //插入时候的填充策略
    @Override
    @Componcent  //一定不要忘记吧处理器加到IOC容器中
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill ....");  //日志
        //设置字段的值（String fieldName字段名,Object fieldVal要传递的值,MetaObject metaObject)
        this.setFieldVaLByName("createTime",new Date(),metaObject);
        this.setFieldVaLByName("createTime",new Date(),metaObject);
        
        
        //this.strictInsertFill(metaObject, "createTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐使用)
       // this.fillStrategy(metaObject, "createTime", LocalDateTime.now()); // 也可以使用(3.3.0 该方法有bug请升级到之后的版本如`3.3.1.8-SNAPSHOT`)
        /* 上面选其一使用,下面的已过时(注意 strictInsertFill 有多个方法,详细查看源码) */
        //this.setFieldValByName("operator", "Jerry", metaObject);
        //this.setInsertFieldValByName("operator", "Jerry", metaObject);
    }

    //更新时间的填充策略
    @Override
    public void updateFill(MetaObject metaObject) {
        log.info("start update fill ....");
        this.setFieldVaLByName("createTime",new Date(),metaObject);
        
        
        //this.strictUpdateFill(metaObject, "updateTime", LocalDateTime.class, LocalDateTime.now()); // 起始版本 3.3.0(推荐使用)
       // this.fillStrategy(metaObject, "updateTime", LocalDateTime.now()); // 也可以使用(3.3.0 该方法有bug请升级到之后的版本如`3.3.1.8-SNAPSHOT`)
        /* 上面选其一使用,下面的已过时(注意 strictUpdateFill 有多个方法,详细查看源码) */
        //this.setFieldValByName("operator", "Tom", metaObject);
        //this.setUpdateFieldValByName("operator", "Tom", metaObject);
    }
}

吐槽：这么麻烦，难道方式一不香吗？

乐观锁

面试中经常会问到乐观锁、悲观锁 乐观锁：顾名思义十分乐观，它总是被认为不会出现问题，无论干什么都不上锁！如果出现问题，再次更新测试 悲观锁：顾名思义十分悲观，它总是出现问题，无论干什么都会上锁！再去操作！ 乐观锁实现方式：

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

//乐观锁： 1、先查询，获得版本号 version=1
//--A
update user set name ="shuishui" ,version =version+1
where id =2 and version=1

//--B 如果线程抢先完成，这个时候version=2，会导致A修改失败
update user set name ="shuishui" ,version =version+1
where id =2 and version=1

测试乐观锁 1.表中创建乐观锁字段version默认值为1 2.同步实体类

@Version //乐观锁Version注解
private Integer version;

3.注册组件

@EnableTransactionManagement
@MapperScan("com.baomidou.cloud.service.*.mapper*")
@Configuration//配置类
public class MyBatisPlusConfig{
    //注册乐观锁插件
    @Bean
	public OptimisticLockerInterceptor optimisticLockerInterceptor() {
    	return new OptimisticLockerInterceptor();
	}
}

特别说明：

• 支持的数据类型只有int、Integer、long、Long、Date、Timestamp、LocalDateTime
• 整数类型下 newVersion = oldVersion + 1
• newVersion 会回写到 entity 中
• 仅支持 updateById(id) 与 update(entity,wrapper) 方法
• 在 update(entity,wrapper) 方法下，wrapper 不能复用！！！ 测试一下

@Test
    //测试乐观锁失败
    void testVersion() throws InterruptedException {
        //线程1
        User user1 = userService.getById(1);
        user1.setAge(20);
        //模拟另外一个线程执行了插队操作
        User user2 = userService.getById(1);
        user2.setAge(22);
        userService.updateById(user2);

        //提交失败（因为此时数据库中version已经 +1）
        boolean b = userService.updateById(user1);
        System.out.println("是否成功：" + b);//false

    }

SQL执行过程

查询操作

// 根据 ID 查询
T selectById(Serializable id);
// 根据 entity 条件，查询一条记录
T selectOne(@Param(Constants.WRAPPER) Wrapper queryWrapper);

// 查询（根据ID 批量查询）
List selectBatchIds(@Param(Constants.COLLECTION) Collection idList);
// 根据 entity 条件，查询全部记录
List selectList(@Param(Constants.WRAPPER) Wrapper queryWrapper);
// 查询（根据 columnMap 条件）
List selectByMap(@Param(Constants.COLUMN_MAP) Map columnMap);
// 根据 Wrapper 条件，查询全部记录
List selectMaps(@Param(Constants.WRAPPER) Wrapper queryWrapper);
// 根据 Wrapper 条件，查询全部记录。注意： 只返回第一个字段的值
List selectObjs(@Param(Constants.WRAPPER) Wrapper queryWrapper);

// 根据 entity 条件，查询全部记录（并翻页）
IPage selectPage(IPage page, @Param(Constants.WRAPPER) Wrapper queryWrapper);
// 根据 Wrapper 条件，查询全部记录（并翻页）
IPage selectMapsPage(IPage page, @Param(Constants.WRAPPER) Wrapper queryWrapper);
// 根据 Wrapper 条件，查询总记录数
Integer selectCount(@Param(Constants.WRAPPER) Wrapper queryWrapper);

实例测试

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

//测试批量查询
@Test
public void testSelectByBatchId(){
    List user =userMapper.selectBatchIds(Arrays.asList(1,2,3));
    users.forEach(System.out::println)
}

//条件查询
public void testSelectByBatchIds(){
    HashMap map=new HashMap();
    //自定义查询
    map.put("name","shuishui");
    map.put("age",3);
    
    List user = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

查询指定字段

//        QueryWrapper queryWrapper = new QueryWrapper();
//        queryWrapper.select(CasesFeedback.class,info -> !info.getColumn().equals("create_time")&&
//                !info.getColumn().equals("update_time") &&
//                !info.getColumn().equals("deleted")&&
//                !info.getColumn().equals("id"));

自定义SQL 方式一：在Mapper文件中定义一个方法

@Select("select * from user ${ew.customSqlSegment}")
List selectAll(@Param(Constants.WRAPPER)Wrapper wrapper);

方式二：在application中加入扫描mapper文件路径

mybatis-plus:
 mapper-locations: com/mp/mapper/*

在Mapper.xml中写SQL

	
    	select * from user ${ew.customSqlSegment}
    

分页查询

分页在网站使用的十分多 1.原始的limit进行分页 2.PageHelper 第三方插件 3.MyBatis-Plus中也内置了分页插件！ 如何使用 1.配置拦截器组件即可

//Spring boot方式
@EnableTransactionManagement
@Configuration
@MapperScan("com.baomidou.cloud.service.*.mapper*")
public class MybatisPlusConfig {

    @Bean
    public PaginationInterceptor paginationInterceptor() {
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        // 设置请求的页面大于最大页后操作， true调回到首页，false 继续请求  默认false
        // paginationInterceptor.setOverflow(false);
        // 设置最大单页限制数量，默认 500 条，-1 不受限制
        // paginationInterceptor.setLimit(500);
        // 开启 count 的 join 优化,只针对部分 left join
        paginationInterceptor.setCountSqlParser(new JsqlParserCountOptimize(true));
        return paginationInterceptor;
    }
}

2.写测试

//测试分页查询
@Test
pulic void testPage(){
    // 参数一：当前页
    // 参数二：页面大小
    // 使用了分页插件之后，所有的分页操作也变得简单了
    Page page =new Page(2,5);
    userMapper.selectPage(page,null);
    
    page.getRecords().forEach(System.out::println);
    //获取总数
    page.getTotal();
}

删除

// 根据 entity 条件，删除记录
int delete(@Param(Constants.WRAPPER) Wrapper wrapper);
// 删除（根据ID 批量删除）
int deleteBatchIds(@Param(Constants.COLLECTION) Collection idList);
// 根据 ID 删除
int deleteById(Serializable id);
// 根据 columnMap 条件，删除记录
int deleteByMap(@Param(Constants.COLUMN_MAP) Map columnMap);

测试删除：

@Test
public void testDeleteById(){
    userMapper.deleteById(1);
}

//批量删除
@Test
public void testDeleteBatchId(){
    userMapper.deleteBatchIds(Arrays.asList(1,2));
}

//条件删除
@Test
public void testDeleteMap(){
    HashMap map = new HashMap();
    map.put("name","shuishui");
    userMapper.deleteByMap(Map);
}

在工作中会遇到逻辑删除

逻辑删除

物理删除：从数据库中直接移出 逻辑删除：在数据库中没有被移出，而是通过一个变量来让他失效！ Spring Boot 配置方式：

• application.yml 加入配置（如果你的默认值和MP默认的一样，该配置可无）：

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: flag  #全局逻辑删除字段值 3.3.0开始支持，详情看下面。
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

• 注册 Bean（3.1.1开始不再需要这一步）：

import com.baomidou.mybatisplus.core.injector.ISqlInjector;
import com.baomidou.mybatisplus.extension.injector.LogicSqlInjector;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

@Configuration
public class MyBatisPlusConfiguration {

    @Bean
    public ISqlInjector sqlInjector() {
        return new LogicSqlInjector();
    }
}

• 实体类字段上加上 @TableLogic 注解

@TableLogic
private Integer deleteFlag;

• 效果：使用MP自带方法删除和查找都会附带逻辑删除功能（自己写的xml不会）

example
删除时 update user set deleted=1 where id =1 and deleted=0
查找时 select * from user where deleted=0

• 全局逻辑删除：3.3.0开始支持 如果公司代码比较规范比如同意了全局都是flag为逻辑删除字段。 使用此配置则不需要在实体类上添加@TableLogic。 但如果实体类上有 @TableLogic 则以实体类上的为准，忽略全局。即首先查找注解再查找全局，都没有则此表没有逻辑删除。

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: flag  #全局逻辑删除字段值

附件说明

• 逻辑删除是为了方便数据恢复和保护本身价值等等的一种方案，但实际就是删除。
• 如果你需要再查出来就不应使用逻辑删除，而是以一个状态去表示。 如：员工离职，账号被锁定等应该是一个状态字段，此场景不应使用逻辑删除。
• 若确需查找删除数据，如老板需要查看历史所有数据的统计汇总信息，请单独手写SQL。

性能更新插件

我们在平时的开发中，会遇到一些慢SQL。测试！druid… 作用：性能分析拦截器，用于输出每条SQL语句及执行时间 MP也提供性能分析插件，如果超过这个时间就会停止运行 1.导入插件

//Spring boot方式
@EnableTransactionManagement
@Configuration
@MapperScan("com.baomidou.cloud.service.*.mapper*")
public class MybatisPlusConfig {

    /**
     * SQL执行效率插件
     */
    @Bean
    @Profile({"dev","test"})// 设置 dev test 环境开启
    public PerformanceInterceptor performanceInterceptor() {
        PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
        performanceInterceptor.setMaxTime(100);// ms 设置sql执行的最大时间，如果超过就停止
        performanceInterceptor.setFormat(true);
        return new PerformanceInterceptor();
    }
}

记得在Spring Boot配置环境为dev或者test环境！ 2.实例测试

@Test
void contextLoads(){
    //参数是一个Wrapper，条件结构器，这里先不用，填null
    //查询全部用户
    List users =userMapper.selectList(null);
    user.forEach(System.out::println);
}

• 参数：maxTime SQL执行最大时长，超过自动停止运行，有助于发现问题。
• 参数：format SQL是否格式化，默认为false。
• 该插件只用于开发环境，不建议生产环境使用。

条件构造器（Wrapper）

十分重要：Wrapper 我们写一些复杂的SQL可以用它来完成 现做几个实例看看：

@Test
void contextLoads(){
    // 查询name不为null的用户，并且邮箱不为null的永不，年龄大于等于20的用户
    QueryWrapper wrapper =new QueryWrapper();
    wrapper.isNotNull("name");
    wrapper.isNotNull("email");
    wrapper.ge("age",12);
    userMapper.selectList(wrapper).forEach(System.out::println);
}

@Test
void test2(){
    // 查询name为shuishui的用户
    QueryWrapper wrapper =new QueryWrapper();
    wrapper.eq("name","shuishui");
    User user=userMapper.selectList(wrapper)
    System.out.println（user）;
}

@Test
void test3(){
    // 查询年龄在20~30岁之间的用户
    QueryWrapper wrapper =new QueryWrapper();
    wrapper.between("age",20,30);
    Integer count =userMapper.selectCount(wrapper);//查询结果数
    System.out.println（count）;
}

//模糊查询
@Test
void test4(){
    QueryWrapper wrapper =new QueryWrapper();
    
    wrapper.notLike("name",“s”);//相当于NOT LIKE '%s%'
    wrapper.likeRight("email",“s”);//相当于LIKE 's%'
    Listmaps =userMapper.selectMaps(wrapper);//查询结果数
    maps.forEach(System.out::println);
}


@Test
void test5(){
    QueryWrapper wrapper =new QueryWrapper();
    //子查询
    wrapper.insql("id","select id from user where id