简介

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

特性

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

入门

• 添加依赖

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

• 连接数据库

  spring.datasource.url=jdbc:mysql:///mybatis_plus?serverTimezone=UTC
  spring.datasource.username=root
  spring.datasource.password=123456
  

• 实体类

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

• Mapper接口：继承BaseMapper

  @Repository
  @Mapper
  public interface UserMapper extends BaseMapper<User> {
  }
  

主键自增

• 实体类添加注解

  //对应数据库中的主键
  @TableId(type = IdType.AUTO)
  private Integer id;
  

• 数据库设置主键自增

自动填充

• 数据库添加字段

  createTime datetime
  updateTime datetime
  

• 实体类添加注解

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

• 注册自动填充策略

  @Component
  public class MyMetaObjectHandler implements MetaObjectHandler {
      @Override
      public void insertFill(MetaObject metaObject) {
          this.strictInsertFill(metaObject, "createTime", Date.class, new Date());
          this.strictInsertFill(metaObject, "updateTime", Date.class, new Date());
  
      }
  
      @Override
      public void updateFill(MetaObject metaObject) {
          this.strictInsertFill(metaObject, "updateTime", Date.class, new Date());
      }
  }
  

乐观锁

• 意图：

• 当要更新一条记录的时候，希望这条记录没有被别人更新

• 乐观锁实现方式：

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

• 数据库添加字段

  version 默认为1
  

• 实体类添加注解

  @Version
  private Integer version;
  

• 注册配置

  @Configuration
  public class MyBatisPlusConfig {
  
      @Bean
      public OptimisticLockerInterceptor optimisticLockerInterceptor() {
          return new OptimisticLockerInterceptor();
      }
  }
  

分页插件

• 注册配置

  @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 test8(){
      //参数一：当前页。参数二：页面大小
      Page<User> userPage = userMapper.selectPage(new Page<User>(2, 5), null);
      System.out.println(userPage);
  }
  

逻辑删除

• 数据库添加字段

  deleted 默认为 0
  

• 实体类添加注解

  @TableLogic
  private Integer deleted;
  

• 插件配置

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

条件构造器