MyBatisPlus详解(二)条件构造器Wrapper、自定义SQL、Service接口

2024-04-22 09:20
文章标签 sql 接口 条件 自定义 详解 构造 mybatisplus service database wrapper

本文主要是介绍MyBatisPlus详解(二)条件构造器Wrapper、自定义SQL、Service接口，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

文章目录

  • 前言
  • 2 核心功能
    • 2.1 条件构造器
      • 2.1.1 Wrapper
      • 2.1.2 QueryWrapper
      • 2.1.3 UpdateWrapper
      • 2.1.4 LambdaQueryWrapper
    • 2.2 自定义SQL
      • 2.2.1 基本用法
      • 2.2.2 多表关联
    • 2.3 Service接口
      • 2.3.1 IService
        • 2.3.1.1 save
        • 2.3.1.2 remove
        • 2.3.1.3 update
        • 2.3.1.4 get
        • 2.3.1.5 list
        • 2.3.1.6 count
        • 2.3.1.7 page
      • 2.3.2 基本用法

前言

MyBatisPlus详解系列文章：

MyBatisPlus详解(一)项目搭建、@TableName、@TableId、@TableField注解与常见配置

2 核心功能

2.1 条件构造器

2.1.1 Wrapper

在BaseMapper接口提供的相关方法中，除了以id作为where条件，还支持更加复杂的where条件，即条件构造器Wrapper：

Wrapper是条件构造器的抽象类，其下有很多默认实现，继承关系如图：

Wrapper的子类AbstractWrapper提供了where中包含的所有条件构造方法：

而QueryWrapper在AbstractWrapper的基础上拓展了一个select方法，允许指定查询字段：

而UpdateWrapper在AbstractWrapper的基础上拓展了一个set方法，允许指定SQL中的SET部分：

2.1.2 QueryWrapper

使用QueryWrapper构建查询条件，例如：

  • select id, username, info, balance from t_user where id = 3 and username like '%o%' and balance >= 1000
@Test
public void testQueryWrapper() {// select id, username, info, balance from t_user// where id = 3 and username like '%o%' and balance >= 1000QueryWrapper<User> wrapper = new QueryWrapper<User>()// 设置需要查询的字段.select("id", "username", "info", "balance")// id = 3.eq("id", 3)// like '%o%'.like("username", "o")// balance >= 1000.ge("balance", 1000);List<User> userList = userMapper.selectList(wrapper);userList.forEach(System.out::println);
}

执行以上单元测试结果如下：

==>  Preparing: SELECT id,username,info,balance FROM t_user WHERE (id = ? AND username LIKE ? AND balance >= ?)
==> Parameters: 3(Integer), %o%(String), 1000(Integer)
<==      Total: 1
User(id=3, username=Hope, password=null, phone=null, info={"age": 25, "intro": "上进青年", "gender": "male"}, status=null, balance=20000, createTime=null, updateTime=null)
  • update t_user set balance = 2000 where username = 'Jack'
@Test
void testUpdateByQueryWrapper() {// update t_user set balance = 2000 where username = 'Jack'QueryWrapper<User> wrapper = new QueryWrapper<User>()// username = 'Jack'.eq("username", "Jack");// 2.更新数据User user = new User();user.setBalance(2000);userMapper.update(user, wrapper);
}

执行以上单元测试结果如下：

==>  Preparing: UPDATE t_user SET balance=? WHERE (username = ?)
==> Parameters: 2000(Integer), Jack(String)
<==    Updates: 0

2.1.3 UpdateWrapper

如上面的单元测试testUpdateByQueryWrapper()所示，update()方法更新时只能直接赋值，对于一些复杂的需求就难以实现，例如：

UPDATE t_user SET balance = balance - 200 WHERE id in (1, 2, 4);

SET语句的赋值结果是基于字段现有值的，这个时候就要利用UpdateWrapper中的setSql()方法了：

@Test
void testUpdateWrapper() {List<Long> ids = Arrays.asList(1L, 2L, 4L);// 1.生成SQLUpdateWrapper<User> wrapper = new UpdateWrapper<User>()// SET balance = balance - 200.setSql("balance = balance - 200")// WHERE id in (1, 2, 4).in("id", ids);// 2.更新// 注意第一个参数为null，则会基于UpdateWrapper中的setSQL来更新userMapper.update(null, wrapper);
}

执行以上单元测试结果如下：

