【mybatis-plus】学习笔记

官方地址：https://mp.baomidou.com/
自动化工具：JPA、tk-imapper、MybatisPlus

简介

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

愿景

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

特性

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

---

支持数据库

• mysql 、 mariadb 、 oracle 、 db2 、 h2 、 hsql 、 sqlite 、 postgresql 、 sqlserver
• 达梦数据库 、 虚谷数据库 、 人大金仓数据库

快速指南

1、创建数据库 mybatis_plus

其对应的数据库 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、导入相应的依赖

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <optional>true</optional>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

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

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

3、连接数据库

spring.datasource.username=root
spring.datasource.password=root
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?\
  useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC
spring.datasource.driver-class-name=com.mysql.jdbc.Driver


mysql 8 驱动 ： com.mysql.cj.jdbc.Driver

4、编写代码

使用mybatis-plus之后，无需配置mapper.xml文件

---

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

package com.wei.mybatis_plus.pojo;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@AllArgsConstructor
@NoArgsConstructor

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

编写Mapper类 UserMapper.java

//在对应的Mapper上继承基本的类baseMapper
@Repository
public interface UserMapper extends BaseMapper<User> {
    //继承basemapper并传递pojo类型
    //所有的CRUD已经编写完成
    //不需要像以前的配置一些xml
}

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

// 扫描mapper 文件夹
@MapperScan("com.wei.mybatis_plus.mapper")
@SpringBootApplication
public class MybatisPlusApplication {
    public static void main(String[] args) {
        SpringApplication.run(MybatisPlusApplication.class, args);
    }
}

进行测试

@SpringBootTest
class MybatisPlusApplicationTests {
    @Autowired
    private UserMapper userMapper;
    @Test
    void contextLoads() {
        List<User> users = userMapper.selectList(null);
        System.out.println(users);
    }
}

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

控制台输出：

5、小结

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

从以上步骤中，我们可以看到集成MyBatis-Plus非常的简单，只需要引入 starter 工程，并配置 mapper 扫描路径即可。

但 MyBatis-Plus 的强大远不止这些功能，想要详细了解 MyBatis-Plus 的强大功能？那就继续往下看吧！

2.配置日志

我们所有的sql是不可见的,我们希望知道他是怎么执行的,所以我们必须看日志!

# 配置日志  (默认控制台输出)
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

配置之后，日志信息会在控制台打印 。除此之外还有其他的日志实现。

---

3.CRUD扩展

1.插入数据

    @Test
    void contextLoads2() {
        int ww = userMapper.insert(new User(null, "ww2", 23, "2651@qq.com"));
        System.out.println(ww);
    }

注意点:数据库插入的id默认值为:全局的唯一id\

2.主键生成策略

默认 ID_WORKER 全局唯一id
对应数据库中的主键(uuid.自增id.雪花算法.redis.zookeeper)

分布式系统唯一id生成:https://www.cnblogs.com/haoxinyue/p/5208136.html

雪花算法😦Twitter的snowflake算法)

snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0.可以保证几乎全球唯一

主键自增

1. 实体类字段上@TableId(type = IdType.AUTO)
2. 数据库字段一定要是自增!

public class User {
    @TableId(type = IdType.INPUT)
    private Long id ;
    private String name;
    private Integer age;
    private String email;
}

其余源码解释

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

3.更新数据

动态sql

注意:updateById()参数是 一个对象!

//测试更新
@Test
void updateTest() {
    User user = new User();
    user.setAge(25);
    user.setId(1320016939287658498L);
    user.setName("test2！");
    userMapper.updateById(user);
}

所有的sql都是动态帮你配置的

---

4.自动填充

创建时间 . 修改时间! 这些个操作都是自动化完成的,我们不希望手动更新!

阿里巴巴开发手册:所有的数据库表:gmt_create .gmt_modified几乎所有的表都要配置上!而且需要自动化!

方式一:数据库级别

1.在表中新增字段 create_time , update_time
并且设置默认值CURRENT_STAMP

2.再次测试插入方法,我们需要先把实体类同步

public class User {
    @TableId(type = IdType.ASSIGN_ID)
    private Long id ;
    private String name;
    private Integer age;
    private String email;
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

}

再次更新查看结果即可

方式二:代码级别

1.实体类字段属性上添加注解

@TableField(fill = FieldFill.INSERT)
private Data creatTime;

@TableField(fill = FieldFill.INSERT_UPDATE)
private Data updateTime;

2.编写处理器来处理这个注解

package com.wei.mybatis_plus.handler;

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;
@Slf4j
@Component //把处理器加到IOC容器中
public class MyMetaObjectHandler implements MetaObjectHandler {
    //插入时的填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        System.out.println("insertFill................................");
        log.info("start insert fill ...");
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
    
