MyBatis-Plus 学习笔记

MyBatis-Plus

1、MyBatisPlus概述

需要的基础：Mybatis、Spring、SpringMVC

为什么要学习MyBatisPlus，它可以节省我们大量的工作时间，所有的CRUD代码它都可以自动化完成。

简介

本来 Mybatis 就是来简化 JDBC 操作，MyBatisPlus 简化 Mybatis。

官网：https://mp.baomidou.com/

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

愿景
我们的愿景是成为 MyBatis 最好的搭档，就像 魂斗罗 中的 1P、2P，基友搭配，效率翻倍。

特性

• 无侵入：只做增强不做改变，引入它不会对现有工程产生影响，如丝般顺滑。
• 损耗小：启动即会自动注入基本 CURD，性能基本无损耗，直接面向对象操作，BaseMapper<>
• 强大的 CRUD 操作：内置通用 Mapper、通用 Service，仅仅通过少量配置即可实现单表大部分 CRUD 操作，更有强大的条件构造器，满足各类使用需求，以后简单的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 操作智能分析阻断，也可自定义拦截规则，预防误操作

---

2、快速入门

地址：https://mp.baomidou.com/guide/quick-start.html#%E5%88%9D%E5%A7%8B%E5%8C%96%E5%B7%A5%E7%A8%8B

使用第三方组件：

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

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

-- 真实开发中，version（乐观锁）、deleted（逻辑删除）、gmt_create、gmt_modified

3. 编写项目，初始化项目。使用 SpringBoot 初始化
4. 导入依赖

<!--数据库驱动-->
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
        </dependency>

        <!--lombok-->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

        <!--
        mybatis-plus 是自己开发的,并非官方的
        -->
        <dependency>
            <groupId>com.baomidou</groupId>
            <artifactId>mybatis-plus-boot-starter</artifactId>
            <version>3.0.5</version>
        </dependency>

说明：使用 MyBatis-Plus 可以节省大量的代码，尽量不要同时导入 mybatis 和 mybatis-plus，版本差异。

5. 连接数据库，这一步和 mybatis 相同

spring.datasource.username=root
spring.datasource.password=root
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

6. 传统方式：pojo-dao(连接mybatis，配置mapper.xml)-service-controller
6. 使用了 mybatis-plus 之后

• pojo

	@Data
@AllArgsConstructor
@NoArgsConstructor
public class User {

    private Long id;
    private String name;
    private Integer age;
    private String email;

}

• mapper接口

// 使用 mybatis-plus 之后,在对应的 Mapper 上面继承基本的类 BaseMapper
@Repository // 代表持久层
public interface UserMapper extends BaseMapper<User> {

    // 所有的CRUD操作都已经编写完成了,不需要像以前配置一大堆文件了
}

• 使用 (测试)

@SpringBootTest
class MybatisPlusApplicationTests {

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

    @Test
    void contextLoads() {

        /*
         查询所有用户
         参数是一个Wrapper,条件构造器,这里我们先不用 null
          */
        List<User> users = userMapper.selectList(null);
        users.forEach(System.out::println);
    }

}

• 注意：我们需要在主启动类上，扫描我们的mapper包下的所有接口

@MapperScan("com.lee.mapper")

• 结果
  

思考

1. SQL谁帮我们写的，MyBatis-Plus
2. 方法哪里来的？Mybatis-Plus都写好了

---

3、配置日志

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

# 配置日志 Log4j2Impl Slf4jImpl是需要对应依赖的
mybatis-plus.configuration.log-impl=org.apache.ibatis.logging.stdout.StdOutImpl

配置完毕日志之后，再去执行可以看到和之前的不一样，后面的学习就需要注意这个自动生成的SQL

---

4、CRUD扩展

Insert 插入

 // 测试插入
    @Test
    public void testInsert(){

        User user = new User();
        user.setName("Swae Lee");
        user.setAge(18);
        user.setEmail("lee@qq.com");

        int insert = userMapper.insert(user); // 帮我们自动生成Id
        System.err.println(insert); // 受影响的行数
        System.err.println(user); // 发现 id 会自动回填
    }

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

4.1 主键生成策略