==>  Preparing: UPDATE t_user SET balance = balance - 200 WHERE (id IN (?,?,?))
==> Parameters: 1(Long), 2(Long), 4(Long)
<==    Updates: 2

2.1.4 LambdaQueryWrapper

无论是QueryWrapper还是UpdateWrapper，在构造条件的时候都需要写死字段名称，会出现字符串魔法值。这在编程规范中显然是不推荐的。

而要不写字段名，又能知道字段名，其中一种办法是基于变量的gettter方法结合反射技术。为此，MybatisPlus又提供了一套基于Lambda的Wrapper，包含两个：LambdaQueryWrapper和LambdaUpdateWrapper。

@Test
public void testLambdaQueryWrapper() {// select id, username, info, balance from t_user// where id = 3 and username like '%o%' and balance >= 1000LambdaQueryWrapper<User> wrapper = new LambdaQueryWrapper<User>()// 设置需要查询的字段.select(User::getId, User::getUsername, User::getInfo, User::getBalance)// id = 3.eq(User::getId, 3)// username like '%o%'.like(User::getUsername, "o")// balance >= 1000.ge(User::getBalance, 1000);List<User> userList = userMapper.selectList(wrapper);userList.forEach(System.out::println);
}

执行该单元测试，可以得到和上面的testQueryWrapper()一样的结果，但这种写法不需要将字段名写死。未来如果需要修改字段名，也不需要这里的逻辑代码。

2.2 自定义SQL

在单元测试testUpdateWrapper()，编写了这样一行代码：.setSql("balance = balance - 200")，这种写法其实也是不好的，因为SQL语句最好都维护在持久层，而不是业务层。

为此，MyBatis提供了自定义SQL功能，即利用Wrapper构建复杂的where条件，然后自己定义SQL语句剩余的部分。

也就是说，UPDATE t_user SET balance = balance - 200自己定义，WHERE id in (1, 2, 4)利用Wrapper构建。

2.2.1 基本用法

例如单元测试testUpdateWrapper()可以这样修改：

@Test
public void testUpdateWrapper2() {List<Long> ids = Arrays.asList(1L, 2L, 4L);// 1.生成SQLUpdateWrapper<User> wrapper = new UpdateWrapper<User>()// SET balance = balance - 200// .setSql("balance = balance - 200")// WHERE id in (1, 2, 4).in("id", ids);// 2.更新// userMapper.update(null, wrapper);// 改为调用自定义的Mapper方法，直接传递WrapperuserMapper.deductBalanceByIds(200, wrapper);
}

然后在UserMapper中定义deductBalanceByIds()方法：

// com.star.learning.mapper.UserMapper@Update("UPDATE t_user SET balance = balance - #{money} ${uw.customSqlSegment}")
void deductBalanceByIds(@Param("money") int money, @Param("uw") UpdateWrapper<User> wrapper);

执行修改后的单元测试，执行结果和原来的是一样的。

2.2.2 多表关联

理论上来讲MyBatisPlus是不支持多表查询的，不过仍然可以利用Wrapper构建复杂where条件结合自定义SQL来实现多表查询的效果。

例如，要查询出所有收货地址在北京并且用户id在1、2、4之中的用户，其SQL语句为：

SELECT * FROM t_user u
INNER JOIN t_address a ON a.user_id = u.id
WHERE u.id IN (1,2,4)
AND a.city = '北京'

编写单元测试，利用Wrapper构建复杂where条件，并调用自定义的Mapper方法：

@Test
public void testMultiTableQuery() {List<Long> ids = Arrays.asList(1L, 2L, 4L);// 1.利用Wrapper构建复杂where条件QueryWrapper<User> wrapper = new QueryWrapper<User>().in("u.id", ids).eq("a.city", "北京");// 2.调用自定义的Mapper方法User user = userMapper.queryUserByIdAndCity(wrapper);System.out.println(user);
}

// com.star.learning.mapper.UserMapper@Select("SELECT * FROM t_user u INNER JOIN t_address a ON a.user_id = u.id ${ew.customSqlSegment}")
User queryUserByIdAndCity(@Param("ew") QueryWrapper<User> wrapper);

执行以上单元测试，结果如下：

==>  Preparing: SELECT * FROM t_user u INNER JOIN t_address a ON a.user_id = u.id WHERE (u.id IN (?,?,?) AND a.city = ?)
==> Parameters: 1(Long), 2(Long), 4(Long), 北京(String)
<==      Total: 1
User(id=2, username=Rose, password=123, phone=13900112223, info={"age": 19, "intro": "青涩少女", "gender": "female"}, status=1, balance=200, createTime=2024-04-21T10:13:35, updateTime=2024-04-21T16:10:20)

