MybatisPlus基础篇学习笔记(四)------查询方法

原创:兜里的猫

本章目录

  • 普通查询
  • 条件构造器查询
  • select不列出全部字段
  • condition作用
  • 实体作为条件构造器构造方法的参数
  • AllEq用法
  • 其他使用条件构造器的方法
  • lambda条件构造器

1. 普通查询

下面通过通用mapper提供的接口来演示简单的查询

image

①.selectById方法:MP通过传入的id,会自动在select语句中拼接where id = ?,在控制台打印的日志可清楚看出;

image

②.selectBatchIds方法:MP通过传入的多个id,会自动在select语句中拼接where id in (?,?,?,?), 在控制台打印的日志可清楚看出;

image

③.selectByMap方法:MP通过传入的map集合中的键值对,会自动解析出键值对应的表中的字段键值,在select语句中拼接WHERE password = ? AND name = ? 在控制台打印的日志可清楚看出,这里需要注意的是==传入的map集合中key对应的是表字段名称而不是实体类属性名称==;

image

2. 条件构造器查询

image

使用QueryWrapper条件构造器进行查询条件的筛选,当我们需要查询name中包含“三”,且state小于2的成员时,转义为sql语句及where name like '%三%' and state < 2,可通过创建条件构造器QueryWrapper对象带入查询条件进行筛选,通过链式调用拼接我们查询的条件,使用selectList方法传入条件构造器进行查询操作,可通过控制台日志打印看出,已被MP转义为where条件。

image

补充: 查询是使用条件构造器QueryWrapper动态拼接where语句完成查询,QueryWrapper继承AbstractWrapper抽象类,AbstractWrapper实现了Compare接口,最终QueryWrapper通过调用Compare接口中方法实现条件拼接。

image

此处详细介绍下AbstractWrapper:(摘自官方文档)

说明:

  • 以下出现的第一个入参boolean condition表示该条件是否加入最后生成的sql中
  • 以下代码块内的多个方法均为从上往下补全个别boolean类型的入参,默认为true
  • 以下出现的泛型Param均为Wrapper的子类实例(均具有AbstractWrapper的所有方法)
  • 以下方法在入参中出现的R为泛型,在普通wrapper中是String,在LambdaWrapper中是函数(例:Entity::getId,Entity为实体类,getId为字段id的getMethod)
  • 以下方法入参中的R column均表示数据库字段,当R具体类型为String时则为数据库字段名(字段名是数据库关键字的自己用转义符包裹!)!而不是实体类数据字段名!!!,另当R具体类型为SFunction时项目runtime不支持eclipse自家的编译器!!!
  • 以下举例均为使用普通wrapper,入参为Map和List的均以json形式表现!
  • 使用中如果入参的Map或者List为空,则不会加入最后生成的sql中!!!

警告:

  • 不支持以及不赞成在 RPC 调用中把 Wrapper 进行传输
  • wrapper 很重
  • 传输 wrapper 可以类比为你的 controller 用 map 接收值(开发一时爽,维护火葬场)
  • 正确的 RPC 调用姿势是写一个 DTO 进行传输,被调用方再根据 DTO 执行相应的操作
  • 我们拒绝接受任何关于 RPC 传输 Wrapper 报错相关的 issue 甚至 pr

==AbstractWrapper==

说明:

  • QueryWrapper(LambdaQueryWrapper) 和 UpdateWrapper(LambdaUpdateWrapper) 的父类
  • 用于生成 sql 的 where 条件, entity 属性也用于生成 sql 的 where 条件
  • 注意: entity 生成的 where 条件与 使用各个 api 生成的 where 条件没有任何关联行为

allEq

allEq(Map<R, V> params)
allEq(Map<R, V> params, boolean null2IsNull)
allEq(boolean condition, Map<R, V> params, boolean null2IsNull)
  • 全部eq(或个别isNull)
个别参数说明:

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(BiPredicate<R, V> filter, Map<R, V> params)
allEq(BiPredicate<R, V> filter, Map<R, V> params, boolean null2IsNull)
allEq(boolean condition, BiPredicate<R, V> filter, Map<R, V> params, boolean null2IsNull)
个别参数说明:

filter : 过滤函数,是否允许字段传入比对条件中
params 与 null2IsNull : 同上
  • 例1: allEq((k,v) -> k.indexOf("a") >= 0, {id:1,name:"老王",age:null})--->name = '老王' and age is null
  • 例2: allEq((k,v) -> k.indexOf("a") >= 0, {id:1,name:"老王",age:null}, false)--->name = '老王'

eq

eq(R column, Object val)
eq(boolean condition, R column, Object val)
  • 等于 =
  • 例: eq("name", "老王")--->name = '老王'

ne

ne(R column, Object val)
ne(boolean condition, R column, Object val)
  • 不等于 <>
  • 例: ne("name", "老王")--->name <> '老王'

gt

