MyBatis-Plus：告别手写 SQL 的高效之道

目录

1. MyBatis-plus 简介

2. MyBatis-Plus 快速上手

2.1 项目准备

2.2 导入 MyBatis-Plus 依赖

2.3 配置数据库连接

2.4 配置 MyBatis-Plus 日志打印

3. 使用 MyBatis-Plus

3.1 创建 model 类

3.2 创建 mapper 接口

3.3 MyBatis-Plus 映射机制

3.3.1 @TableName & @TableField

3.3.2 @TableId

3.4 CRUD 单元测试

3.4.1 insert

3.4.2 delete

3.4.3 update

3.4.4 select

 4. 条件构造器

4.1 主要的条件构造器

 4.2 构造器常用方法

4.3 QueryWrapper

4.3.1 查询数据

4.3.2 更新数据

4.3.3 删除数据

4.4 UpdateWrapper

4.5 Lambda 形式构造器

4.5.1 LambdaQueryWrapper

4.5.2 LambdaUpdateWrapper

5. 自定义 SQL

 5.1 示例1

5.2 示例2

---

1. MyBatis-plus 简介

基于之前的学习, 我们可以通过 MyBatis-Generator 自动生成 mapper 层代码, 提升了开发效率.

其实还有一种更加简洁的方式, 根本不需要显示的展示 mapper 接口中的方法, 也不需显示的展示出 xml 操的 SQL 映射, 我们直接就可以调用现有的方法来操作数据库, 那就是 MyBatis-Plus.

MyBatis-Plus(简称 MP) 是⼀个 MyBatis 的增强工具, 在 MyBatis 的基础上只做增强不做改变(MyBatis 有的, MyBatis-Plus 也有), 为简化开发, 提高效率而生.
MyBatis-Plus 🚀 为简化开发而生

2. MyBatis-Plus 快速上手

2.1 项目准备

首先, 需要创建一个 Spring 项目, 创建项目阶段我们只需引入这三个依赖:

2.2 导入 MyBatis-Plus 依赖

项目创建完毕后, 需要我们手动在 pom 文件中导入 MyBatis-Plus 依赖:

        <!-- SpringBoot 3.x 版本 --><dependency><groupId>com.baomidou</groupId><artifactId>mybatis-plus-spring-boot3-starter</artifactId><version>3.5.5</version></dependency>

2.3 配置数据库连接

使用 MyBatis-Plus, 当然也需要在 yml 文件中配置数据库连接:

spring:# 配置数据库连接datasource:url: jdbc:mysql://127.0.0.1:3306/mybatis_test?characterEncoding=utf8&useSSL=falseusername: rootpassword: 111111driver-class-name: com.mysql.cj.jdbc.Driver

2.4 配置 MyBatis-Plus 日志打印

为了更方便的观察 SQL 执行结果, 我们也可以像在 MyBatis 时一样, 配置打印 SQL 执行的日志信息:

mybatis-plus:configuration:log-impl: org.apache.ibatis.logging.stdout.StdOutImpl # MyBatis-Plus 日志打印

3. 使用 MyBatis-Plus

完成以上配置相关的工作后, 就可以使用 MyBatis-Plus 了.

3.1 创建 model 类

和使用 MyBatis 一样, 我们需要创建一个 Java 类, 和数据库表中的字段相映射:

3.2 创建 mapper 接口

我们仍需创建 mapper 接口, 但在这个接口中, 我们不需定义任何操作数据库的方法, 更不需使用 XML 或注解来定义 SQL, 只需继承 BaseMapper 接口, BaseMapper 接口中定义了 CRUD 方法, 只要我们的 mapper 接口继承了 BaseMapper, 那我们的 mapper 接口就可以使用其中所有的方法:

3.3 MyBatis-Plus 映射机制

上文提到的 BaseMapper 接口是一个泛型接口, 对泛型占位符传入 Java 类, MyBatis-Plus 就会根据 Java 命名规范和数据库命名规范自动匹配到该类对应的数据库表:

当然, MyBatis-Plus 也会根据命名规范, 自动将 Java 属性和数据库表字段相映射(不用像 MyBatis 那样在配置文件中手动设置驼峰转换了).

MyBatis-plus 的自动映射规则如下:

1. 表名: Java 类的大驼峰表示法转换为蛇形表示法(下划线分割). UserInfo ==> user_info
2. 字段名: Java 属性的小驼峰表示法转换为蛇形表示法(下划线分割). deleteFlag => delete_flag
3. 主键: 默认将 Java 类中, 名称为 "id" 的属性, 映射为表中的主键字段

综上, MyBatis-Plus 继承并扩展了 MyBatis, 并提供了一系列增强功能, 包括默认开启的驼峰命名转换和自动匹配数据库表.

3.3.1 @TableName & @TableField

虽然 MyBatis-Plus 会根据 Java 和 数据库的命名规范自动进行类和表以及属性和字段之间的映射, 但是, 规范毕竟只是规范, 再加上程序员的水平参差不齐, 甚至有的都不知道 MyBatis-Plus 这些自动映射的功能, 因此, MyBatis-Plus 也提供了手动指定映射的方式.

使用 @TableName 手动指定该类映射的数据库表, 使用 @TableField 手动指定该属性映射的数据库表字段:

其实, 显式声明胜于隐式推断, 我们在开发中最好也显式声明映射关系, 消除框架猜测的需要, 减少意外行为的可能性.

3.3.2 @TableId

上文说到, MyBatis-plus 会默认将 Java 类中, 名称为 "id" 的属性, 映射为表中的主键字段.

如图所示, 我们调用 BaseMapper 中的 selectById 方法, MyBatis-plus 会默认将类中的 id 属性映射到表中的主键字段, 进行查找:
(但是, 属性名和字段名必须按照规范命名(或者两者名称完全一致), MyBatis-plus 才能推断出映射关系)

但是, 如果我们将属性名和主键字段名都修改为 "user_id", 即使两者的名称仍然是相匹配的, 但是由于 Java 属性的名称不是 "id", MyBatis-plus 也不会将其和表中的主键映射, 报错:

此时, 我们就需要使用 @TableId 注解来显式指定哪个属性是对应数据库表的主键:

此外, 如上图所示. @TableId 还可以将主键属性的值设置为自增类型, 这样在插入数据时, 我们就无需手动设置主键属性(如 userId) 的值, MyBatis-plus 会自动将主键属性的值设置为表中主键自增后的值.

3.4 CRUD 单元测试

3.4.1 insert

由于 mapper 接口继承了 BaseMapper 接口, 因此我们直接调用 BaseMapper 中的 insert 方法进行数据插入即可:

但是, 我们发现了一个问题, 新插入记录的 id 列是一个很大的数值, 并非从 1 开始自增.(id 为主键, 应该是自增的)

这是因为 MyBatis-Plus 只知道 id 字段是主键, 但并不知道 id 也是 auto_increment 自增的.

要解决这个问题, 我们需要使用 @TableId 指定主键, 并设置自增类型:

因为我们现在表中的数据最大的 id 是 24, 因此新插入数据时, id 是从 24 开始往后自增的.

如果想要 id 从 1 开始自增, 那么就需要删除表中 id 比 1 大的记录, 并设置主键进行自增的起始值:

3.4.2 delete

删除记录, 同样直接调用 BaseMapper 提供的方法:

3.4.3 update

更新记录, 同样直接调用 BaseMapper 提供的方法:

3.4.4 select

查询操作, 同样直接调用 BaseMapper 提供的方法:

 4. 条件构造器

4.1 主要的条件构造器

上文带大家简单了解了一下 MyBatis-plus 的简单 CRUD 操作, 但是在实际开发中, 我们会用到更复杂的操作, 因此 MyBatis-plus 也为我们提供了支持 --- wrapper 条件构造器.

条件构造器的核心职责就是构建 SELECT, UPDATE 和 DELETE 语句中的 WHERE 条件.(构造查询/条件)

