Mybatis-plus动态条件查询QueryWrapper的函数用法

2023-12-22 16:28

本文主要是介绍Mybatis-plus动态条件查询QueryWrapper的函数用法,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

目录

  • 前言
  • 1. QueryWrapper
  • 2. 函数
  • 3. Demo

前言

原本都是在Mapper文件中修改,直到看到项目中使用了QueryWrapper这个函数,大致了解了用法以及功能,发现还可以!

对此此贴为科普帖以及笔记帖

1. QueryWrapper

MyBatis-Plus 是 MyBatis 的增强工具包,它简化了 MyBatis 的开发流程,提供了一些常用功能的增强和简化方法。其中,QueryWrapper 是 MyBatis-Plus 中用于构建动态条件查询的一个重要类。QueryWrapper 可以用于构建 SQL 的 WHERE 子句,动态地拼接条件,以实现灵活的查询。

查看其层级结构:
在这里插入图片描述

对于Wrapper主体父类其下有关系的类,主要作用如下:

  • Wrapper:
    Wrapper 接口是用于构建查询条件的基础接口。
    它声明了一些常用的设置条件的方法,比如 eq、ne、like 等。
    QueryWrapper 和 UpdateWrapper 都实现了这个接口。
  • AbstractWrapper:
    AbstractWrapper 是一个抽象类,实现了 Wrapper 接口。
    为常用的条件设置方法提供了默认实现。
  • AbstractLambdaWrapper:
    AbstractLambdaWrapper 继承自 AbstractWrapper,引入了用于类型安全查询的 lambda 表达式。
    它专为使用 Java lambda 表达式指定查询条件的实体设计。
  • LambdaQueryWrapper:
    LambdaQueryWrapper 是 AbstractLambdaWrapper 的具体实现,用于查询操作。
    支持使用 lambda 表达式以类型安全的方式指定查询条件。
    对于实体属性名称的编译时检查,避免运行时错误。
  • LambdaUpdateWrapper:
    LambdaUpdateWrapper 是 AbstractLambdaWrapper 的具体实现,用于更新操作。
    允许使用 lambda 表达式以类型安全的方式更新实体字段。
    类似于 LambdaQueryWrapper,它通过编译时检查帮助避免运行时错误。
  • QueryWrapper:
    QueryWrapper 是 AbstractWrapper 的具体实现,用于查询操作。
    提供了各种方法用于设置不同的查询条件,如 eq、ne、like 等

2. 函数

以下是 QueryWrapper 常用的一些函数和用法:

  • eq、ne、gt、ge、lt、le:

这些方法分别表示等于、不等于、大于、大于等于、小于、小于等于的条件。

QueryWrapper<User> wrapper = new QueryWrapper<>();
wrapper.eq("name", "John") .ne("age", 25).gt("salary", 50000).ge("create_time", "2022-01-01").lt("update_time", "2023-01-01").le("status", 1);
  • like、notLike、likeLeft、likeRight:用于构建模糊查询条件。
wrapper.like("name", "John").notLike("description", "test").likeLeft("code", "abc").likeRight("email", "@domain.com");
  • isNull、isNotNull:用于构建判空条件。
wrapper.isNull("email").isNotNull("phone");
  • in、notIn:用于构建 IN 和 NOT IN 条件。
wrapper.in("role", "admin", "user", "guest").notIn("status", 0, 2, 3);
  • between、notBetween:用于构建 BETWEEN 和 NOT BETWEEN 条件。
wrapper.between("age", 20, 30).notBetween("salary", 50000, 80000);
  • or、and:用于构建 OR 和 AND 条件,可以嵌套使用。
wrapper.and(i -> i.eq("name", "John").ne("age", 25)).or(i -> i.like("name", "Tom").ge("age", 30));
  • orderBy、orderByAsc、orderByDesc:用于指定排序方式。
wrapper.orderBy(true, true, "age").orderByAsc("create_time").orderByDesc("update_time");
  • groupBy、having:用于指定分组和分组后的条件。
wrapper.groupBy("department").having("SUM(salary) > 50000");
  • apply:用于直接拼接 SQL 片段。
wrapper.apply("DATE_FORMAT(create_time, '%Y-%m-%d') = '2022-01-01'");

这些方法可以根据实际需要组合使用,动态地构建查询条件。

在 MyBatis-Plus 中,QueryWrapper 的使用使得动态条件查询变得更加方便和灵活。


关于该类的具体源码,由于比较多,我分析一个给大家看看,感兴趣的可以自已去看源码:

eq判断相等的函数:

  1. 该类继承了AbstractWrapper类:
    在这里插入图片描述
  • 找到AbstractWarpper类中重写的eq方法,对应其参数以及其怎么实现:(具体参数讲解可继续点击其addCondition)
    在这里插入图片描述
  • 查看其具体函数执行
    columnToString函数是将属性转换为string属性
    formatSql函数将val进行格式化
    doIt函数判断condition条件为true,则执行sql片段的组装
    在这里插入图片描述

3. Demo

大致相关的User类别以及Mapper需要进行创建