gt(R column, Object val)
gt(boolean condition, R column, Object val)
  • 大于 >
  • 例: gt("age", 18)--->age > 18

ge

ge(R column, Object val)
ge(boolean condition, R column, Object val)
  • 大于等于 >=
  • 例: ge("age", 18)--->age >= 18

lt

lt(R column, Object val)
lt(boolean condition, R column, Object val)
  • 小于 <
  • 例: lt("age", 18)--->age < 18

le

le(R column, Object val)
le(boolean condition, R column, Object val)
  • 小于等于 <=
  • 例: le("age", 18)--->age <= 18

between

between(R column, Object val1, Object val2)
between(boolean condition, R column, Object val1, Object val2)
  • BETWEEN 值1 AND 值2
  • 例: between("age", 18, 30)--->age between 18 and 30

notBetween

notBetween(R column, Object val1, Object val2)
notBetween(boolean condition, R column, Object val1, Object val2)
  • NOT BETWEEN 值1 AND 值2
  • 例: notBetween("age", 18, 30)--->age not between 18 and 30

like

like(R column, Object val)
like(boolean condition, R column, Object val)
  • LIKE '%值%'
  • 例: like("name", "王")--->name like '%王%'

notLike

notLike(R column, Object val)
notLike(boolean condition, R column, Object val)
  • NOT LIKE '%值%'
  • 例: notLike("name", "王")--->name not like '%王%'

likeLeft

likeLeft(R column, Object val)
likeLeft(boolean condition, R column, Object val)
  • LIKE '%值'
  • 例: likeLeft("name", "王")--->name like '%王'

likeRight

likeRight(R column, Object val)
likeRight(boolean condition, R column, Object val)
  • LIKE '值%'
  • 例: likeRight("name", "王")--->name like '王%'

isNull

isNull(R column)
isNull(boolean condition, R column)
  • 字段 IS NULL
  • 例: isNull("name")--->name is null

isNotNull

isNotNull(R column)
isNotNull(boolean condition, R column)
  • 字段 IS NOT NULL
  • 例: isNotNull("name")--->name is not null

in

in(R column, Collection<?> value)
in(boolean condition, R column, Collection<?> value)
  • 字段 IN (value.get(0), value.get(1), ...)
  • 例: in("age",{1,2,3})--->age in (1,2,3)
in(R column, Object... values)
in(boolean condition, R column, Object... values)
  • 字段 IN (v0, v1, ...)
  • 例: in("age", 1, 2, 3)--->age in (1,2,3)

notIn

notIn(R column, Collection<?> value)
notIn(boolean condition, R column, Collection<?> value)
  • 字段 IN (value.get(0), value.get(1), ...)
  • 例: notIn("age",{1,2,3})--->age not in (1,2,3)
notIn(R column, Object... values)
notIn(boolean condition, R column, Object... values)
  • 字段 NOT IN (v0, v1, ...)
  • 例: notIn("age", 1, 2, 3)--->age not in (1,2,3)

inSql

inSql(R column, String inValue)
inSql(boolean condition, R column, String inValue)
  • 字段 IN ( sql语句 )
  • 例: inSql("age", "1,2,3,4,5,6")--->age in (1,2,3,4,5,6)
  • 例: inSql("id", "select id from table where id < 3")--->id in (select id from table where id < 3)

notInSql

notInSql(R column, String inValue)
notInSql(boolean condition, R column, String inValue)
  • 字段 NOT IN ( sql语句 )
  • 例: notInSql("age", "1,2,3,4,5,6")--->age not in (1,2,3,4,5,6)
  • 例: notInSql("id", "select id from table where id < 3")--->age not in (select id from table where id < 3)

groupBy

groupBy(R... columns)
groupBy(boolean condition, R... columns)
  • 分组:GROUP BY 字段, ...
  • 例: groupBy("id", "name")--->group by id,name

orderByAsc

orderByAsc(R... columns)
orderByAsc(boolean condition, R... columns)
  • 排序:ORDER BY 字段, ... ASC
  • 例: orderByAsc("id", "name")--->order by id ASC,name ASC

orderByDesc

orderByDesc(R... columns)
orderByDesc(boolean condition, R... columns)
  • 排序:ORDER BY 字段, ... DESC
  • 例: orderByDesc("id", "name")--->order by id DESC,name DESC

orderBy

orderBy(boolean condition, boolean isAsc, R... columns)
  • 排序:ORDER BY 字段, ...
  • 例: orderBy(true, true, "id", "name")--->order by id ASC,name ASC

having

having(String sqlHaving, Object... params)
having(boolean condition, String sqlHaving, Object... params)
  • HAVING ( sql语句 )
  • 例: having("sum(age) > 10")--->having sum(age) > 10
  • 例: having("sum(age) > {0}", 11)--->having sum(age) > 11

or

or()
or(boolean condition)
  • 拼接 OR
注意事项:

主动调用or表示紧接着下一个方法不是用and连接!(不调用or则默认为使用and连接)
  • 例: eq("id",1).or().eq("name","老王")--->id = 1 or name = '老王'
or(Consumer<Param> consumer)
or(boolean condition, Consumer<Param> consumer)
  • OR 嵌套
  • 例: or(i -> i.eq("name", "李白").ne("status", "活着"))--->or (name = '李白' and status <> '活着')

and

and(Consumer<Param> consumer)
and(boolean condition, Consumer<Param> consumer)
  • AND 嵌套
  • 例: and(i -> i.eq("name", "李白").ne("status", "活着"))--->and (name = '李白' and status <> '活着')

nested

nested(Consumer<Param> consumer)
nested(boolean condition, Consumer<Param> consumer)
  • 正常嵌套 不带 AND 或者 OR
  • 例: nested(i -> i.eq("name", "李白").ne("status", "活着"))--->(name = '李白' and status <> '活着')

apply

apply(String applySql, Object... params)
apply(boolean condition, String applySql, Object... params)
  • 拼接 sql
注意事项:

该方法可用于数据库函数 动态入参的params对应前面applySql内部的{index}部分.这样是不会有sql注入风险的,反之会有!
  • 例: apply("id = 1")--->id = 1
  • 例: apply("date_format(dateColumn,'%Y-%m-%d') = '2008-08-08'")--->date_format(dateColumn,'%Y-%m-%d') = '2008-08-08'")
  • 例: apply("date_format(dateColumn,'%Y-%m-%d') = {0}", "2008-08-08")--->date_format(dateColumn,'%Y-%m-%d') = '2008-08-08'")

last

last(String lastSql)
last(boolean condition, String lastSql)
  • 无视优化规则直接拼接到 sql 的最后
注意事项:

只能调用一次,多次调用以最后一次为准 有sql注入的风险,请谨慎使用
  • 例: last("limit 1")

exists

exists(String existsSql)
exists(boolean condition, String existsSql)
  • 拼接 EXISTS ( sql语句 )
  • 例: exists("select id from table where age = 1")--->exists (select id from table where age = 1)

notExists

notExists(String notExistsSql)
notExists(boolean condition, String notExistsSql)
  • 拼接 NOT EXISTS ( sql语句 )
  • 例: notExists("select id from table where age = 1")--->not exists (select id from table where age = 1)

image

上图表格为条件构造器AbstractWrapper使用中的各个方法格式和说明,如有不懂可参考官方文档内容

3. 查询不列出全部字段

image

在构造器中加上select方法,参数为需要显示的列,从图中打印日志可看出sql语句中只列出了id,name,,查询出来的对象中也只有id和name赋值,其他参均未赋值。

image

当表字段较多且只需要不显示几列值时,通过用select一一列出字段名的方法就显的繁琐了,可以使用上图中的select方法来排除不需要显示的列,从打印日志sql语句可以看出已排除我们不需要的列。(代码中info类型为TableFieldInfo类存储了table表中所有信息)

4. condition作用

image
image

有些场景需求是前台提供用户使用id或者name进行查询,当用户输入id时通过id查询,当用户输入name时通过name查询,我们从代码中可以看出,boolean类型的condition作为like方法的参数作用是当condition为true时该方法参与查询条件,当condition为false时该方法不参与查询条件。

5. 实体作为条件构造器构造方法的参数

image

使用对象set条件之后,将对象装载到条件构造器中即可生成where条件,但where条件中都是等值操作,如需模糊查询,在实体类属性上加上@TableField(condition = SqlCondition.LIKE)注解即可,其中SqlCondition还有其他方法可供使用。(==需注意的是,使用实体作为条件构造器构造方法的参数时,与条件构造器的方法是并存的==)

6. AllEq用法

image

条件构造器的allEq方法有多种参数可设置,这里我们简单演示其中一种:allEq(Map<R, V> params, boolean null2IsNull),第一个参数params为查询的条件,第二个参数为是否忽略null值,从图中代码示例可以看出,当password设置为null时,控制台日志where语句中不会添加password条件。

7. 其他使用条件构造器的方法

image

这里举例返回map集合的selectMaps方法,从图中控制台打印日志可以看出,map集合只显示我设置的查询列,其他无关属性不会显示,与下面我注释的selectList方法会列出所有列,不需要显示的值会以null值显示,对比显得很简洁,selectMaps方法适合在只需要个别字段的场景中很适合使用。

selectMaps方法还可以列出我们需要的统计值例如avg、count、sum、min、max等

8. lambda条件构造器

image

使用lambda构造器可避免编写代码时属性名称的编写错误,参数中的属性使用的是lambda表达式调用。

欢迎大家指正本文中的错误并交流,感谢大家支持,希望与你们一同进步!


评论

稻城 : 111
兜里的猫 : 是md
Your browser is out-of-date!

Update your browser to view this website correctly. Update my browser now

×