注意: 条件构造器只能用于构造查询条件, 不能构造整个 sql 语句.

主要的条件构造器如下:

1. AbstractWrapper：这是一个抽象基类，提供了所有 Wrapper 类共有的方法和属性(所有的 wrapper 类都继承于它)。它定义了条件构造的基本逻辑，包括字段（column）、值（value）、操作符（condition）等。所有的 QueryWrapper、UpdateWrapper、LambdaQueryWrapper 和 LambdaUpdateWrapper 都继承自 AbstractWrapper。

2. QueryWrapper：专门用于构造查询条件，支持基本的等于、不等于、大于、小于等各种常见操作。它允许你以链式调用的方式添加多个查询条件，并且可以组合使用 and 和 or 逻辑。

3. UpdateWrapper：用于构造更新条件，可以在更新数据时指定条件。与 QueryWrapper 类似，它也支持链式调用和逻辑组合。使用 UpdateWrapper 可以在不创建实体对象的情况下，直接设置更新字段和条件。

4. LambdaQueryWrapper：这是一个基于 Lambda 表达式的查询条件构造器，它通过 Lambda 表达式来引用实体类的属性，从而避免了硬编码字段名。这种方式提高了代码的可读性和可维护性，尤其是在字段名可能发生变化的情况下。

5. LambdaUpdateWrapper：类似于 LambdaQueryWrapper，LambdaUpdateWrapper 是基于 Lambda 表达式的更新条件构造器。它允许你使用 Lambda 表达式来指定更新字段和条件，同样避免了硬编码字段名的问题。

以上条件构造器(如 QueryWrapper<T>, LambdaQueryWrapper<T>, UpdateWrapper<T>, LambdaUpdateWrapper<T>, DeleteWrapper<T>, LambdaDeleteWrapper<T>)都是泛型类, MyBatis-Plus 通过传入的泛型 T 来推断出我们要操作的数据库表.

官方文档: 条件构造器 | MyBatis-Plus 

 4.2 构造器常用方法

以下方法支持链式调用.

4.3 QueryWrapper

QueryWrapper 并不只用于查询语句, 无论是修改, 删除, 查询, 都可以使用 QueryWrapper 来构建查询条件.

注意: 使用 QueryWrapper 的方法时(如 select(), lt(), gt(), eq() 等), 传入字符串应是数据库表中的字段名, 而不是 Java 属性名.

4.3.1 查询数据

QueryWrapper 除了可以使用其父类 AbstractWrapper 提供的方法构造查询条件外, QueryWrapper 还额外实现了 select 方法, 可以手动指定要查询的列.

因此, QueryWrapper 不仅用来构造 select 操作的查询条件 (WHERE 子句), 它还用于指定 select 操作中需要查询的列.

sql 查询语句:

SELECT id, username, password, age FROM user_info WHERE (age = 15 AND username LIKE "%min%");

