文章目录

• 0. 前言
• 1. 相关概念
• • 1.1 名称介绍
  • 1.2 官网特性介绍
• 2. 快速入门
• • 2.1 准备工作
  • • 2.2.1 准备表
    • 2.2.2 创建工程
  • 2.2 入门测试
  • • 2.2.1 编写实体类
    • 2.2.2 编写Mapper
    • 2.2.3 编写测试类
• 3. CRUD
• • 3.1 条件构造器
  • • 3.1.1 AbstractWrapper
    • • （1） 基本比较操作
      • （2） allEq
      • （3） 模糊查询
      • （4）分组查询、排序
      • （5）连接 or and
    • 3.1.2 QueryWrapper
    • 3.1.3 UpdateWrapper
  • 3.2 Mapper CRUD 接口
  • • 3.2.1 Insert
    • 3.2.2 Delete
    • 3.2.3 Update
    • 3.2.4 Select
  • 3.3 Service CRUD 接口
  • • 3.3.1 SaveOrUpdate
    • 3.3.2 Remove
    • 3.3.3 Page
    • 3.3.4 Count
  • 3.4 ID 生成器
  • • 3.4.1 默认ID生成器
    • 3.4.2 自定义ID生成器
  • 3.5 Lambda Wrapper
  • • 3.5.1 LambdaQueryWrapper
    • 3.5.2 LambdaUpdateWrapper
• 4. 连表查询
• • 4.1 MP的连表解决方案
  • 4.2 Mybatis连表
• 5. 总结

0. 前言

Mybatis Plus 个人学习笔记。

学习前提：有一定的SQL、Mybatis 基础。

学习目标：快速入门。

参考官网：MybatisPlus官网
参考资料: 稀土掘金优质文章
博客园优质文章

1. 相关概念

我们用传统的 Mybatis 进行项目的持久层开发时，常常要自己手动写很多 Mapper.xml 文件。 同时我们可以了解到，使用MybatisPlus可以节省很多SQL的编写，解放了一部分劳动力。

下面我们开始正式学习！

1.1 名称介绍

MybatisPlus，简称MP，是一个Mybatis增强工具。

1.2 官网特性介绍

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

简单总结一下上面提到的特性：
不影响传统Mybatis的开发方式，开销、损耗小，支持多种数据库、多种操作方式。

这部分刚开始的时候了解一下就好，我们的目标是会用。建议用熟练了以后再回过头来详细阅读特性。

2. 快速入门

按照官网的指示和用例来入门。

2.1 准备工作

2.2.1 准备表

在准备表之前，我们首先要准备一个数据库，名称自己定。
例如，我的库：

CREATE DATABASE mybatis_plus_learning;
USE mybatis_plus_learning;

建表：

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

2.2.2 创建工程

按照官网的建议，我们创建一个SpringBoot工程，并添加相关依赖。
以下拿我自己的举例：

SpringBoot版本：

org.springframework.bootspring-boot-starter-parent2.5.9 

相关依赖：

	org.springframework.bootspring-boot-starterorg.springframework.bootspring-boot-starter-testtestcom.baomidoumybatis-plus-boot-starter3.4.2mysqlmysql-connector-javaruntimeorg.projectlomboklombok

application.yml配置：

#数据源
spring:datasource:url: jdbc:mysql://localhost:3306/mybatis_plus_learning?useUnicode=true&characterEncoding=utf-8&serverTimezone=Asia/Shanghaiusername: rootpassword: rootdriver-class-name: com.mysql.cj.jdbc.Driver#配置日志
mybatis-plus:configuration:log-impl: org.apache.ibatis.logging.stdout.StdOutImpl

注意，官网的描述是SpringBoot 2.0+ 、MP 最新版本，我这里选择的是SpringBoot 2.5.x， MP 较新（截至至本文编辑日期）但不是最新版本。
另外，官网提供了h2数据库依赖，我这里选用的是Mysql，读者可根据自身需求参考选用。
另外，由于mybatis-plus为我们省略了很多sql，所以部分sql我们是不可见的，于是我们可以配置日志，通过日志来查看到底执行了什么样的sql语句。

2.2 入门测试

2.2.1 编写实体类

根据官网的教程我们编写实体类;

