Mybatis-plus学习笔记

笔记整理于狂神说Mybatis-plus

Mybatis-Plus学习笔记

1、简介

Mybatis-plus

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

1.1、特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑
• 损耗小：启动即会自动注入基本 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 操作智能分析阻断，也可自定义拦截规则，预防误操作

1.2、支持数据库

任何能使用 mybatis 进行 CRUD, 并且支持标准 sql 的数据库

1.3、框架结构

2、快速入门

2.1、创建数据库

CREATE DATABASE mybatis_plus;

2.2、创建数据表

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)
);
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.3、创建项目

创建一个空的 Spring Boot 工程

2.4、导入依赖

<!--数据库驱动-->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
    <version>8.0.20</version>
</dependency>
<!--mybatis-plus-->
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.0.5</version>
</dependency>
<!--lombok-->
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
    <optional>true</optional>
</dependency>

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

2.5、连接数据库

# mysql
spring.datasource.username=root
spring.datasource.password=root
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?userSSL=true&useUnicode=true&characterEncoding=UTF-8&serverTimezone=UTC
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver

2.6、代码编写

传统方式：pojo-dao（连接Mybatis,配置mapper-xml文件）-service-controller

使用MyBatis-plus之后

• pojo

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

• mapper接口

  // 在对应的Mapper上面继承基本的接口 BaseMapper
  @Repository // 代表持久层
  public interface UserMapper extends BaseMapper<User> {
      // 所有的CRUD操作都已经基本完成了
      // 你不需要像以前的配置一大堆文件了
  }
  

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

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

• 使用

  @SpringBootTest
  class MybatisPlusApplicationTests {
  
      // 继承了BaseMapper,所有的方法都来自父类
      // 我们也可以编写自己的扩展方法
      @Autowired
      UserMapper userMapper;
  
      @Test
      void contextLoads() {
          // 参数是一个 Wrapper , 条件构造器，这里我们先不用 null
          // 查询全部用户
          List<User> users = userMapper.selectList(null);
          users.forEach(System.out::println);
      }
  }
  

• 控制台输出

  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)
  

  思考问题：

  1、SQL是谁帮我们写的？MyBatis-Plus都写好了

  2、方法哪里来的？MyBatis-Plus 都写好了

3、配置日志

我们所有的sql现在都是不可见的，我们希望知道它是怎么执行的，所以我们必须要看日志！

# 配置日志 (系统自带的，控制台输出)
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

4、CRUD

4.1、插入操作

@Test
public void testInsert(){
    User user = new User();
    user.setName("thomas");
    user.setAge(20);
    user.setEmail("test6@baomidou.com");
    int result = userMapper.insert(user);// 帮我们自动生成id
    System.out.println(result);// 受影响的行数
    System.out.println(user);// 发现: id自动回填
}

数据库插入的id默认值为：全局的唯一id （ID_WORKER）

4.2、主键生成策略

分布式系统唯一id生成

• 雪花算法：
  • snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。其核心思想是：使用41bit作为毫秒数，10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。可以保证几乎全球唯一！
• 我们需要配置主键自增：
  • 实体类字段上 @TableId(type = IdType.AUTO)
  • 数据库字段上一定是自增的

其他属性：

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 的字符串表示)  
}

4.3、更新操作

@Test
public void testUpdate(){
    User user = new User();
    // 通过条件自动拼接动态sql
    user.setId(6L);
    user.setName("thomas1");
    user.setAge(18);
    // 注意： updateById 但是参数是一个 对象
    int i = userMapper.updateById(user);
    System.out.println(i);
}

4.3、自动填充

创建时间、修改时间！这些个操作一般都是自动化完成的，我们不希望手动更新！

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

方式一：数据库级别（工作中不允许修改数据库）

• 在表中新增字段 create_time,update_time

  • 字段默认值设置为 CURRENT_TIMESTAMP（MySQL5.7以及5.7以后才可以），update_time设置自动更新。

• 再次测试插入方法，我们需要先把实体类同步

  private Date createTime;
  private Date updateTime;
  

• 再次查看更新结果即可

方式二：代码级别

• 删除数据库中的默认值、更新操作

• 实体类的字段属性上需要增加注解

  //字段添加填充内容
  @TableField(fill = FieldFill.INSERT)
  private Date createTime;
  
  @TableField(fill = FieldFill.INSERT_UPDATE)
  private Date updateTime;
  

  public enum FieldFill {
      /**
       * 默认不处理
       */
      DEFAULT,
      /**
       * 插入填充字段
       */
      INSERT,
      /**
       * 更新填充字段
       */
      UPDATE,
      /**
       * 插入和更新填充字段
       */
      INSERT_UPDATE
  }
  