import com.baomidou.mybatisplus.core.conditions.query.QueryWrapper;
import com.baomidou.mybatisplus.core.toolkit.Wrappers;// Assuming you have a User entity with fields like id, name, age, email, etc.public class UserQueryExample {public static void main(String[] args) {// Example: Constructing a dynamic query// Create a QueryWrapper instanceQueryWrapper<User> wrapper = new QueryWrapper<>();// Basic conditionswrapper.eq("name", "John").between("age", 25, 35).like("email", "@domain.com");// Nested conditions using lambdawrapper.and(qw -> qw.gt("salary", 50000).or().lt("salary", 80000));// Order bywrapper.orderByAsc("age");// Applying additional conditions using applywrapper.apply("DATE_FORMAT(create_time, '%Y-%m-%d') = '2022-01-01'");// Print the generated SQLSystem.out.println("Generated SQL: " + wrapper.getSqlSegment());// If you are using MyBatis-Plus mapper, you can directly use the wrapper in your query// For example, if you have a UserMapper, you can do something like:// List<User> userList = userMapper.selectList(wrapper);}
}

以往我们都是使用Mapper文件中的sql进行编写,对于以往的sql语句:
存在一些问题:

  • SQL 注入风险: 直接拼接字符串可能导致 SQL 注入的风险,因为用户输入的数据没有经过严格的检查和处理。

  • 可读性差: 通过字符串拼接构建 SQL,代码的可读性较差,难以维护和理解。

  • 不够灵活: 需要手动处理各种情况,代码容易变得冗长。

相比之下,使用 MyBatis-Plus 的 QueryWrapper,可以更清晰、安全、易维护地构建动态查询条件,避免了手动拼接 SQL 字符串的繁琐和潜在的安全问题。


对于该类的更多例子可以看这篇文章的比较:Mybatis-plus 动态条件查询QueryWrapper的使用

这篇关于Mybatis-plus动态条件查询QueryWrapper的函数用法的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/524635

相关文章

Python中help()和dir()函数的使用

《Python中help()和dir()函数的使用》我们经常需要查看某个对象(如模块、类、函数等)的属性和方法,Python提供了两个内置函数help()和dir(),它们可以帮助我们快速了解代... 目录1. 引言2. help() 函数2.1 作用2.2 使用方法2.3 示例(1) 查看内置函数的帮助(

mapstruct中的@Mapper注解的基本用法

《mapstruct中的@Mapper注解的基本用法》在MapStruct中,@Mapper注解是核心注解之一,用于标记一个接口或抽象类为MapStruct的映射器(Mapper),本文给大家介绍ma... 目录1. 基本用法2. 常用属性3. 高级用法4. 注意事项5. 总结6. 编译异常处理在MapSt

C++ 函数 strftime 和时间格式示例详解

《C++函数strftime和时间格式示例详解》strftime是C/C++标准库中用于格式化日期和时间的函数,定义在ctime头文件中,它将tm结构体中的时间信息转换为指定格式的字符串,是处理... 目录C++ 函数 strftipythonme 详解一、函数原型二、功能描述三、格式字符串说明四、返回值五

java中long的一些常见用法

《java中long的一些常见用法》在Java中,long是一种基本数据类型,用于表示长整型数值,接下来通过本文给大家介绍java中long的一些常见用法,感兴趣的朋友一起看看吧... 在Java中,long是一种基本数据类型,用于表示长整型数值。它的取值范围比int更大,从-922337203685477

SQL中JOIN操作的条件使用总结与实践

《SQL中JOIN操作的条件使用总结与实践》在SQL查询中,JOIN操作是多表关联的核心工具,本文将从原理,场景和最佳实践三个方面总结JOIN条件的使用规则,希望可以帮助开发者精准控制查询逻辑... 目录一、ON与WHERE的本质区别二、场景化条件使用规则三、最佳实践建议1.优先使用ON条件2.WHERE用

MySQL存储过程之循环遍历查询的结果集详解

《MySQL存储过程之循环遍历查询的结果集详解》:本文主要介绍MySQL存储过程之循环遍历查询的结果集,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录前言1. 表结构2. 存储过程3. 关于存储过程的SQL补充总结前言近来碰到这样一个问题:在生产上导入的数据发现

MyBatis ResultMap 的基本用法示例详解

《MyBatisResultMap的基本用法示例详解》在MyBatis中,resultMap用于定义数据库查询结果到Java对象属性的映射关系,本文给大家介绍MyBatisResultMap的基本... 目录MyBATis 中的 resultMap1. resultMap 的基本语法2. 简单的 resul

Mybatis的分页实现方式

《Mybatis的分页实现方式》MyBatis的分页实现方式主要有以下几种,每种方式适用于不同的场景,且在性能、灵活性和代码侵入性上有所差异,对Mybatis的分页实现方式感兴趣的朋友一起看看吧... 目录​1. 原生 SQL 分页(物理分页)​​2. RowBounds 分页(逻辑分页)​​3. Page

MyBatis Plus 中 update_time 字段自动填充失效的原因分析及解决方案(最新整理)

《MyBatisPlus中update_time字段自动填充失效的原因分析及解决方案(最新整理)》在使用MyBatisPlus时,通常我们会在数据库表中设置create_time和update... 目录前言一、问题现象二、原因分析三、总结:常见原因与解决方法对照表四、推荐写法前言在使用 MyBATis

Mybatis Plus Join使用方法示例详解

《MybatisPlusJoin使用方法示例详解》:本文主要介绍MybatisPlusJoin使用方法示例详解,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,... 目录1、pom文件2、yaml配置文件3、分页插件4、示例代码:5、测试代码6、和PageHelper结合6