@Data
public class User implements Serializable {/*** 官方提供User表对对应的属性*/private Long id;private String name;private Integer age;private String email;
}

2.2.2 编写Mapper

@Repository
public interface UserMapper extends BaseMapper {//已经实现了CRUD，此处我们不必编写抽象方法了
}

主启动类添加MapperScan：

@SpringBootApplication
@MapperScan("cn.sharry.mplearning.mapper")
public class MplearningApplication {public static void main(String[] args) {SpringApplication.run(MplearningApplication.class, args);}
}

2.2.3 编写测试类

@Slf4j
@SpringBootTest
public class UserMapperTests {@Autowiredprivate UserMapper userMapper;/*** 入门测试：测试查询用户列表*/@Testpublic void testGetUserList(){log.info("即将进行【Mybatis入门】测试，查询User列表：");//queryWrapper : 条件构造器，当没有时我们用nullList userList = userMapper.selectList(null);//遍历集合userList.forEach(System.out::println);}

如果能正确输出用户列表，那么说明我们的入门配置与测试成功了！接下来我们来详细学习MP给我们带来的便捷的CRUD！

3. CRUD

在上面的小节中，我们进行了初步的入门配置与测试。接下来，我们稍微详细学习一下如何使用 Mybatis-Plus 进行CRUD。

3.1 条件构造器

在开始学习、练习CRUD之前，我们首先要了解一个概念：条件构造器。

在我们没有使用 Mybatis-Plus 时，我们写SQL常常要添加 where 条件判断。条件构造器则是在我们使用Mybatis-Plus，没有怎么手写where条件的情况下，就需要用条件构造器给我们生成一些条件。

在上面的入门案例中，我们使用IDEA测试时，可能会出现如下提示：
[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-TDsgjDaX-1671090850669)(E:\Working-Sida\PersonalNotes\NotesFromLearning\MybatisPlusLearning\images\wrapper-demo1.png)]
这里指的就是一个条件构造器。

通过官网以及参考资料我们了解到，在MP中，AbstractWrapper和AbstractChainWrapper是Wrapper接口的重点实现，因此接下来我们学习的重点为AbstractWrapper以及其⼦类。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-gR9laJux-1671090850671)(E:\Working-Sida\PersonalNotes\NotesFromLearning\MybatisPlusLearning\images\wrapper-demo2.png)]
注：图片来源于参考资料——博客园优质文章

顺便附一张非常实用的图：

注：图片来源于网络，侵删。

3.1.1 AbstractWrapper

本小节列举一些 AbstractWrapper 常用的方法

（1） 基本比较操作

基本比较操作