    //更新时的填充策略
    @Override
    public void updateFill(MetaObject metaObject) {
        System.out.println("updateFill................................");
        log.info("start update fill ....");
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

4.测试插入

	//测试插入
    @Test
    void contextLoads2() {
        int ww = userMapper.insert(new User(null, "岳麓", 23, "2651@qq.com",null,null));
    }

    //测试更新
    @Test
    void updateTest() {
        User user = new User();
        user.setAge(25);
        user.setId(1320016939287658498L);
        user.setName("test2！");
        userMapper.updateById(user);
    }

5测试更新,观察时间即可!

5. 乐观锁

在面试过程中，我们经常会被问到乐观锁，悲观锁。

乐观锁：顾名思义，它总是认为不会出现问题，无论干什么都不去上锁！如果出现了问题，再次更新值测试！
悲观锁：顾名思义，它总是认为总是出现问题，无论干什么都上锁！再去操作！

乐观锁实现方式：

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

测试一下MyBatisPlus的插件：

1.数据库中增加一个version字段,int 类型 默认值为1
2.需要实体类加上对应的字段

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

3.注册组件
此处还将application 的MapperScan 移到此处，符合规范。

// 扫描mapper 文 件夹
@MapperScan("com.wei.mybatis_plus.mapper")
@EnableTransactionManagement
@Configuration
public class MybatisPlusConfig  {

    // 注册乐观锁插件
    @Bean
    public MybatisPlusInterceptor MybatisPlusInterceptor() {
        MybatisPlusInterceptor mybatisPlusInterceptor = new MybatisPlusInterceptor();
        mybatisPlusInterceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor());
        return mybatisPlusInterceptor;
    }
}

4.测试一下

    //测试乐观锁成功
    @Test
    void testOptimisticLocker(){
        // 1.查询用户信息
        User user = userMapper.selectById(1L);
        user.setName("testOptimisticLocker");
        userMapper.updateById(user);
        //结果成功修改名字为testOptimisticLocker
    }

    //测试乐观锁失败
    @Test
    void testOptimisticLocker2(){
        // 1.查询用户信息
        User user = userMapper.selectById(1L);
        user.setName("testOptimisticLocker111");

        // 模拟另外一个线程执行了插队操作========================
        User user2 = userMapper.selectById(1L);
        user2.setName("testOptimisticLocker222");
        userMapper.updateById(user2);
        // 模拟另外一个线程执行了插队操作========================

        userMapper.updateById(user);//如果没有乐观锁就会覆盖插队线程的值。结果为testOptimisticLocker111
        //结果失败，太过乐观，没有修改名字为testOptimisticLocker
    }

6.查询操作 &&分页

• 普通的查询，以及多条件查询

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

    //复杂的多条件查询
    @Test
    void testSelectByBatchIds(){
        HashMap map = new HashMap();
        map.put("name", "Tom");
        List<User> userList = userMapper.selectByMap(map);
        System.out.println(userList);
    }

• 分页查询
  首先配置bean

@MapperScan("com.wei.mybatis_plus.mapper")
@EnableTransactionManagement
@Configuration
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;
    }
}

• 分页代码

    @Test
    void testPage(){
        // 构造器参数：第一个为当前页，第二为页面大小
        Page<User> page = new Page<>(2,5);
        userMapper.selectPage(page,null);

        page.getRecords().forEach(System.out::println);

        //查询总数
        long total = page.getTotal();
    }

---

7.删除

    @Test
    void testDelete(){
        userMapper.deleteById(7);
        
        userMapper.deleteBatchIds(Arrays.asList(1,2,3));

        HashMap<String,Object> map = new HashMap();
        map.put("name","Tom");
        userMapper.deleteByMap(map);
    }
    

7.逻辑删除

物理删除：从数据库中直接移除
逻辑删除：没有被移除，而是通过一个变量让他失效。deleted字段

---

1.添加deleted字段，默认为0

2.在实体类中添加属性

    @TableLogic //表 逻辑
    private Integer deleted;

3.配置插件

@Bean
public LogicDeleteByIdWithFill sqlInjector(){
    return new LogicDeleteByIdWithFill();
}

4.删除一条记录的结果

逻辑删除之后，mybatis会处理。id=1 已经查不出来了！！！！

---

4.性能分析插件

官网只有p6spy ，并且生产环境不推荐使用。

<dependency>
    <groupId>p6spy</groupId>
    <artifactId>p6spy</artifactId>
    <version>3.9.1</version>
</dependency>

5.条件构造器（Wrapper）