构造器实现:

    @Testvoid selectByQueryWrapper() {// SELECT id, username, password, age FROM user_info WHERE (age = 15 AND username LIKE "%min%")QueryWrapper<UserInfo> wrapper = new QueryWrapper<>();wrapper.select("id, username, password, age").eq("age", 15).like("username", "min");userInfoMapper.selectList(wrapper).forEach(System.out::println);}

4.3.2 更新数据

更新数据, 有以下三种方式:

1. 根据 UpdateWrapper 构造器进行更新
2. 根据实体类和 QueryWrapper 构造器进行更新
3. 根据实体类进行更新

 第三种上文已经演示, 第一种下文讲, 这里演示第二种, 数据 QueryWrapper 进行更新.

使用 QueryWrapper 来更新数据, 需要结合实体类使用.

其中, QueryWrapper 用来构造查询条件, 实体类用来构造要更新的内容:

sql 更新语句:

UPDATE user_info SET delete_flag= 1 WHERE (age < 20)

QueryWrapper 实现:

4.3.3 删除数据

 sql 删除语句:

DELETE FROM user_info WHERE (age = 5)

QueryWrapper 实现:

    @Testvoid deleteByQueryWrapper() {// DELETE FROM user_info WHERE (age = 5)QueryWrapper<UserInfo> wrapper = new QueryWrapper<>();wrapper.eq("age", 5);userInfoMapper.delete(wrapper);}

4.4 UpdateWrapper

UpdateWrapper 除了可以使用父类 AbstractWrapper 提供的方法构造查询条件(where 子句)外, 其还额外实现了如下方法:

1. set 方法: 可以指定 UPDATE 操作中要更新的内容(SET 子句). 
2. setSql 方法: 可以直接设置 SET 子句的 SQL 片段. (可以执行更复杂的更新操作)

与 QueryWrapper 类似, UpdateWrapper 在使用 set(), eq(), lt() 等方法时, 传入的是数据库表中的字段名.

UpdateWrapper 是专门用于 UPDATE 操作的.

上文说到, MyBatis-plus 提供的 update 操作有三种方式:

1. 根据 UpdateWrapper 构造器进行更新
2. 根据实体类和 QueryWrapper 构造器进行更新
3. 根据实体类进行更新

上文已经演示了第 2, 3 种, 这里就使用 UpdateWrapper 演示第一种.

示例 1: UpdateWrapper 使用 set 方法构造更新内容

Sql 更新语句:

UPDATE user_info SET delete_flag= 0 WHERE (age < 20)

构造器实现:

    @Testvoid updateByUpdateWrapper() {// UPDATE user_info SET delete_flag= 0 WHERE (age < 20)UpdateWrapper<UserInfo> wrapper = new UpdateWrapper<>();wrapper.set("delete_flag", 0).lt("age", 20);userInfoMapper.update(wrapper);}

示例二: UpdateWrapper 使用 setSql 构造更新内容

sql 更新语句:

UPDATE user_info SET age = age + 10 WHERE (id IN (2,3,4))

构造器实现:

    @Testvoid updateByUpdateWrapper3() {// 使用 SQL 进行更新// UPDATE user_info SET age = age + 10 WHERE (id IN (2,3,4))UpdateWrapper<UserInfo> wrapper = new UpdateWrapper<>();wrapper.setSql("age = age + 10").in("id", List.of(2, 3, 4));userInfoMapper.update(wrapper);}

示例三: 使用 in 方法构造查询条件

UPDATE user_info SET delete_flag=1,age=5 WHERE (id IN (2,3,4))

构造器实现:

    @Testvoid updateByUpdateWrapper2() {// UPDATE user_info SET delete_flag=1,age=5 WHERE (id IN (2,3,4))UpdateWrapper<UserInfo> wrapper = new UpdateWrapper<>();wrapper.set("delete_flag", 1).set("age", 5).in("id", List.of(2, 3, 4));
//                .in("id", Arrays.asList(1, 2, 3));userInfoMapper.update(wrapper);}

4.5 Lambda 形式构造器

使用 QueryWrapper 和 UpdateWrapper 构造查询条件时, 我们使用 eq, set, select, lt 等方法传入表字段名时, 传入的是字符串, 当真实的字段名称发生改变时, 我们就需要手动修改传入的字符串参数, 易发生错误, 因此存在硬编码问题.

使用 Lambda 形式的构造器就可以避免这个错误:

1. LambdaQueryWrapper
2. LambdaUpdateWrapper

Lambda 构造器, 传入参数时, 不再是字符串, 而是使用 Lambda 表达式来提取出类的属性名.

形如: UserInfo::getId, 该 Lambda 表达式等价于: (UserInfo user) -> user.getId();

含义为: 接受一个 UserInfo 对象, 返回其 id 属性的名称.

因此:

1. Lambda 构造器: 使用方法引用 (::) 引用 Java 实体类的 Getter 方法, MyBatis-Plus 内部会提取属性名, 进而推断出对应的表字段.

2. 普通构造器: 直接在方法参数中传入数据库表的字段名(字符串形式).

4.5.1 LambdaQueryWrapper

sql 查询语句:

SELECT id, username, password, age FROM user_info WHERE (age = 15 AND username LIKE "%min%")

 LambdaQueryWrapper 构造器实现:

    @Testvoid selectByLambda() {// SELECT id, username, password, age FROM user_info WHERE (age = 15 AND username LIKE "%min%")LambdaQueryWrapper<UserInfo> wrapper = new LambdaQueryWrapper<>();wrapper.select(UserInfo::getId, UserInfo::getUsername,UserInfo::getPassword, UserInfo::getAge).eq(UserInfo::getAge, 5).like(UserInfo::getUsername, "min");userInfoMapper.selectList(wrapper).forEach(System.out::println);

4.5.2 LambdaUpdateWrapper

示例一:

sql 更新语句:

UPDATE user_info SET age = age + 10 WHERE (id IN (2,3,4))

 LambdaUpdateWrapper 构造器实现:

    @Testvoid updateByLambda2() {// 使用 SQL 进行更新// UPDATE user_info SET age = age + 10 WHERE (id IN (2,3,4))LambdaUpdateWrapper<UserInfo> wrapper = new LambdaUpdateWrapper<>();wrapper.setSql("age = age + 10").in(UserInfo::getId, List.of(2, 3, 4));userInfoMapper.update(wrapper);}

 示例二:

sql 更新语句:

UPDATE user_info SET delete_flag=1,age=5 WHERE (id IN (2,3,4))

LambdaUpdateWrapper  构造器实现:

    @Testvoid updateByLambda() {// UPDATE user_info SET delete_flag=1,age=5 WHERE (id IN (2,3,4))LambdaUpdateWrapper<UserInfo> wrapper = new LambdaUpdateWrapper<>();wrapper.set(UserInfo::getDeleteflag, 1).set(UserInfo::getAge, 5).in(UserInfo::getId, List.of(2, 3, 4));userInfoMapper.update(wrapper);}

5. 自定义 SQL

虽然 MyBatis-Plus 提供的构造器十分强大, 但工作中难免会遇见一些构造器实现不了 SQL, 因此 MyBatis-Plus 也提供了自定义 SQL 功能, 即结合 Wrapper(构造 where 查询条件)和 注解/xml 编写更复杂的 SQL.

上文说到, MyBatis-Plus 在 MyBatis 的基础上, 只做增强, 不做改变, 因此 MyBatis 的注解和 xml 功能, 在 MyBatis-Plus 上依旧可以使用. 并且在 MyBatis-plus 上使用注解和 xml 的方式与 MyBatis 完全一致.

唯一不同的是, MyBatis-plus 使用 xml 时, 配置文件需要稍作改变:

mybatis-plus:mapper-locations: "classpath*:/mapper/**.xml" # Mapper.xml

以下是使用自定义 SQL 的几个注意事项:

1. 参数命名: 在自定义 SQL 时, 传递 Wrapper 对象作为参数时, 必须使用注解@Param(Constants.WRAPPER) 将 Wrapper 对象重命名为 ew.(即使参数名本来就是 ew, 也需要添加 @Param)
2. 使用 ${ew.customSqlSegment}: 在 SQL 语句中, 使用 ${ew.customSqlSegment} 来引用Wrapper 对象生成的 SQL 片段.
3. 需要在 注解/xml 中, 手动编写完整的 SQL 语句, 手动引入 Wrapper 对象或其他自定义参数.
4. 使用 MyBatis-plus 提供的自定义 sql 功能, Mybatis-plus 版本需不低于3.0.7

 5.1 示例1

SQL 语句:

select * from user_info WHERE (age = ?)

使用 Wrapper + 注解, 自定义 sql:

5.2 示例2

sql 语句:

update user_info set age = age + 1 WHERE (id IN (2,3,4))

 使用 Wrapper + 注解, 自定义 sql:

上述示例使用的是注解来自定义 sql 的, 使用 xml 也可以, 并且格式和注解一样.

---

END