2.3 Service接口

MybatisPlus不仅提供了BaseMapper接口，还提供了通用的Service接口及默认实现ServiceImpl，封装了一些常用的service模板方法。

2.3.1 IService

2.3.1.1 save

  • save：插入一条记录
  • saveBatch：批量插入多条记录
  • saveOrUpdate：记录存在则更新记录，否则插入一条新记录
  • saveOrUpdateBatch：记录存在则批量修改，否则批量插入
2.3.1.2 remove

  • remove：根据条件删除
  • removeById：根据ID删除
  • removeByIds：根据ID批量删除
  • removeByMap：根据Map中的键值对为条件删除
  • removeBatchByIds：批量删除(jdbc批量提交)
2.3.1.3 update

  • update(Wrapper<T>)：根据UpdateWrapper修改，Wrapper中包含set和where部分
  • update(T，Wrapper<T>)：按照T内的数据修改与Wrapper匹配到的数据
  • updateById：根据id修改
  • updateBatchById：根据id批量修改
2.3.1.4 get

  • getById：根据id查询
  • getOne(Wrapper<T>)：根据Wrapper查询1条记录
  • getBaseMapper：获取对应实体的BaseMapper
  • getMap(Wrapper<T>)：根据Wrapper查询1条记录，封装为Map
2.3.1.5 list

  • list()：查询所有
  • list(Wrapper<T>)：根据Wrapper条件查询列表
  • listByIds()：根据ID集合查询列表
2.3.1.6 count

  • count()：查询总记录数
  • count(Wrapper<T>)：根据Wrapper条件查询总记录数
2.3.1.7 page

  • page(IPage)：无条件翻页查询
  • page(IPage, Wrapper<T>)：根据Wrapper条件翻页查询

2.3.2 基本用法

创建一个IUserService接口，继承IService接口以拓展方法；同时，自定义UserServiceImpl实现类，继承ServiceImpl实现类，并实现IUserService接口。

// com.star.learning.service.IUserServicepublic interface IUserService extends IService<User> {
}

// com.star.learning.service.impl.UserServiceImpl@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {
}

这样配置之后，导入IUserService接口，即可以使用IService接口中定义的各种方法。

接下来，实现下面这个接口：

接口请求方式请求路径请求参数返回值
新增用户POST/user/addUser无

首先，导入相关依赖：

<dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-starter-web</artifactId>
</dependency>

然后创建一个UserController类，并编写一个addUser()方法：

// com.star.learning.controller.UserController@RestController
@RequestMapping("/user")
public class UserController {@Autowiredprivate IUserService userService;@PostMapping("/add")public void addUser(@RequestBody User user) {boolean save = userService.save(user);System.out.println("新增用户结果 => " + save);}
}

最后进行功能测试，调用/user/add接口，查看控制台打印信息：

==>  Preparing: INSERT INTO t_user ( username, password, phone, info, balance ) VALUES ( ?, ?, ?, ?, ? )
==> Parameters: Jim(String), 123456(String), 999(String), {"age": 20, "intro": "佛系青年", "gender": "male"}(String), 500(Integer)
<==    Updates: 1
新增用户结果 => true

接下来再来实现3个接口：

接口请求方式请求路径请求参数返回值
根据id查询用户GET/user/{id}idUser
根据id集合批量查询用户GET/user/{id}idList<User>
删除用户DELETE/user/{id}id无

其代码如下：

// com.star.learning.controller.UserController@GetMapping("/{id}")
public User getById(@PathVariable("id") Long userId) {User user = userService.getById(userId);System.out.println("根据id查询用户 => " + user);return user;
}@GetMapping
public List<User> queryUserByIds(@RequestParam("ids") List<Long> ids){List<User> users = userService.listByIds(ids);System.out.println("根据id集合查询用户列表 => " + users);return users;
}@DeleteMapping("/{id}")
public void removeUserById(@PathVariable("id") Long userId){boolean remove = userService.removeById(userId);System.out.println("根据id删除用户 => " + remove);
}

调用这3个接口，查看控制台打印信息：

