OddFar's Notes
  • 框架
  • mybatis-plus
zhiyuan
2021-05-09
目录

mybatis-plus学习笔记

# MyBatisPlus

狂神mybatis-plus视频教程：https://www.bilibili.com/video/BV17E411N7KN

# 概序

原先写crud，需要在xml配置或注解中写sql语句，用了MyBatisPlus后，对单表进行crud无需再写sql语句

简单的增删改查还行，不支持多表操作，一般不在公司里使用，适合个人快速开发和偷懒使用

官网：https://baomidou.com/

简介：简化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 操作智能分析阻断，也可自定义拦截规则，预防误操作

# 快速开始

官网地址：https://mp.baomidou.com/guide/quick-start.html

使用第三方组件：

  1. 导入对应的依赖

  2. 研究依赖如何配置

  3. 代码如何编写

  4. 提高扩展技术能力！

步骤：

1、创建数据库 mybatis_plus

2、创建user表并插入数据

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

DELETE FROM user;

INSERT INTO user (id, name, age, email) VALUES
(1, 'Jone', 18, '[email protected]'),
(2, 'Jack', 20, '[email protected]'),
(3, 'Tom', 28, '[email protected]'),
(4, 'Sandy', 21, '[email protected]'),
(5, 'Billie', 24, '[email protected]');
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

3、编写项目，初始化项目！使用SpringBoot初始化！

4、导入依赖

<!-- 数据库驱动 -->
<dependency>
    <groupId>mysql</groupId>
    <artifactId>mysql-connector-java</artifactId>
</dependency>
<dependency>
    <groupId>org.projectlombok</groupId>
    <artifactId>lombok</artifactId>
</dependency>
<dependency>
    <groupId>com.baomidou</groupId>
    <artifactId>mybatis-plus-boot-starter</artifactId>
    <version>3.4.2</version>
</dependency>
1
2
3
4
5
6
7
8
9
10
11
12
13
14

5、填写properties配置

spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.url=jdbc:mysql://localhost:3306/mybatis_plus?useSSL=false&useUnicode=true&characterEncoding=utf-8&serverTimezone=GMT%2B8
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
1
2
3
4

6、填写测试类，读取数据库

原先我们使用mybatis：pojo-dao（连接mybatis，配置mapper.xml文件）-service-controller

现在：

  • pojo类

    @Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}
    1
    2
    3
    4
    5
    6
    7
    8
    9

  • mapper接口

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

  • springboot启动类

    添加注解来扫描

    @MapperScan("com.oddfar.mapper")
    1

  • 测试类

    // 继承了BaseMapper，所有的方法都来自己父类
// 我们也可以编写自己的扩展方法！
@Autowired
private UserMapper userMapper;

@Test
void contextLoads() {
    // 参数是一个 Wrapper ，条件构造器，这里我们先不用，填写null
    // 查询全部用户
    List<User> users = userMapper.selectList(null);
    users.forEach(System.out::println);
}
    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12

# 配置日志

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

# 配置日志
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl
1
2

# CRUD扩展

创建controller包，编写UserController类

# 插入操作

@Test
void addUser() {
    User user = new User();
    user.setName("zhiyuan");
    user.setAge(3);
    user.setEmail("[email protected]");

    // 帮我们自动生成id
    int result = userMapper.insert(user); 
    System.out.println(result); // 受影响的行数
    System.out.println(user); // 发现，id会自动回填
}
1
2
3
4
5
6
7
8
9
10
11
12

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

# 主键生成策略

默认 ID_WORKER 全局唯一id 分布式系统唯一id生成：https://www.cnblogs.com/haoxinyue/p/5208136.html

雪花算法：

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

主键自增：

实体类字段上 @TableId(type = IdType.AUTO)

image-20210405172103065

数据库id字段自增！

image-20210405172141349

关于注解的介绍：https://baomidou.com/guide/annotation.html#tableid

# 更新操作

    /**
     * 更改一个用户
     */
    @Test
    void testUpdate() {
        User user = new User();
        // 通过条件自动拼接动态sql
        user.setId(5L);
        user.setName("test");
        user.setAge(5);
        // 注意：updateById 但是参数是一个 对象！
        int i = userMapper.updateById(user);
        System.out.println(i);
    }
1
2
3
4
5
6
7
8
9
10
11
12
13
14

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

# 自动填充

官网：https://baomidou.com/guide/auto-fill-metainfo.html

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

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

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

1、在表中新增字段 create_time, update_time

ALTER TABLE `mybatis_plus`.`user`
  ADD COLUMN `create_time` DATETIME DEFAULT CURRENT_TIMESTAMP NULL COMMENT '创建时间' AFTER `email`,
  ADD COLUMN `update_time` DATETIME DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP NULL COMMENT '更新时间' AFTER `create_time`;
1
2
3

image-20210405173344140

默认：CURRENT_TIMESTAMP

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

方式二：代码级别

1、删除数据库的默认值、更新操作！

image-20210405173548133

2、实体类字段属性上需要增加注解

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