默认ID_WORKER，@TableId(type = IdType.ID_WORKER)

分布式系统唯一 id 生成方案汇总：https://www.cnblogs.com/haoxinyue/p/5208136.html

Twitter的snowflake算法

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

主键自增

我们需要配置主键自增

1. 实体类字段上 @TableId(type = IdType.ID_WORKER.AUTO)
2. 数据库中一定要是自增
   
3. 再次测试插入即可

与其的源码解释

public enum IdType {
    AUTO(0), // 数据库id自增
    NONE(1), // 未设置主键
    INPUT(2), // 手动输入
    ID_WORKER(3), // 默认的全局id
    UUID(4), // 全局唯一id
    ID_WORKER_STR(5); // ID_WORKER 字符串表示

4.2 更新操作

mybatis-plus的强大之处，它可以通过条件，自动拼接动态sql。

// 测试更新
    @Test
    public void testUpdate(){
        User user = new User();
        // 通过条件自动拼接动态sql
        user.setId(6L);
        user.setName("quavo");
        user.setAge(27);

        // 注意:名字是updateById,参数是一个对象!
        int i = userMapper.updateById(user);
        System.err.println(i);
    }

4.3 自动填充

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

阿里巴巴开发手册：所有的数据库表：gmt_create(创建时间)、gmt_modified(修改时间)几乎所有的表都要配置的，而且需要自动化.

方式一：数据库级别 (工作中不允许你修改数据库)

1. 在表中新增字段 gmt_create/create_time、gmt_modified/update_time
   
2. 再次测试插入方法，我们需要先把实体类同步。

    private Date createTime;
    private Date updateTime;

3. 再次更新查看结果即可
   

方式二：代码级别

1. 删除数据库的默认值、更新操作。
   
2. 实体类字段属性上需要增加注解

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

    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

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

@Slf4j
@Component // 一定不要忘记把处理器加到 IOC 容器中
public class MyMetaObjectHandler implements MetaObjectHandler {