// 根据id查询用户
==>  Preparing: SELECT id,username,password,phone,info,status,balance,create_time,update_time FROM t_user WHERE id=?
==> Parameters: 2(Long)
<==      Total: 1
根据id查询用户 => User(id=2, username=Rose, password=123, phone=13900112223, info={"age": 19, "intro": "青涩少女", "gender": "female"}, status=1, balance=200, createTime=2024-04-21T10:13:35, updateTime=2024-04-21T16:10:20)// 根据id集合批量查询用户
==>  Preparing: SELECT id,username,password,phone,info,status,balance,create_time,update_time FROM t_user WHERE id IN ( ? , ? , ? )
==> Parameters: 1(Long), 2(Long), 3(Long)
<==      Total: 2
根据id集合查询用户列表 => [User(id=2, username=Rose, password=123, phone=13900112223, info={"age": 19, "intro": "青涩少女", "gender": "female"}, status=1, balance=200, createTime=2024-04-21T10:13:35, updateTime=2024-04-21T16:10:20), User(id=3, username=Hope, password=123, phone=13900112222, info={"age": 25, "intro": "上进青年", "gender": "male"}, status=1, balance=20000, createTime=2024-04-21T10:13:35, updateTime=2024-04-21T11:12:48)]// 根据id删除用户
==>  Preparing: DELETE FROM t_user WHERE id=?
==> Parameters: 2(Long)
<==    Updates: 1
根据id删除用户 => true

可以看到，上述4个接口都直接在Controller类中即可实现，无需编写任何Service代码，非常方便。

不过，一些带有业务逻辑的接口则需要在Service中自定义实现了。例如下面这个接口：

接口请求方式请求路径请求参数返回值
根据id扣减用户余额PUT{id}/deduction/{money}id,money无
// com.star.learning.controller.UserController@PutMapping("{id}/deduction/{money}")
public void deductBalance(@PathVariable("id") Long id, @PathVariable("money")Integer money){System.out.println("扣减id=" + id + "的用户的余额" + money);userService.deductBalance(id, money);
}

// com.star.learning.service.IUserServicepublic interface IUserService extends IService<User> {void deductBalance(Long userId, Integer money);
}

// com.star.learning.service.impl.UserServiceImpl@Service
public class UserServiceImpl extends ServiceImpl<UserMapper, User> implements IUserService {@Autowiredprivate UserMapper userMapper;@Overridepublic void deductBalance(Long userId, Integer money) {// 1.查询用户User user = getById(userId);System.out.println(user);// 2.判断用户状态if (user == null || user.getStatus() == 2) {throw new RuntimeException("用户状态异常");}// 3.判断用户余额if (user.getBalance() < money) {throw new RuntimeException("用户余额不足");}// 4.扣减余额// 2.2节自定义SQL创建了deductBalanceByIds方法可以直接使用UpdateWrapper<User> wrapper = new UpdateWrapper<User>().eq("id", userId);userMapper.deductBalanceByIds(money, wrapper);}
}

调用/user/3/deduction/200接口，查看控制台打印信息：

扣减id=3的用户的余额200
==>  Preparing: SELECT id,username,password,phone,info,status,balance,create_time,update_time FROM t_user WHERE id=?
==> Parameters: 3(Long)
<==      Total: 1
User(id=3, username=Hope, password=123, phone=13900112222, info={"age": 25, "intro": "上进青年", "gender": "male"}, status=1, balance=20000, createTime=2024-04-21T10:13:35, updateTime=2024-04-21T11:12:48)
==>  Preparing: UPDATE t_user SET balance = balance - ? WHERE (id = ?)
==> Parameters: 200(Integer), 3(Long)
<==    Updates: 1

…

本节完，更多内容请查阅分类专栏：MyBatisPlus详解

感兴趣的读者还可以查阅我的另外几个专栏：