package com.wei.mybatis_plus;

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.wei.mybatis_plus.mapper.UserMapper;
import com.wei.mybatis_plus.pojo.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
public class WrapperTest {

    @Autowired
    private UserMapper userMapper;

    @Test
    void contextLoads(){
        // 查询name不为空的用户，并且邮箱不为空的用户，年龄大于等于25
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.isNotNull("name")
                .isNotNull("email")
                .ge("age", 25)
        ;

        userMapper.selectList(wrapper);
    }
    @Test
    void contextLoads2(){
        // 查询age 介于20-21 包含。
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.between("age", 20, 21);
        ;
        userMapper.selectCount(wrapper);
    }
    @Test
    void contextLoads3(){
        // 查询name 为tom
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.eq("name", "Tom")
        ;
        userMapper.selectList(wrapper);
    }

    @Test
    void contextLoads4(){
        // name not like %i%  and name like t%
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.notLike("name", "i")
                .likeRight("name", "t")
        ;
        userMapper.selectList(wrapper);
    }
    @Test
    void contextLoads5(){
        // 按create_time 其次 name  作降序排序
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.orderByDesc("create_time","name");
        ;
        userMapper.selectList(wrapper);
    }


}

6.代码自动生成**非常NB

dao、pojo、service、controller都给我自己去编写完成！

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、

Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

只需要改实体类名字 和包名 还有 数据库配置即可

1.依赖

    <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-generator</artifactId>
        <version>3.4.0</version>
    </dependency>
    <!-- 模板引擎 -->
    <dependency>
        <groupId>org.apache.velocity</groupId>
        <artifactId>velocity-engine-core</artifactId>
        <version>2.0</version>
    </dependency>
        <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger2</artifactId>
        <version>2.6.1</version>
    </dependency>
    <dependency>
        <groupId>io.springfox</groupId>
        <artifactId>springfox-swagger-ui</artifactId>
        <version>2.6.1</version>
    </dependency>

2.代码编写，只需要修改参数即可反复使用了。

package com.wei.mybatis_plus;


import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;

import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.PackageConfig;
import com.baomidou.mybatisplus.generator.config.StrategyConfig;
import com.baomidou.mybatisplus.generator.config.po.TableFill;
import com.baomidou.mybatisplus.generator.config.rules.DateType;
import com.baomidou.mybatisplus.generator.config.rules.NamingStrategy;

import java.util.ArrayList;

// 代码自动生成器
public class AutoCode {

    public static void main(String[] args) {
        // 需要构建一个 代码自动生成器 对象
        AutoGenerator mpg = new AutoGenerator();

        // 配置策略
        // 1、全局配置
        GlobalConfig gc = new GlobalConfig();
        String projectPath = System.getProperty("user.dir");
        gc.setOutputDir(projectPath + "/src/main/java");
        gc.setAuthor("Wang");
        gc.setOpen(false);
        gc.setFileOverride(false); // 是否覆盖
        gc.setServiceName("%sService"); // 去Service的I前缀
        gc.setIdType(IdType.ASSIGN_ID);
        gc.setDateType(DateType.ONLY_DATE);
        gc.setSwagger2(true);
        mpg.setGlobalConfig(gc);

        //2、设置数据源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=UTC");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setUsername("root");
        dsc.setPassword("root");
        dsc.setDbType(DbType.MYSQL);
        mpg.setDataSource(dsc);

        //3、包的配置
        PackageConfig pc = new PackageConfig();
        //只需要改实体类名字 和包名 还有 数据库配置即可
        pc.setModuleName("blog");
        pc.setParent("com.wei.mybatis_plus");
        pc.setEntity("pojo");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        mpg.setPackageInfo(pc);

        //4、策略配置
        StrategyConfig strategy = new StrategyConfig();
        /
        strategy.setInclude("user"); // 可传递多个表。
        /

        // 设置要映射的表名
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        strategy.setEntityLombokModel(true);

        // 自动lombok；
        strategy.setLogicDeleteFieldName("deleted");

        // 自动填充配置
        TableFill gmtCreate = new TableFill("create_time", FieldFill.INSERT);
        TableFill gmtModified = new TableFill("update_time", FieldFill.INSERT_UPDATE);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(gmtCreate);
        tableFills.add(gmtModified);
        strategy.setTableFillList(tableFills);

        // 乐观锁
        strategy.setVersionFieldName("version");
        strategy.setRestControllerStyle(true);
        strategy.setControllerMappingHyphenStyle(true);

        // localhost:8080/hello_id_2
        mpg.setStrategy(strategy);
        mpg.execute(); //执行
    }
}

3.效果如下