代码示例
我们通过测试举例来入门 Wrapper 的一些基本实现方式

	/*** 基本比较操作,此处用2个方法举例*/@Testpublic void testBasicCompare(){QueryWrapper queryWrapper = new QueryWrapper<>();//WHERE email in(?,?,?) AND age >= 20queryWrapper.in("email", "test1@baomidou.com","test2@baomidou.com","test3@baomidou.com").ge("age", 20);List userList = userMapper.selectList(queryWrapper);for(User user : userList){System.out.println(user);}

（2） allEq

通过上面小节的学习，我们了解到eq代表“=”，那么 allEq 指的是全部eq（或个别isNull），以下是官网说明：

allEq(Map params)
allEq(Map params, boolean null2IsNull)
allEq(boolean condition, Map params, boolean null2IsNull)

个别参数说明:
params : key为数据库字段名,value为字段值
null2IsNull : 为true则在map的value为null时调用 isNull 方法,为false时则忽略value为null的
例1: allEq({id:1,name:“老王”,age:null})—>id = 1 and name = ‘老王’ and age is null
例2: allEq({id:1,name:“老王”,age:null}, false)—>id = 1 and name = ‘老王’

代码示例

	/*** AllEq Wrapper 测试*/@Testpublic void testAllEq(){QueryWrapper queryWrapper = new QueryWrapper<>();//构建mapMap map = new HashMap<>();map.put("name", "jack");map.put("age", null);//以下展开lambda表达式，方便初学者入门。//queryWrapper.allEq((k,v) -> k.equals("name"),map);BiPredicate filter = new BiPredicate() {@Overridepublic boolean test(String s, Object o){return s.equals("name");}};queryWrapper.allEq(filter,map);List userList = userMapper.selectList(queryWrapper);//遍历查看效果for(User user : userList){System.out.println(user);}}

通过上面的例子，可以看出MP Wrapper 使用 Lambda 会使语句简洁许多，我们在下面的代码示例会逐步引入一些Lambda表达式供各位复习。至于具体Wrapper+Lambda的使用方式，别急，我们在下面的章节讨论。

（3） 模糊查询

MP Wrapper 的模糊查询非常见名知意：

• like —> LIKE ‘%value%’
• not like —> NOT LIKE ‘%value%’
• likeLeft —> （百分号在左边） LIKE ‘%value’
• likeRight —> （百分号在右边） LIKE ‘value%’

代码示例

	/*** 模糊查询*/@Testpublic void testSelectLike(){QueryWrapper queryWrapper = new QueryWrapper<>();//WHERE name LIKE '%?%'queryWrapper.likeLeft("name", "y");List userList = userMapper.selectList(queryWrapper);userList.forEach(System.out::println);}

（4）分组查询、排序

分组查询和排序都是见名知意：groupBy、orderByAsc、orderByDesc;
需要稍微注意一下这几个方法都有哪些参数，官网可查。

上栗子

   /*** 排序*/@Testpublic void testGroupAndOrder(){QueryWrapper queryWrapper = new QueryWrapper<>();queryWrapper.orderByDesc("age");List userList = userMapper.selectList(queryWrapper);userList.forEach(System.out::println);}

分组的例子，篇幅有限，请读者自行尝试。

（5）连接 or and

默认情况下，链式调用的 wrapper 是用and连接，当我们主动调用or时，表示用or连接

	/*** or 拼接*/@Testpublic void testLink(){QueryWrapper queryWrapper = new QueryWrapper<>();queryWrapper.eq("name","jack").or().eq("age",28).select("name");List users = userMapper.selectList(queryWrapper);users.forEach(System.out::println);}

剩余其它方法与例子，请读者自行查阅、尝试。

3.1.2 QueryWrapper

QueryWrapper 实现查询主要使用select 方法，我们直接举例子：

    @Testpublic void testWrappers(){//QueryWrapperQueryWrapper qw = new QueryWrapper<>();//SELECT id, name, age FROM user WHERE name = 'Jack';qw.select("id","name","age").like("name","Jack" );User userJack = userService.getOne(qw);System.out.println("查询到的用户为"+userJack);}

3.1.3 UpdateWrapper

UpdateWrapper 实现更新主要使用set方法，我们直接举例子：

 @Test
public void testWrappers(){      //UpdateWrapperUpdateWrapper uw = new UpdateWrapper<>();uw.set("age",35).like("name","Jack" );//UPDATE user SET age = 35 WHERE name = 'Jack';boolean isSuccess = userService.update(uw);System.out.println("修改Jack的年龄是否成功："+isSuccess);
}

基本的 Wrapper 用法大概如上。至于LambadaWrapper链式调用的方法，我们会在下文介绍。

3.2 Mapper CRUD 接口

我们学习Mapper CRUD接口的目的是了解MP 自带的CRUD 方法有哪些。至于具体调用，由于MP 是为了提高我们的效率而生，实际工作中，我们会通过 IService 调用这些已经写好的方法，而不必再像纯Mybatis的方式去注意CRUD。因此本小节的内容我们了解即可，用到再去查询。下面我们开始学习：

继承了 BaseMapper 的 Mapper 继承了基本的CRUD方法，具体我们可以通过源码以及官方文档了解，BaseMapper源码：

public interface BaseMapper extends Mapper {int insert(T entity);int deleteById(Serializable id);int deleteByMap(@Param("cm") Map columnMap);int delete(@Param("ew") Wrapper queryWrapper);int deleteBatchIds(@Param("coll") Collection idList);int updateById(@Param("et") T entity);int update(@Param("et") T entity, @Param("ew") Wrapper updateWrapper);T selectById(Serializable id);List selectBatchIds(@Param("coll") Collection idList);List selectByMap(@Param("cm") Map columnMap);T selectOne(@Param("ew") Wrapper queryWrapper);Integer selectCount(@Param("ew") Wrapper queryWrapper);List selectList(@Param("ew") Wrapper queryWrapper);List> selectMaps(@Param("ew") Wrapper queryWrapper);List