3、编写处理器来处理这个注解即可！

package com.oddfar.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) {
        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);
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28

4、测试插入 ，测试更新、观察时间即可！

# 乐观锁

在面试过程中，我们经常会被问道乐观锁，悲观锁！这个其实非常简单！

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

悲观锁：顾名思义十分悲观，他总是任务总是出现问题，无论干什么都会上锁！再去操作！

当要更新一条记录的时候，希望这条记录没有被别人更新 乐观锁实现方式：

乐观锁实现方式：

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

测试一下mybatis-plus的乐观锁插件

官方文档（必看）：https://baomidou.com/guide/interceptor.html

有的方法会过期，具体操作以官方文档例子为主

1、给数据库中增加version字段！

image-20210405175422788

2、我们实体类加对应的字段

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

3、注册组件

package com.oddfar.config;

import com.baomidou.mybatisplus.extension.plugins.MybatisPlusInterceptor;
import com.baomidou.mybatisplus.extension.plugins.inner.OptimisticLockerInnerInterceptor;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author zhiyuan
 * @date 2021/4/5 17:57
 */
// 扫描我们的 mapper 文件夹
@MapperScan("com.oddfar.mapper")
@Configuration // 配置类
public class MyBatisPlusConfig {

    // 注册乐观锁和分页插件(新版：3.4.0)
    @Bean
    public MybatisPlusInterceptor mybatisPlusInterceptor(){
        MybatisPlusInterceptor interceptor = new MybatisPlusInterceptor();
        interceptor.addInnerInterceptor(new OptimisticLockerInnerInterceptor()); // 乐观锁插件
        return interceptor;
    }

}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26

旧版如下：

@Bean
public OptimisticLockerInterceptor OptimisticLockerInterceptor() {
    return new OptimisticLockerInterceptor();
}
1
2
3
4

4、测试一下！

/**
 * 测试乐观锁
 */
