Mybatis Plus从入门到精通

简介

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

快速入门体验

准备工作

1.准备一个数据库，假设有如下数据（官网案例）

对应的 $sql$ 语句如下：

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

添加依赖

	这里只添加了MybatisPlus的依赖，其他springboot的依赖这里就不列出了
       <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.2.0</version>
        </dependency>

注意Mybatis和MybatisPlus尽量不要同时导入，直接导入MybatisPlus即可

配置

1.在 application.yaml 中配置 mysql 连接的属性

spring:
  datasource:
    url: jdbc:mysql://localhost:3306/test?serverTimezone=UTC&characterEncoding=utf-8&useSSL=false
    username: root
    password: 123456

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

@SpringBootApplication
@MapperScan("com.onlinequery.onlinequery.mapper")
public class Application {

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

项目结构如下：

编码

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

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

2.编写Mapper类 UserMapper.java

public interface UserMapper extends BaseMapper<User> {

}

3.编写测试函数

	@Autowired
    UserMapper userMapper;

    @Test
    public void testSelect() {
        List<User> users = userMapper.selectList(null);//null表示没有限制，查询所有
        users.forEach(System.out::println);
    }

结果如下：

在这里我们就完成了最简单的一个查询，但是我们没有写过任何的sql语句，细心的朋友会发现，userMapper还有很多方法，这都是因为我们继承了BaseMapper，里面都是MybatisPlus帮我们实现好的东西，直接调用即可，接下来，我们继续探讨MybatisPlus的应用。

配置输入日志

由于我们的sql都是MybatisPlus都生成了，于是我们配置一下日志，看看生成了sql是啥。
这个操作只需要在之前的yaml配置文件里面添加以下配置即可

mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
# 使用的标准输出    

效果如下：

插入测试和主键策略

目前位置，我们实现了简单的查询，后面还会讲解复杂的条件查询，这里我们来测试一下插入

从这里可以看到，我们需要传入一个 User 的实体对象

代码如下:

@Test
    public void testInsert() {
        User user = new User();
        user.setAge(123);
        user.setName("cy");
        user.setEmail("1131158493@qq.com");
        userMapper.insert(user);
    }

细心的朋友可能就会发现了，我并没有设置ID，再插入的时候，他自动给我们生成了一个id，我们可以去数据库查询一下。

id和代码生成的一模一样，这是因为数据库插入的id的默认为：全局的唯一id，目前有许多主键生成策略，详细可以查看：分布式全局唯一id生成。
当然也有许多小伙伴使用过，数据库的级别的自增(auto_increment) ,其实在代码上面也是可以实现的，具体我们只需要给id上面添加一个注解即可完成，当然在数据库上面也是需要先开启自增。

	@TableId(type = IdType.AUTO) // 在之前的实体类添加该注解
    private Long id;
    private String name;
    private Integer age;
    private String email;

我们再来测试一下插入，

我们可以看到这里后面的id都是自增1，我们可以看看其他的策略，IdType类如下。

//这是所有的策略 
public enum IdType {
    AUTO(0), 		// 自增
    NONE(1),		// 不设置
    INPUT(2),		// 需要你自己设置
    ID_WORKER(3),	// 默认的全局唯一ID
    UUID(4),		// uuid不懂的百度吧
    ID_WORKER_STR(5); // ID_WORKER 的字符串表示
    private final int key;

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

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

更新和自动填充

这里也是需要一个实体类，具体代码如下：