  • SpringBoot源码解读与原理分析(已完结)
  • MyBatis3源码深度解析(已完结)
  • Redis从入门到精通(已完结)
  • 再探Java为面试赋能(持续更新中…)

这篇关于MyBatisPlus详解(二)条件构造器Wrapper、自定义SQL、Service接口的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/925392。

相关文章

Mysql 中的多表连接和连接类型详解

Mysql 中的多表连接和连接类型详解

《Mysql中的多表连接和连接类型详解》这篇文章详细介绍了MySQL中的多表连接及其各种类型,包括内连接、左连接、右连接、全外连接、自连接和交叉连接,通过这些连接方式,可以将分散在不同表中的相关数据... 目录什么是多表连接？1. 内连接（INNER JOIN）2. 左连接（LEFT JOIN 或 LEFT
阅读更多...
Java中switch-case结构的使用方法举例详解

Java中switch-case结构的使用方法举例详解

《Java中switch-case结构的使用方法举例详解》：本文主要介绍Java中switch-case结构使用的相关资料,switch-case结构是Java中处理多个分支条件的一种有效方式,它... 目录前言一、switch-case结构的基本语法二、使用示例三、注意事项四、总结前言对于Java初学者
阅读更多...
Linux内核之内核裁剪详解

Linux内核之内核裁剪详解

《Linux内核之内核裁剪详解》Linux内核裁剪是通过移除不必要的功能和模块,调整配置参数来优化内核,以满足特定需求,裁剪的方法包括使用配置选项、模块化设计和优化配置参数,图形裁剪工具如makeme... 目录简介一、 裁剪的原因二、裁剪的方法三、图形裁剪工具四、操作说明五、make menuconfig
阅读更多...
Oracle Expdp按条件导出指定表数据的方法实例

Oracle Expdp按条件导出指定表数据的方法实例

《OracleExpdp按条件导出指定表数据的方法实例》：本文主要介绍Oracle的expdp数据泵方式导出特定机构和时间范围的数据,并通过parfile文件进行条件限制和配置,文中通过代码介绍... 目录1.场景描述 2.方案分析3.实验验证 3.1 parfile文件3.2 expdp命令导出4.总结
阅读更多...
详解Java中的敏感信息处理

详解Java中的敏感信息处理

《详解Java中的敏感信息处理》平时开发中常常会遇到像用户的手机号、姓名、身份证等敏感信息需要处理,这篇文章主要为大家整理了一些常用的方法,希望对大家有所帮助... 目录前后端传输AES 对称加密RSA 非对称加密混合加密数据库加密MD5 + Salt/SHA + SaltAES 加密平时开发中遇到像用户的
阅读更多...
mysql重置root密码的完整步骤(适用于5.7和8.0)

mysql重置root密码的完整步骤(适用于5.7和8.0)

《mysql重置root密码的完整步骤(适用于5.7和8.0)》：本文主要介绍mysql重置root密码的完整步骤,文中描述了如何停止MySQL服务、以管理员身份打开命令行、替换配置文件路径、修改... 目录第一步：先停止mysql服务，一定要停止！方式一：通过命令行关闭mysql服务方式二：通过服务项关闭
阅读更多...
Springboot使用RabbitMQ实现关闭超时订单(示例详解)

Springboot使用RabbitMQ实现关闭超时订单(示例详解)

《Springboot使用RabbitMQ实现关闭超时订单(示例详解)》介绍了如何在SpringBoot项目中使用RabbitMQ实现订单的延时处理和超时关闭,通过配置RabbitMQ的交换机、队列和... 目录1.maven中引入rabbitmq的依赖：2.application.yml中进行rabbit
阅读更多...
C语言线程池的常见实现方式详解

C语言线程池的常见实现方式详解

《C语言线程池的常见实现方式详解》本文介绍了如何使用C语言实现一个基本的线程池,线程池的实现包括工作线程、任务队列、任务调度、线程池的初始化、任务添加、销毁等步骤,感兴趣的朋友跟随小编一起看看吧... 目录1. 线程池的基本结构2. 线程池的实现步骤3. 线程池的核心数据结构4. 线程池的详细实现4.1 初
阅读更多...
SQL Server数据库磁盘满了的解决办法

SQL Server数据库磁盘满了的解决办法

《SQLServer数据库磁盘满了的解决办法》系统再正常运行,我还在操作中,突然发现接口报错,后续所有接口都报错了,一查日志发现说是数据库磁盘满了,所以本文记录了SQLServer数据库磁盘满了的解... 目录问题解决方法删除数据库日志设置数据库日志大小问题今http://www.chinasem.cn天发
阅读更多...
Python绘制土地利用和土地覆盖类型图示例详解

Python绘制土地利用和土地覆盖类型图示例详解

《Python绘制土地利用和土地覆盖类型图示例详解》本文介绍了如何使用Python绘制土地利用和土地覆盖类型图,并提供了详细的代码示例,通过安装所需的库,准备地理数据,使用geopandas和matp... 目录一、所需库的安装二、数据准备三、绘制土地利用和土地覆盖类型图四、代码解释五、其他可视化形式1.
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2