MyBatis-plus超神用法--一文带你玩转MP

前言

MyBatis-Plus是一个基于MyBatis的增强工具，提供了很多便捷的功能和增强的功能，以下是一些MyBatis-Plus的超神用法：

1. 通用Mapper：MyBatis-Plus提供了通用Mapper的功能，可以通过继承BaseMapper接口，实现简单的CRUD操作，无需编写SQL语句，减少重复的代码。

2. 分页查询：MyBatis-Plus内置了分页查询的功能，可以很方便地进行分页查询操作。使用Page对象进行分页查询，可以通过设置当前页码和每页显示的数量来获取分页数据。

3. 逻辑删除：MyBatis-Plus支持逻辑删除功能，通过在实体类的字段上添加@TableLogic注解，可以实现逻辑删除的功能。删除操作只是将逻辑删除字段置为特定值，而不是真正的删除数据。

4. 自动填充：MyBatis-Plus提供了自动填充的功能，可以在插入或更新数据时自动填充某些字段的值，如创建时间和更新时间等。通过实现MetaObjectHandler接口，可以自定义填充的规则。

5. 条件构造器：MyBatis-Plus提供了强大的条件构造器的功能，可以通过Lambda表达式来构造查询条件，避免手写SQL语句。可以使用eq、ne、gt、ge、lt、le等方法来构造各种条件。

6. 乐观锁：MyBatis-Plus支持乐观锁的功能，通过在实体类的字段上添加@Version注解，可以实现乐观锁的功能。在更新数据时，会自动判断版本号是否一致，如果一致才会进行更新操作。

7. 动态表名：MyBatis-Plus支持动态表名的功能，可以动态地切换表名进行查询操作。通过在Mapper接口的方法上添加@TableName注解，并在SQL语句中使用#tableName来引用动态表名。

8. SQL注入器：MyBatis-Plus提供了SQL注入器的功能，可以自定义SQL注入的操作。可以自定义SQL注入的方法，并在Mapper接口中调用自定义的SQL注入方法。

通过这些功能，可以大幅度提高开发效率，减少编写重复代码的工作量。使用MyBatis-Plus可以更加便捷地进行数据库操作，同时还能提供一些高级功能的支持。本文主要介绍 mp 搭配 Spring Boot 的使用。

一、快速入门

1.创建一个Spring Boot项目。

2.导入依赖

  
   "1.0" encoding="UTF-8"?>  
   <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.3.4.RELEASEversion>  
           <relativePath/>   
       parent>  
       <groupId>com.examplegroupId>  
       <artifactId>mybatis-plusartifactId>  
       <version>0.0.1-SNAPSHOTversion>  
       <name>mybatis-plusname>  
       <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>  
           dependency>  
           <dependency>  
               <groupId>org.springframework.bootgroupId>  
               <artifactId>spring-boot-configuration-processorartifactId>  
           dependency>  
           <dependency>  
               <groupId>com.baomidougroupId>  
               <artifactId>mybatis-plus-boot-starterartifactId>  
               <version>3.4.2version>  
           dependency>  
           <dependency>  
               <groupId>mysqlgroupId>  
               <artifactId>mysql-connector-javaartifactId>  
               <scope>runtimescope>  
           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>

3.配置数据库

# application.yml  
   spring:  
     datasource:  
       driver-class-name: com.mysql.cj.jdbc.Driver  
       url: jdbc:mysql://localhost:3306/test?serverTimezone=Asia/Shanghai  
       username: root  
       password: root  
         
   mybatis-plus:  
     configuration:  
       log-impl: org.apache.ibatis.logging.stdout.StdOutImpl #开启SQL语句打印

4.创建一个实体类

package com.example.mp.po;  
   import lombok.Data;  
   import java.time.LocalDateTime;  
   @Data  
   public class User {  
    private Long id;  
    private String name;  
    private Integer age;  
    private String email;  
    private Long managerId;  
    private LocalDateTime createTime;  
   }

5.创建一个mapper接口

package com.example.mp.mappers;  
   import com.baomidou.mybatisplus.core.mapper.BaseMapper;  
   import com.example.mp.po.User;  
   public interface UserMapper extends BaseMapper { }

6.在SpringBoot启动类上配置mapper接口的扫描路径