    @Test
    public void testUpdate() {
        User user = new User();
        user.setId(5L);
        user.setName("cyoking");
        user.setAge(24);
        int i = userMapper.updateById(user);
        System.out.println(i);

上面代码我只修改了id为：1258248938989920258的名字、年龄，如果你需要修改其他的直接在set即可。

自动填充

在阿里巴巴手册上说，一个表都应该包含两个属性，这个大家平时可能也会用到，分别是：
  gmt_create: 创建时间
  gmt_modified: 修改时间
平时大家在操作的时候可以通过数据库的触发器来设置，当插入和更新的时候就会自动更新这两个字段。

下面给大家介绍代码层面的实现，即不通过触发器来实现，减少数据库的压力。首先我们还是要给我们的数据库添加两个字段，gmt_create和 gmt_modified，新表如下：

接下来就可以在代码里面实现：
1.先更新我们的实体类，将新加的字段补进实体类中。
2.在需要插入时自动填充的字段上面写上注解 @TableField(fill = FieldFill.INSERT)
3.在需要更新时自动填充的字段上面写上注解 @TableField(fill = FieldFill.INSERT_UPDATE)
修改如下：

@Data
public class User {

    @TableId(type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
    @TableField(fill = FieldFill.INSERT)
    private Date gmtCreate;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date gmtModified;
}

4.编写注解处理器（实现一下MetaObjectHandler即可）

@Component
@Slf4j
public class MyMetaObjectHandler implements MetaObjectHandler {
    // 只需要实现 MetaObjectHandler 即可
    @Override
    public void insertFill(MetaObject metaObject) {
        log.debug("start insert fill...");
        // default MetaObjectHandler setFieldValByName(String fieldName, Object fieldVal, MetaObject metaObject)
        // 上面是这个函数的默认实现的函数头，第一个参数是:字段名  第二个参数是：字段值 第三个是：要给那个数据处理
        this.setFieldValByName("gmtCreate",new Date(),metaObject);
        this.setFieldValByName("gmtModified",new Date(),metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
    	log.debug("start update fill...");
        this.setFieldValByName("gmtModified",new Date(),metaObject);
    }
}

5.再次测试插入、修改。

乐观锁

mysql 中有乐观锁 、悲观锁
更多锁相关的知识可以查阅：Mysql各种锁机制

悲观锁：无论做什么都会加上锁，在它看来什么都是不安全，这样效率会变得低下。
乐观锁假设认为数据一般情况下不会造成冲突，所以在数据进行提交更新的时候，才会正式对数据的冲突与否进行检测，如果发现冲突了，则让返回用户错误的信息，让用户决定如何去做，那么如何实现呢，一般来说有以下2种方式，这里只介绍使用版本号实现乐观锁。

使用版本号来实现乐观锁

我们可以在表中添加一个version的字段，当读取数据时，将version字段的值一同读出，数据每更新一次，对此version值加一。当我们提交更新的时候，判断数据库表对应记录的当前版本信息与第一次取出来的version值进行比对，如果数据库表当前版本号与第一次取出来的version值相等，则予以更新，否则认为是过期数据。用下面的一张图来说明：

栗子

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

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

具体实现

1.在数据库添加version字段，默认值为0

2.修改实体类并在version字段添加注解@Version
3.配置插件（在config包下面新建一个MyBatisPlusConfig类）

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

4.测试乐观锁,这里就不模拟多线程，具体参考代码

@Test
    public void TestVersion() {
        // 线程1
        User user = new User();
        user.setId(5L);
        user.setName("晨晨");
        // 线程2
        User user2 = new User();
        user2.setId(5L);
        user2.setName("黑哥抬");
        // 线程2 抢先执行
        userMapper.updateById(user2);
        userMapper.updateById(user);

    }

查询、分页

条件查询器Wrapper

我们平时的负责sql都由他来代替，下面简单测试几个案例，更多可以查看条件构造器

案例1： 查询name和email不为空的列

@Test
    public void TestWrapper(){
        QueryWrapper queryWrapper = new QueryWrapper();
        queryWrapper.isNotNull("name");   // 条件1
        queryWrapper.isNotNull("email");  // 条件2
        List list = userMapper.selectList(queryWrapper);
        list.forEach(System.out::println);

    }

值得一提的是QueryWrapper 有很多方法，这些方法通过组合就可以获取不同的sql，我们看看控制台输出的sql

其他案例可以自行查看文档，因为实在是太多了，这里只简单介绍如何使用。

分页查询

只需要在之前的MyBatisPlusConfig里面添加一个组件即可

@Configuration
@MapperScan("com.onlinequery.onlinequery.mapper")
@EnableTransactionManagement
public class MyBatisPlusConfig {
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }
    @Bean
    public PaginationInterceptor paginationInterceptor() {
        return new PaginationInterceptor();
    }
}

测试代码

@Test
    public void TestPage() {
        // 参数1：当前页  参数2： 页面大小
        Page<User> page = new Page<>(1,3);
        QueryWrapper<User> wrapper = new QueryWrapper<>();
        wrapper.isNotNull("name");
        wrapper.between("id",1,5);
        userMapper.selectPage(page,wrapper);    // 查询
        page.getRecords().forEach(System.out::println); // 获取内容
    }

由分页生成的sql 可以看出首先会查询记录条数，然后在使用limit做分页。

删除和逻辑删除

删除

@Test
    public void delete() {
        userMapper.deleteById(1);    //删除一个
        userMapper.deleteBatchIds(Arrays.asList(2,3)); // 接受一个list，删除list内所有id的记录
    }

再次查看数据库的内容

逻辑删除

删除分为两种：
物理删除：直接从mysql表上面删掉这个记录，如上面的删除。
逻辑删除：使用一个变量来标记，比如：deleted，当这个值为0表示没有删除反之1表示删除。

实现

1.在数据库中添加deleted字段
2.修改实体类，并添加注解 @TableLogic
3.在MyBatisConfig类中添加一个组件，3.1.1之后的版本不需要这一步,所以我们就不做了。
4.在application.yml中添加如下配置

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: deleted 
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

测试删除

@Test
    public void TestLogicDelete() {
        userMapper.deleteById(4);
    }

虽然执行的是delete但实际执行的确实update
我们在查询的时候也会自动帮我们填上，deleted = 0,我们在跑一下，最开始的查询所有用户。

代码生成器

添加依赖

<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-generator</artifactId>
    <version>3.2.0</version>
</dependency>
<dependency>
	<groupId>org.apache.velocity</groupId>
	<artifactId>velocity-engine-core</artifactId>
	<version>2.0</version>
</dependency>

参考代码

	 *
 *   welcome:11311
 *   创建时间:2020/5/7
 *
 */


import com.baomidou.mybatisplus.annotation.DbType;
import com.baomidou.mybatisplus.annotation.FieldFill;
import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.generator.AutoGenerator;
import com.baomidou.mybatisplus.generator.config.DataSourceConfig;
import com.baomidou.mybatisplus.generator.config.GlobalConfig;
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.Arrays;

public class Generator {
    public static void main(String[] args) {
        // 需要构建一个代码生成器对象
        AutoGenerator autoGenerator = new AutoGenerator();
        // 配置策略

        //1.全局配置
        GlobalConfig gc = new GlobalConfig();
        // 获取当前工作路径
        String projectPath = System.getProperty("user.dir");
        System.out.println(projectPath);
        gc.setOutputDir(projectPath+"/src/main/java");
        gc.setAuthor("cy");
        //是否覆盖
        gc.setFileOverride(false);
        // 去Service前缀
        gc.setServiceName("%Service");
        gc.setSwagger2(true);
        gc.setIdType(IdType.ID_WORKER);
        gc.setDateType(DateType.ONLY_DATE);

        autoGenerator.setGlobalConfig(gc);

        //设置数据源
        DataSourceConfig dsc = new DataSourceConfig();
        dsc.setUrl("jdbc:mysql://127.0.0.1:3306/test?characterEncoding=utf8&useSSL=false&serverTimezone=Asia/Shanghai");
        dsc.setUsername("root");
        dsc.setPassword("123456");
        dsc.setDriverName("com.mysql.cj.jdbc.Driver");
        dsc.setDbType(DbType.MARIADB);
        autoGenerator.setDataSource(dsc);

        // 3.包的配置
        PackageConfig pc = new PackageConfig();
        pc.setModuleName("blog");
        pc.setParent("com.onlinequery.onlinequery");
        pc.setEntity("entity");
        pc.setMapper("mapper");
        pc.setService("service");
        pc.setController("controller");
        autoGenerator.setPackageInfo(pc);

        // 4.策略配置
        // 策略配置
        StrategyConfig strategy = new StrategyConfig();
        strategy.setInclude("cms_subject"); // 需要什么表就在这里面加，它是一个可变数组
        strategy.setNaming(NamingStrategy.underline_to_camel);
        strategy.setColumnNaming(NamingStrategy.underline_to_camel);
        // 自动lombok
        strategy.setEntityLombokModel(true);
        strategy.setRestControllerStyle(true);
        //自动配置逻辑删除
        strategy.setLogicDeleteFieldName("deleted");
        //自动填充
        TableFill gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);
        TableFill gmtModified = new TableFill("gmtmodified",FieldFill.INSERT_UPDATE);
        strategy.setTableFillList(Arrays.asList(gmtCreate,gmtModified));
        // 乐观锁
        strategy.setVersionFieldName("version");
        //驼峰命名
        strategy.setControllerMappingHyphenStyle(true);
        autoGenerator.setStrategy(strategy);
        autoGenerator.execute();

    }
}

参考：
MybatisPlus官网
乐观锁的实现
深入理解行锁和表锁
狂神教学