• 编写处理器来处理这个注解即可

  @Slf4j
  @Component // 一定不要忘记把处理器加到IOC容器中
  public class MyMetaObjectHandler implements MetaObjectHandler {
  
      // 插入时候的填充策略
      @Override
      public void insertFill(MetaObject metaObject) {
          log.info("start insert fill ...");
          // setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject)
          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、乐观锁

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

乐观锁实现方式：

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

-- 乐观锁：1、先查询，获得版本号 version = 1
-- A
update user set name = "kuangshen", version = version + 1 where id = 2 and version = 1
-- B：线程抢先完成，这个时候 version = 2，会导致 A 修改失败！
update user set name = "kuangshen", version = version + 1 where id = 2 and version = 1

MyBatisPlus的乐观锁插件

• 给数据库中增加 version 字段。

• 实体类加对应的字段，并用 @Version标注

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

• 注册组件

  //扫描我们的 mapper文件夹
  @MapperScan("com.kuang.mapper")
  @EnableTransactionManagement
  @Configuration // 配置类
  public class MyBatisPlusConfig {
  
  	// 注册乐观锁插件
      @Bean
      public OptimisticLockerInterceptor optimisticLockerInterceptor(){
          return new OptimisticLockerInterceptor();
      }
  }
  

• 测试

  // 测试乐观锁成功
  @Test
  public void testOptimisticLocker(){
      // 1.查询用户信息
      User user = userMapper.selectById(1L);
      // 2.修改用户信息
      user.setName("xxx");
      user.setEmail("3419339201@qq.com");
      userMapper.updateById(user);
  }
  
  // 测试乐观锁失败，多线程环境下！
  @Test
  public void testOptimisticLocker2(){
      // 线程1
      User user = userMapper.selectById(1L);
      user.setName("user1");
      user.setEmail("2439115397@qq.com");
  
      // 模拟另外一个线程执行了插队操作
      User user2 = userMapper.selectById(1L);
      user2.setName("user2");
      user2.setEmail("2953887629@qq.com");
      userMapper.updateById(user2);
  
      userMapper.updateById(user); // 如果没有乐观锁就会覆盖插队线程的值！
  }
  

4.5、查询操作

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

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

// 按照条件查询之一使用 map
@Test
public void testSelectByMap(){
    HashMap<String, Object> map = new HashMap<>();
    // 自定义要查询
    map.put("name","thomas");
    map.put("age","20");
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}

4.6、分页查询

• 原始的 limit 进行分页
• pageHelper 第三方插件
• MyBatisPlus 其实也内置了分页插件

使用MyBatisPlus提供的分页插件

• 配置分页拦截器组件

  @Bean
  public PaginationInterceptor paginationInterceptor(){
      return new PaginationInterceptor();
  }
  

• 直接使用MyBatisPlus提供的Page对象即可

  // 测试分页插件
  @Test
  public void testSelectPage(){
      // 参数1：当前页
      // 参数2：页面大小
      Page<User> page = new Page<>(1,5);
      userMapper.selectPage(page,null);
      List<User> records = page.getRecords();
      records.forEach(System.out::println);
      System.out.println(page.getTotal()); //总记录数
  }
  

4.7、删除操作

// 根据id删除
@Test
public void testDeleteById(){
    int result = userMapper.deleteById(1L);
    System.out.println(result);
}

// 根据id集合批量删除
@Test
public void testDeleteBatchIds(){
    int result = userMapper.deleteBatchIds(Arrays.asList(2, 3, 4));
    System.out.println(result);
}

// 根据map作为条件删除
@Test
public void test(){
    Map<String,Object> map = new HashMap<>();
    map.put("name","thomas");
    map.put("age",20);
    int result = userMapper.deleteByMap(map);
    System.out.println(result);
}

4.8、逻辑删除

• 物理删除：从数据库中直接移除。
• 逻辑删除：在数据库中没有被移除，而是通过一个变量来让他失效，deleted = 0 => deleted = 1。

逻辑删除可以防止数据的丢失，类似于回收站。

测试

• 在数据表中增加一个 deleted 字段，默认值为0

• 实体类中增加相应的属性，并用 @TableLogic

  @TableLogic // 逻辑删除注解
  private Integer deleted;
  

• 配置逻辑删除

  // 注册逻辑删除插件
  @Bean
  public ISqlInjector iSqlInjector(){
      return new LogicSqlInjector();
  }
  

  # 配置逻辑删除
  mybatis-plus.global-config.db-config.logic-delete-value=1
  mybatis-plus.global-config.db-config.logic-not-delete-value=0
  

• 测试删除，执行的是更新操作，而不是删除操作，记录依旧在数据库，但是对应的deleted值被修改为1

• 执行查询测试，发现查询的时候会自动过滤被逻辑删除的字段（查询语句会自动拼接deleted = 0的条件）

5、性能分析插件

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

MybatisPlus也提供性能分析插件，如果超过这个时间就停止运行

使用

• 导入插件

  // 注册SQL性能分析插件
  @Bean
  @Profile({"dev","test"}) // 设置dev和test环境开启，保证程序的运行效率
  public PerformanceInterceptor performanceInterceptor(){
      PerformanceInterceptor performanceInterceptor = new PerformanceInterceptor();
      performanceInterceptor  .setMaxTime(100); // 单位：毫秒，设置sql执行的最大时间，如果超过了则不执行
      performanceInterceptor.setFormat(true); // 是否格式化代码
      return performanceInterceptor;
  }
  

  在SpringBoot中配置环境为dev或者test环境。

  # 设置开发环境
  spring.profiles.active=dev
  

• 测试

  @Test
  public void contextLoads() {
      List<User> users = userMapper.selectList(null);
      for (User user : users) {
          System.out.println(user);
      }
  }
  

  发现控制台输出的日志已经格式化，并且SQL执行时间只要超过了规定的时间就会抛出异常！

  使用性能分析插件可以提高效率，新版本MP已经移除该拆件了，可以使用druid

6、条件构造器

MyBatis-plus条件构造器

我们写一些复杂的SQL就可以使用它来替代

@Test
public void test(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.isNotNull("name") // 姓名不为空
            .isNotNull("email") // 邮箱不为空
            .ge("age",20); // 年龄大于等于18
    userMapper.selectList(wrapper).forEach(System.out::println);
}

@Test
public void test2(){
    QueryWrapper<User> wrapper = new QueryWrapper();
    wrapper.eq("name","thomas"); //姓名为Mike
    // 查询一条数据，出现多个结果使用List或者Map
    User user = userMapper.selectOne(wrapper);
    System.out.println(user);
}

@Test
public void test3(){
    QueryWrapper<User> wrapper = new QueryWrapper();
    wrapper.between("age",20,30); //查询年龄区间为[20,30]：包含两端的值
    Integer count = userMapper.selectCount(wrapper);// 查询结果数
    System.out.println(count);
}

@Test
public void test4(){
    QueryWrapper<User> wrapper = new QueryWrapper();
    wrapper.notLike("name","K") //名字不包括K
            .likeRight("name","C"); //名字以C结尾
    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}

@Test
public void test5(){
    QueryWrapper<User> wrapper = new QueryWrapper();
    wrapper.inSql("id","select id from user where id < 3"); // id在子查询中查出来

    List<Object> objects = userMapper.selectObjs(wrapper);
    objects.forEach(System.out::println);
}

@Test
public void test6(){
    QueryWrapper<User> wrapper = new QueryWrapper();
    wrapper.orderByAsc("id"); // 根据id升序排序

    List<User> users = userMapper.selectList(wrapper);
    users.forEach(System.out::println);
}

7、代码生成器

MyBaits-Plus代码生成器

AutoGenerator 是 MyBatis-Plus 的代码生成器，通过 AutoGenerator 可以快速生成 Entity、Mapper、Mapper XML、Service、Controller 等各个模块的代码，极大的提升了开发效率。

• 依赖

  <dependencies>
      <!-- web依赖 -->
      <dependency>
          <groupId>org.springframework.boot</groupId>
          <artifactId>spring-boot-starter-web</artifactId>
      </dependency>
      <!-- mybatis-plus依赖-->
      <dependency>
          <groupId>com.baomidou</groupId>
          <artifactId>mybatis-plus-boot-starter</artifactId>
          <version>3.3.1.tmp</version>
      </dependency>
      <!-- mybatis-plus代码生成器依赖 -->
      <dependency>
          <groupId>com.baomidou</groupId>
          <artifactId>mybatis-plus-generator</artifactId>
          <version>3.3.1.tmp</version>
      </dependency>
      <!-- freemarker依赖 -->
      <dependency>
          <groupId>org.freemarker</groupId>
          <artifactId>freemarker</artifactId>
      </dependency>
      <!-- mysql依赖 -->
      <dependency>
          <groupId>mysql</groupId>
          <artifactId>mysql-connector-java</artifactId>
          <scope>runtime</scope>
      </dependency>
  </dependencies>
  

• 代码

  // 演示例子，执行 main 方法控制台输入模块表名回车自动生成对应项目目录中
  public class CodeGenerator {
      /**
       * <p>
       * 读取控制台内容
       * </p>
       */
      public static String scanner(String tip) {
          Scanner scanner = new Scanner(System.in);
          StringBuilder help = new StringBuilder();
          help.append("请输入" + tip + "：");
          System.out.println(help.toString());
          if (scanner.hasNext()) {
              String ipt = scanner.next();
              if (StringUtils.isNotBlank(ipt)) {
                  return ipt;
              }
          }
          throw new MybatisPlusException("请输入正确的" + tip + "！");
      }
  
      public static void main(String[] args) {
          // 代码生成器
          AutoGenerator mpg = new AutoGenerator();
  
          // 全局配置
          GlobalConfig gc = new GlobalConfig();
          String projectPath = System.getProperty("user.dir");
          gc.setOutputDir(projectPath + "/src/main/java");
          gc.setAuthor("jobob");
          gc.setOpen(false);
          // gc.setSwagger2(true); 实体属性 Swagger2 注解
          mpg.setGlobalConfig(gc);
  
          // 数据源配置
          DataSourceConfig dsc = new DataSourceConfig();
          dsc.setUrl("jdbc:mysql://localhost:3306/ant?useUnicode=true&useSSL=false&characterEncoding=utf8");
          // dsc.setSchemaName("public");
          dsc.setDriverName("com.mysql.jdbc.Driver");
          dsc.setUsername("root");
          dsc.setPassword("密码");
          mpg.setDataSource(dsc);
  
          // 包配置
          PackageConfig pc = new PackageConfig();
          pc.setModuleName(scanner("模块名"));
          pc.setParent("com.baomidou.ant");
          mpg.setPackageInfo(pc);
  
          // 自定义配置
          InjectionConfig cfg = new InjectionConfig() {
              @Override
              public void initMap() {
                  // to do nothing
              }
          };
  
          // 如果模板引擎是 freemarker
          String templatePath = "/templates/mapper.xml.ftl";
          // 如果模板引擎是 velocity
          // String templatePath = "/templates/mapper.xml.vm";
  
          // 自定义输出配置
          List<FileOutConfig> focList = new ArrayList<>();
          // 自定义配置会被优先输出
          focList.add(new FileOutConfig(templatePath) {
              @Override
              public String outputFile(TableInfo tableInfo) {
                  // 自定义输出文件名 ， 如果你 Entity 设置了前后缀、此处注意 xml 的名称会跟着发生变化！！
                  return projectPath + "/src/main/resources/mapper/" + pc.getModuleName()
                          + "/" + tableInfo.getEntityName() + "Mapper" + StringPool.DOT_XML;
              }
          });
          /*
          cfg.setFileCreate(new IFileCreate() {
              @Override
              public boolean isCreate(ConfigBuilder configBuilder, FileType fileType, String filePath) {
                  // 判断自定义文件夹是否需要创建
                  checkDir("调用默认方法创建的目录，自定义目录用");
                  if (fileType == FileType.MAPPER) {
                      // 已经生成 mapper 文件判断存在，不想重新生成返回 false
                      return !new File(filePath).exists();
                  }
                  // 允许生成模板文件
                  return true;
              }
          });
          */
          cfg.setFileOutConfigList(focList);
          mpg.setCfg(cfg);
  
          // 配置模板
          TemplateConfig templateConfig = new TemplateConfig();
  
          // 配置自定义输出模板
          //指定自定义模板路径，注意不要带上.ftl/.vm, 会根据使用的模板引擎自动识别
          // templateConfig.setEntity("templates/entity2.java");
          // templateConfig.setService();
          // templateConfig.setController();
  
          templateConfig.setXml(null);
          mpg.setTemplate(templateConfig);
  
          // 策略配置
          StrategyConfig strategy = new StrategyConfig();
          strategy.setNaming(NamingStrategy.underline_to_camel);
          strategy.setColumnNaming(NamingStrategy.underline_to_camel);
          strategy.setSuperEntityClass("你自己的父类实体,没有就不用设置!");
          strategy.setEntityLombokModel(true);
          strategy.setRestControllerStyle(true);
          // 公共父类
          strategy.setSuperControllerClass("你自己的父类控制器,没有就不用设置!");
          // 写于父类中的公共字段
          strategy.setSuperEntityColumns("id");
          strategy.setInclude(scanner("表名，多个英文逗号分割").split(","));
          strategy.setControllerMappingHyphenStyle(true);
          strategy.setTablePrefix(pc.getModuleName() + "_");
          mpg.setStrategy(strategy);
          mpg.setTemplateEngine(new FreemarkerTemplateEngine());
          mpg.execute();
      }
  }
  

根据自己项目进行内容的修改