package com.example.mp;  
   import org.mybatis.spring.annotation.MapperScan;  
   import org.springframework.boot.SpringApplication;  
   import org.springframework.boot.autoconp.SpringBootApplication;  
   @SpringBootApplication  
   @MapperScan("com.example.mp.mappers")  
   public class MybatisPlusApplication {  
    public static void main(String[] args) {  
     SpringApplication.run(MybatisPlusApplication.class, args);  
    }  
   }

7.在数据库中创建表

DROP TABLE IF EXISTS user;  
   CREATE TABLE user (  
   id BIGINT(20) PRIMARY KEY NOT NULL COMMENT '主键id',  
   name VARCHAR(30) DEFAULT NULL COMMENT '姓名',  
   age INT(11) DEFAULT NULL COMMENT '年龄',  
   email VARCHAR(50) DEFAULT NULL COMMENT '邮箱',  
   manager_id BIGINT(20) DEFAULT NULL COMMENT '直属上级id',  
   create_time DATETIME DEFAULT NULL COMMENT '创建时间',  
   CONSTRAINT manager_fk FOREIGN KEY(manager_id) REFERENCES user (id)  
   ) ENGINE=INNODB CHARSET=UTF8;  
     
   INSERT INTO user (id, name, age ,email, manager_id, create_time) VALUES  
   (1, '大BOSS', 40, 'boss@baomidou.com', NULL, '2023-10-22 09:48:00'),  
   (2, '李经理', 40, 'boss@baomidou.com', 1, '2023-10-22 09:48:00'),  
   (3, '黄主管', 40, 'boss@baomidou.com', 2, '2023-10-22 09:48:00'),  
   (4, '吴组长', 40, 'boss@baomidou.com', 2, '2023-10-22 09:48:00'),  
   (5, '小菜', 40, 'boss@baomidou.com', 2, '2023-10-22 09:48:00')

8.编写一个SpringBoot测试类

package com.example.mp;  
   import com.example.mp.mappers.UserMapper;  
   import com.example.mp.po.User;  
   import org.junit.Test;  
   import org.junit.runner.RunWith;  
   import org.springframework.beans.factory.annotation.Autowired;  
   import org.springframework.boot.test.context.SpringBootTest;  
   import org.springframework.test.context.junit4.SpringRunner;  
   import java.util.List;  
   import static org.junit.Assert.*;  
   @RunWith(SpringRunner.class)  
   @SpringBootTest  
   public class SampleTest {  
    @Autowired  
    private UserMapper mapper;  
    @Test  
    public void testSelect() {  
     List list = mapper.selectList(null);  
     assertEquals(5, list.size());  
     list.forEach(System.out::println);  
    }  
   }

至此,准备工作完成，数据库情况如下：

项目目录如下：

运行测试类

        可以看到，针对单表的基本CRUD操作，只需要创建好实体类，并创建一个继承自BaseMapper的接口即可，可谓非常简洁。并且，我们注意到，User类中的managerId，createTime属性，自动和数据库表中的manager_id，create_time对应了起来，这是因为mp自动做了数据库下划线命名，到Java类的驼峰命名之间的转化。

二、核心功能

注解

mp一共提供了8个注解，这些注解是用在Java的实体类上面的。

@TableName

        注解在类上，指定类和数据库表的映射关系。实体类的类名（转成小写后）和数据库表名相同时，可以不指定该注解。

@TableId

        注解在实体类的某一字段上，表示这个字段对应数据库表的主键。当主键名为id时（表中列名为id，实体类中字段名为id），无需使用该注解显式指定主键，mp会自动关联。若类的字段名和表的列名不一致，可用value属性指定表的列名。另，这个注解有个重要的属性type，用于指定主键策略。

@TableField

        注解在某一字段上，指定Java实体类的字段和数据库表的列的映射关系。这个注解有如下几个应用场景。

排除非表字段

        若Java实体类中某个字段，不对应表中的任何列，它只是用于保存一些额外的，或组装后的数据，则可以设置exist属性为false，这样在对实体对象进行插入时，会忽略这个字段。排除非表字段也可以通过其他方式完成，如使用static或transient关键字，但个人觉得不是很合理，不做赘述。

字段验证策略

        通过insertStrategy，updateStrategy，whereStrategy属性进行配置，可以控制在实体对象进行插入，更新，或作为WHERE条件时，对象中的字段要如何组装到SQL语句中。

字段填充策略

        通过fill属性指定，字段为空时会进行自动填充。

     fill属性有三个可选值：