    // 插入时的填充策略
    @Override
    public void insertFill(MetaObject metaObject) {
        log.info("start insert fill...");
        //    default MetaObjectHandler 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. 测试，插入数据后，更改数据，观察时间即可

// 测试插入
    @Test
    public void testInsert(){

        User user = new User();
        user.setName("Thugger");
        user.setAge(30);
        user.setEmail("YSL@qq.com");

        int insert = userMapper.insert(user); // 帮我们自动生成Id
        System.err.println(insert); // 受影响的行数
        System.err.println(user); // 发现 id 会自动回填
    }

    // 测试更新
    @Test
    public void testUpdate(){
        User user = new User();
        // 通过条件自动拼接动态sql
        user.setId(1429652255686078469L);
        user.setAge(31);

        // 注意:名字是updateById,参数是一个对象!
        int i = userMapper.updateById(user);
        System.err.println(i);
    }

4.4 乐观锁

在面试过程中，我们经常被问道乐观锁，悲观锁。

• 乐观锁：顾名思义，十分乐观，总是认为不会出现问题，无论干什么都不去上锁。如果出现了问题，再次更新值测试（version、new version）这里在我的Redis学习笔记 ‘事务’ 处也有讲解 5、事务
• 悲观锁：十分悲观，认为总是出现问题，无论干什么都会上锁，再去操作。

乐观锁实现方式：

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

乐观锁：先查询，获得版本号 version = 1

--A
update user set name = "swae lee",version = version + 1
where id = 2

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

测试 MP 乐观锁插件

1. 给数据库增加 version 字段
   
2. 我们实体类加对应的字段

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

3. 注册组件

// 扫描Mapper文件夹
@MapperScan("com.lee.mapper")
@EnableTransactionManagement
@Configuration // 配置类
public class MyBatisPlusConfig {

    // 注册乐观锁插件
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor() {
        return new OptimisticLockerInterceptor();
    }

}

4. 测试乐观锁

测试乐观锁成功

// 测试乐观锁成功
    @Test
    public void testOptimisticLocker(){
        // 1.查询用户信息
        User user = userMapper.selectById(1L);
        // 2.修改用户信息
        user.setName("Kanye West");
        user.setEmail("donda@qq.com");
        // 3.执行更新操作
        userMapper.updateById(user);
    }

测试乐观锁失败

// 多线程下测试乐观锁失败
    @Test
    public void testOptimisticLocker2(){

        // 线程1
        User user = userMapper.selectById(2L);
        user.setName("Lil uzi vert");
        user.setEmail("luv@qq.com");

        // 模拟另外一个线程执行了插队操作
        User user2 = userMapper.selectById(2L);
        user2.setName("Roddy Ricch");
        user2.setEmail("DaBox@qq.com");
        userMapper.updateById(user2);


        userMapper.updateById(user); // 如果没有乐观锁,就会覆盖插队线程的值
    }

4.5 查询操作

测试查询

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

测试批量查询

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

按条件查询之一,使用 map 操作

    // 按条件查询之一,使用 map 操作
    @Test
    public void testSelectByMap(){
        HashMap<String, Object> map = new HashMap<>();

        // 自定义查询
        map.put("name", "Roddy Ricch");
        map.put("age", "20");

        List<User> userList = userMapper.selectByMap(map);
        userList.forEach(System.err::println);
    }

4.6 分页查询

分页在网站使用的十分多

1. 原始的 limit 进行分页
2. pageHepler 第三方插件
3. MP 其实也配置了分页插件

如何使用

1. 配置拦截器即可

 // 分页插件
    @Bean
    public PaginationInterceptor paginationInterceptor(){
        PaginationInterceptor paginationInterceptor = new PaginationInterceptor();
        return paginationInterceptor;
    }

2. 直接使用Page对象即可

// 测试分页查询
    @Test
    public void testPage(){
        // 参数一:当前页
        // 参数二:页面大小
        // 使用了分页插件之后,所有的分页操作也变得简单了
        Page<User> page = new Page<>(2,5);

         userMapper.selectPage(page, null);

         page.getRecords().forEach(System.err::println);
        System.err.println(page.getTotal());
    }

4.7 删除操作

测试删除

 // 测试删除
    @Test
    public void testDeleteById(){
        userMapper.deleteById(6L);
    }

通过 Id 批量删除

    // 通过 Id 批量删除
    @Test
    public void testDeleteBatchId(){
        userMapper.deleteBatchIds(Arrays.asList(1429652255686078466L,1429652255686078469L));
    }

通过 map 删除

    // 通过 map 删除
    @Test
    public void testDeleteMap(){
        HashMap<String, Object> map = new HashMap<>();

        map.put("name", "Tom"); //区分大小写,且多个条件相对应一个删除
        map.put("age", "21");

        userMapper.deleteByMap(map);
    }

我们在工作中会遇到一些问题：逻辑删除

4.8 逻辑删除

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

我们经常在网站上看到，管理员可以查看被删除的记录，防止数据的丢失，类似于回收站

测试：

1. 在数据表中新增一个 deleted 字段
   
2. 实体类中增加属性

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

3. 配置

// 逻辑删除组件
 @Bean
    public ISqlInjector sqlInjector(){
        return new LogicSqlInjector();
    }

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

4. 测试

// 测试删除
    @Test
    public void testDeleteById(){
        userMapper.deleteById(5L);
    }

我们测试的是删除5号操作，走的却是更新操作

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

我们再去查询5号用户，查询的时候会自动过滤被逻辑删除的字段

以上的所有 CRUD 操作，以及扩展操作，我们都必须精通掌握。会大大提高工作和写项目的效率

---

5、性能分析插件

---

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

我们在平时的开发中，会遇到一些慢sql。测试、druid…

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

1. 导入插件
   config配置

	// SQL 执行效率插件
    @Bean
    @Profile({"dev","test"})// 设置 dev test 开发环境开启,保证我们的效率
    public PerformanceInterceptor performanceInterceptor(){
        PerformanceInterceptor interceptor = new PerformanceInterceptor();
        // 在工作中十分常用,不允许用户等待
        interceptor.setMaxTime(1); // 设置SQL执行的最大时间,如果超过则不执行(默认毫秒)
        interceptor.setFormat(true); // 开启格式化
        
        return interceptor;
    }

设置开发环境

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

2. 测试使用

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

3. 查询测试
   设置1毫秒后报错
   
   设置100毫秒后可以查出
   

使用性能分析插件，可以帮助我们提升效率

---

6、条件构造器

---

十分重要：Wrapper

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

• 测试一
  查询 name 不为空的用户，并且邮箱不会空的用户，年龄大于等于12岁的。isNotNull不为空,ge大于

@Test
    void contextLoads() {
        // 查询 name 不为空的用户,并且邮箱不会空的用户,年龄大于等于12岁的

        QueryWrapper<User> wrapper = new QueryWrapper<>();

        wrapper
                .isNotNull("name")
                .isNotNull("email")
                .ge("age", 12);

        userMapper.selectList(wrapper).forEach(System.err::println); // 和我们刚学的 map 对比一下

    }

• 测试二
  查询 name 为 Jack，只查询一个用户selectOne。eq相等

@Test
    void test2() {
        // 查询 name 为 Jack,只查询一个用户selectOne

        QueryWrapper<User> wrapper = new QueryWrapper<>();

        wrapper.eq("name", "Jack"); // 不区分大小写

        User user = userMapper.selectOne(wrapper);// 和我们刚学的 map 对比一下
        System.err.println(user);

    }

• 测试三
  查询年龄在 20 ~ 30 岁之间的用户，selectCount查询结果数。between

@Test
    void test3() {
        // 查询年龄在 20 ~ 30 岁之间的用户,selectCount查询结果数

        QueryWrapper<User> wrapper = new QueryWrapper<>();

        wrapper.between("age", 20, 30); // 区间

        Integer count = userMapper.selectCount(wrapper); // 查询结果数
        System.err.println(count);

    }

• 测试四
  模糊查询，名字中不包含 E,且包含O的,email以 t 开头的。notLike、like、likeRight

@Test
    void test4() {
        // 模糊查询,名字中不包含 E,且包含O的,email以 t 开头的

        QueryWrapper<User> wrapper = new QueryWrapper<>();

        // 左和右 t%

        wrapper
                .notLike("name", "E")
                .like("name", "o")
                .likeRight("email", "t");

        List<Map<String, Object>> maps = userMapper.selectMaps(wrapper);

        maps.forEach(System.err::println);

    }

• 测试五
  嵌套SQL，inSql

 @Test
    void test5() {
        // 嵌套 SQL
        QueryWrapper<User> wrapper = new QueryWrapper<>();

        // id 在子查询中查出来
        wrapper.inSql("id", "select id from user where id < 5");

        List<Object> objects = userMapper.selectObjs(wrapper);

        objects.forEach(System.err::println);

    }

• 测试六
  通过 id 降序排序，orderByDesc

// 测试六
    @Test
    void test6() {
        // 通过 id 降序排序
        QueryWrapper<User> wrapper = new QueryWrapper<>();

        wrapper.orderByDesc("id");

        List<User> users = userMapper.selectList(wrapper);

        users.forEach(System.err::println);

    }

• 测试七
  根据 age 分组，查询年龄和对应的年龄个数。group by

 @Test
    void test7() {
        // 根据 age 分组,查询年龄和对应的年龄个数
        QueryWrapper<User> wrapper = new QueryWrapper<>();

        wrapper.groupBy("age").select("age","count(age)");

        List<User> users = userMapper.selectList(wrapper);

        users.forEach(System.err::println);

    }

---

7、代码自动生成器

---

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

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

测试：

// 代码自动生成器
public class LeeCode {

    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("Swae Lee"); //设置作者名字
        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.setUsername("com.mysql.cj.jdbc.Driver");
        dsc.setDriverName("root");
        dsc.setPassword("root");
        dsc.setDbType(DbType.MYSQL);

        mpg.setDataSource(dsc);

        //3.包的配置
        PackageConfig pc = new PackageConfig();

        pc.setModuleName("blog");
        pc.setParent("com.lee"); // 放在哪个包下
        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 gmtCreate = new TableFill("gmt_create", FieldFill.INSERT);// 自动填充
        TableFill gmtModified = new TableFill("gmt_modified", FieldFill.INSERT);// 自动填充
        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(); //执行代码构造器

    }

}

---

本笔记参考视频：B站up主–狂神说