@Test
public void testOptimisticLocker(){
    // 1、查询用户信息
    User user = userMapper.selectById(1L);

    // 2、修改用户信息
    user.setName("zhiyuan");
    user.setEmail("[email protected]");
    // 3、执行更新操作
    userMapper.updateById(user);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14

我们来模拟下

// 测试乐观锁失败！多线程下
@Test
public void testOptimisticLocker2(){
    // 线程 1
    User user = userMapper.selectById(1L);
    user.setName("zhiyuan000000");
    user.setEmail("[email protected]");
    // 模拟另外一个线程执行了插队操作
    User user2 = userMapper.selectById(1L);
    user2.setName("zhiyuan1111111");
    user2.setEmail("[email protected]");
    userMapper.updateById(user2);
    // 自旋锁来多次尝试提交！
    userMapper.updateById(user); // 如果没有乐观锁就会覆盖插队线程的值！
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

image-20210405184334804

如果不加乐观锁，以上代码，name最后就是zhiyuan000000

# 查询操作

// 指定id查询
@Test
public void testSelectById(){
    User user = userMapper.selectById(1L);
    System.out.println(user);
}
// 多个id批量查询！
@Test
public void testSelectByBatchId(){
    List<User> users = userMapper.selectBatchIds(Arrays.asList(1L, 2L, 3L));
    users.forEach(System.out::println);
}
// 多个where条件查询之一使用map操作
@Test
public void testSelectByBatchIds(){
    HashMap<String, Object> map = new HashMap<>();
    // 自定义要查询
    map.put("name","zhiyuan");
    map.put("age",3);
    List<User> users = userMapper.selectByMap(map);
    users.forEach(System.out::println);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

# 分页查询

分页在网站使用的十分之多！

1、原始的 limit 进行分页 2、pageHelper 第三方插件 3、MP其实也内置了分页插件！

mybais-plus分页查询方法：

1、配置拦截器组件即可

interceptor.addInnerInterceptor(new PaginationInnerInterceptor(DbType.H2));//分页插件
1

旧版如下：

//分页插件
@Bean
public PaginationInterceptor paginationInterceptor() {
    PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
    return paginationInterceptor;
}
1
2
3
4
5
6

2、直接使用Page对象即可！

/**
 * 测试分页查询
 */
@Test
public void testPage() {
    //参数一：当前页
    //参数二：页面大小
    Page<User> page = new Page<>(1, 5);
    userMapper.selectPage(page, null);
    page.getRecords().forEach(System.out::println);
    System.out.println(page.getTotal());//总数量

}
1
2
3
4
5
6
7
8
9
10
11
12
13

# 删除操作

// 通过id单个删除
@Test
public void testDeleteById(){
    userMapper.deleteById(1379026108137123842L);
}
// 通过id批量删除
@Test
public void testDeleteBatchId(){
   userMapper.deleteBatchIds(Arrays.asList(1379026108137123842L,1379026441420791810L));
}
// 通过map删除
@Test
public void testDeleteMap(){
    HashMap<String, Object> map = new HashMap<>();
    map.put("name","zhiyuan4");
    userMapper.deleteByMap(map);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

# 逻辑删除

官方文档：https://baomidou.com/guide/logic-delete.html

物理删除 ：从数据库中直接移除

逻辑删除 ：再数据库中没有被移除，而是通过一个变量来让他失效！ 比如一个系统，有管理员，操作员，用户等...... 设置数据库的时候，加个deleted字段，默认为0，代表数据存在 当用户或操作员要删除数据了，我们则把deleted赋值为1，表示数据已删除 这样管理员则可以在后台查询被删除的记录，防止数据的丢失，类似于回收站！

方法如下：

1、在数据表中增加一个 deleted 字段

image-20210405235056518

2、实体类中增加属性

@TableLogic //逻辑删除
private Integer deleted;
1
2

3、配置

application.yml（properties也可以）

mybatis-plus:
  global-config:
    db-config:
      logic-delete-field: flag  # 全局逻辑删除的实体字段名(since 3.3.0,配置后可以忽略不配置步骤2)
      logic-delete-value: 1 # 逻辑已删除值(默认为 1)
      logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)
1
2
3
4
5
6
7

4、测试

image-20210406001501121

记录依旧在数据库，但是值确已经变化了！

# 性能分析插件

作用：性能分析拦截器，用于输出每条 SQL 语句及其执行时间。MP也提供性能分析插件，如果超过这个时间就停止运行，不过新版本已去掉这功能。

推荐使用druid

或者使用P6Spy：

SpringBoot - MyBatis-Plus使用详解18（结合P6Spy进行SQL性能分析） (opens new window)

# 条件构造器

官网文档：https://baomidou.com/guide/wrapper.html

wrapper：十分重要： 我们写一些复杂的sql就可以使用它来替代！

1、查询name不为空的用户，并且邮箱不为空的用户，年龄大于12

@Test
void contextLoads() {
    //查询name不为空的用户，并且邮箱不为空的用户，年龄大于12
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.isNotNull("name")
            .isNotNull("email")
            .ge("age", 12);
    userMapper.selectList(wrapper).forEach(System.out::println); 
}
1
2
3
4
5
6
7
8
9

2、查询名字为zhiyuan2

@Test
void test2(){
    //查询名字为zhiyuan2
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.eq("name", "zhiyuan2");
    User user = userMapper.selectOne(wrapper);
    System.out.println(user);
}
1
2
3
4
5
6
7
8

3、查询年龄在19到30岁之间的用户

@Test
void test3(){
    //查询年龄在19到30岁之间的用户
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.between("age", 19, 30); //区间
    Integer count = userMapper.selectCount(wrapper);
    System.out.println(count);
}
1
2
3
4
5
6
7
8

4、查询name不包含t，邮箱以123开头

  • 例: notLike("name", "王")--->name not like '%王%'
  • 例: likeRight("name", "王")--->name like '王%'
//模糊查询
@Test
void test4(){
    //查询name不包含t，邮箱以123开头
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    wrapper.notLike("name", "t")
            .likeRight("email", "123");
    List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);
    maps.forEach(System.out::println);
}
1
2
3
4
5
6
7
8
9
10

5、子查询

@Test
void test5(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //id 在子查询中查出来
    wrapper.inSql("id", "select id from user where id < 3");
    List<Object> objects = userMapper.selectObjs(wrapper);
    objects.forEach(System.out::println);
}
1
2
3
4
5
6
7
8

最后sql：

SELECT id,name,age,email,version,deleted,create_time,update_time FROM user WHERE deleted=0 AND (id IN (select id from user where id < 3))

6、通过id进行排序--降序

@Test
void test6(){
    QueryWrapper<User> wrapper = new QueryWrapper<>();
    //通过id进行排序--降序
    wrapper.orderByDesc("id");
    List<User> users = userMapper.selectList(wrapper);
    users.forEach(System.out::println);
}
1
2
3
4
5
6
7
8

# 代码自动生成器

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

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

测试：

public class Code {
    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("ChanV");
        gc.setOpen(false);
        gc.setFileOverride(false);  //是否覆盖
        gc.setServiceName("%sService"); //去Service的I前缀
        gc.setIdType(IdType.ID_WORKER);
        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=GMT%2B8");
        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.chanv");
        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 createTime = new TableFill("create_time", FieldFill.INSERT);
        TableFill updateTime = new TableFill("update_time", FieldFill.UPDATE);
        ArrayList<TableFill> tableFills = new ArrayList<>();
        tableFills.add(createTime);
        tableFills.add(updateTime);
        strategy.setTableFillList(tableFills);
        //乐观锁
        strategy.setVersionFieldName("version");
        strategy.setRestControllerStyle(true);
        strategy.setControllerMappingHyphenStyle(true);     //localhost:8080/hello_id_2
        mpg.setStrategy(strategy);

        mpg.execute();  //执行代码构造器
    }
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

在这里插入图片描述

在 GitHub 上编辑此页 (opens new window)
最后更新: 2023/03/26, 13:03:00
mybatis学习笔记
spring

← spring→

Theme by Vdoing | Copyright © 2021-2023 oddfar | 冀ICP备20001094号