1. FieldFill.DEFAULT：默认值，表示不进行自动填充。
2. FieldFill.INSERT：表示在插入数据时进行自动填充。
3. FieldFill.UPDATE：表示在更新数据时进行自动填充。

        例如，定义一个实体类User，其中有一个createTime字段和一个updateTime字段，需要在插入和更新数据时自动填充这两个字段的值。可以在对应的字段上添加@TableField注解，并指定fill属性为FieldFill.INSERT和FieldFill.UPDATE。

public class User {
 
    private Long id;
 
    private String username;
 
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
 
    @TableField(fill = FieldFill.UPDATE)
    private Date updateTime;
 
    // 省略getter和setter方法
}

 然后，在插入和更新数据时，MyBatis-Plus会自动填充createTime和updateTime字段的值。

User user = new User();
user.setUsername("test");
userMapper.insert(user); // 在插入数据时，自动填充createTime字段的值
 
user.setUsername("test2");
userMapper.updateById(user); // 在更新数据时，自动填充updateTime字段的值

通过这种方式，可以方便地进行自动填充操作，减少了手动填充的工作量。

@Version

标识乐观锁字段，用于实现乐观锁机制。

@EnumValue

标识枚举类字段对应的数据库存储值。

@TableLogic

标识逻辑删除字段。

@KeySequence

标识主键序列生成策略。

@InterceptorIgnore

用于标识方法是否忽略拦截器的拦截。

CRUD接口

        mp封装了一些最基础的CRUD方法，只需要直接继承mp提供的接口，无需编写任何SQL，即可食用。mp提供了两套接口，分别是Mapper CRUD接口和Service CRUD接口。并且mp还提供了条件构造器Wrapper，可以方便地组装SQL语句中的WHERE条件。

Mapper CRUD接口

        只需定义好实体类，然后创建一个接口，继承mp提供的BaseMapper，即可食用。mp会在mybatis启动时，自动解析实体类和表的映射关系，并注入带有通用CRUD方法的mapper。BaseMapper里提供的方法，部分列举如下：

insert(T entity) 插入一条记录

deleteById(Serializable id) 根据主键id删除一条记录

delete(Wrapper wrapper) 根据条件构造器wrapper进行删除

selectById(Serializable id) 根据主键id进行查找

selectBatchIds(Collection idList) 根据主键id进行批量查找

selectByMap(Map map) 根据map中指定的列名和列值进行等值匹配查找 selectMaps(Wrapper wrapper) 根据 wrapper 条件，查询记录，将查询结果封装为一个Map，Map的key为结果的列，value为值

selectList(Wrapper wrapper) 根据条件构造器wrapper进行查询

update(T entity, Wrapper wrapper) 根据条件构造器wrapper进行更新

updateById(T entity)

下面讲解几个比较特别的方法

selectMaps

  BaseMapper接口还提供了一个selectMaps方法，这个方法会将查询结果封装为一个Map，Map的key为结果的列，value为值

该方法的使用场景如下：

只查部分列

         当某个表的列特别多，而SELECT的时候只需要选取个别列，查询出的结果也没必要封装成Java实体类对象时（只查部分列时，封装成实体后，实体对象中的很多属性会是null），则可以用selectMaps，获取到指定的列后，再自行进行处理即可

@Test  
   public void test3() {  
    QueryWrapper wrapper = new QueryWrapper<>();  
    wrapper.select("id","name","email").likeRight("name","黄");  
    List> maps = userMapper.selectMaps(wrapper);  
    maps.forEach(System.out::println);  
   }

进行数据统计

// 按照直属上级进行分组，查询每组的平均年龄，最大年龄，最小年龄  
  /**  
  select avg(age) avg_age ,min(age) min_age, max(age) max_age from user group by manager_id having sum(age) < 500;  
  **/  
    
  @Test  
  public void test3() {  
   QueryWrapper wrapper = new QueryWrapper<>();  
   wrapper.select("manager_id", "avg(age) avg_age", "min(age) min_age", "max(age) max_age")  
     .groupBy("manager_id").having("sum(age) < {0}", 500);  
   List> maps = userMapper.selectMaps(wrapper);  
   maps.forEach(System.out::println);  
  }

selectObjs

        只会返回第一个字段（第一列）的值，其他字段会被舍弃

@Test  
 public void test3() {  
  QueryWrapper wrapper = new QueryWrapper<>();  
  wrapper.select("id", "name").like("name", "黄");  
  List