Mybatis-Plus Wrapper使用

以下出现的第一个入参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(Function<Param, Param> func)
or(boolean condition, Function<Param, Param> func)
OR 嵌套

例: or(i -> i.eq(“name”, “李白”).ne(“status”, “活着”))—>or (name = ‘李白’ and status <> ‘活着’)

and
and(Function<Param, Param> func)
and(boolean condition, Function<Param, Param> func)
AND 嵌套

例: and(i -> i.eq(“name”, “李白”).ne(“status”, “活着”))—>and (name = ‘李白’ and status <> ‘活着’)

nested
nested(Function<Param, Param> func)
nested(boolean condition, Function<Param, Param> func)
正常嵌套 不带 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)

QueryWrapper
说明:

继承自 AbstractWrapper ,自身的内部属性 entity 也用于生成 where 条件 及 LambdaQueryWrapper, 可以通过 new QueryWrapper().lambda() 方法获取

select
select(String… sqlSelect)
select(Predicate predicate)
select(Class entityClass, Predicate predicate)
设置查询字段

说明:

以上方分法为两类. 第二类方法为:过滤查询字段(主键除外),入参不包含 class 的调用前需要wrapper内的entity属性有值! 这两类方法重复调用以最后一次为准

例: select(“id”, “name”, “age”)

例: select(i -> i.getProperty().startsWith(“test”))

excludeColumns
@Deprecated
排除查询字段

已从3.0.5版本上移除此方法!

UpdateWrapper
说明:

继承自 AbstractWrapper ,自身的内部属性 entity 也用于生成 where 条件 及 LambdaUpdateWrapper, 可以通过 new UpdateWrapper().lambda() 方法获取!

set
set(String column, Object val)
set(boolean condition, String column, Object val)
SQL SET 字段

例: set(“name”, “老李头”)

例: set(“name”, “”)—>数据库字段值变为空字符串

例: set(“name”, null)—>数据库字段值变为null

setSql
setSql(String sql)
设置 SET 部分 SQL

例: setSql(“name = ‘老李头’”)

lambda
获取 LambdaWrapper 在QueryWrapper中是获取LambdaQueryWrapper 在UpdateWrapper中是获取LambdaUpdateWrapper

使用 Wrapper 自定义SQL
需求来源:

在使用了mybatis-plus之后, 自定义SQL的同时也想使用Wrapper的便利应该怎么办? 在mybatis-plus版本3.0.7得到了完美解决 版本需要大于或等于3.0.7, 以下两种方案取其一即可

Service.java
mysqlMapper.getAll(Wrappers.lambdaQuery().eq(MysqlData::getGroup, 1));
方案一 注解方式 Mapper.java
@Select(“select * from mysql_data ${ew.customSqlSegment}”)
List getAll(@Param(

### 回答1: Mybatis-plus wrapperMybatis-plus 中的一个功能类,它可以帮助用户在使用 Mybatis-plus 时更简单地编写 SQL 语句。使用方法是在需要使用的地方引入 Wrapper 类,然后使用其中的各种方法(如 eq、like 等)构造查询条件,最后将 Wrapper 传入 Mybatis-plus 的 select、update、delete 等方法中即可执行查询、更新、删除等操作。 例如: ``` Wrapper<User> wrapper = new QueryWrapper<>(); wrapper.eq("name", "Tom") .like("age", "1"); List<User> users = userMapper.selectList(wrapper); ``` 在这个例子中,我们使用Wrapper 的 eq 和 like 方法构造了一个查询条件,查询 name 字段等于 "Tom",age 字段包含 "1" 的用户列表。 ### 回答2: Mybatis-Plus是一款基于Mybatis的增强工具包,它简化了Mybatis的开发流程,提供了一些常用且方便的功能,其中一个比较重要的功能是WrapperWrapperMybatis-Plus提供的一个用于构建SQL条件的工具类,它可以帮助我们快速构建一些常用的查询条件,如:等于、不等于、大于等于、小于等于、模糊查询等等。 使用Wrapper可以方便我们在开发时灵活地构建复杂的查询条件,同时也能大幅减少构建SQL语句所需的代码量。 在使用Wrapper时,我们需要先使用Wrappers工具类中的方法获取一个Wrapper对象,然后根据具体需求使用Wrapper对象的各种方法来构建查询条件。以下是一些常用的方法: 1. eq:等于 如:Wrapper.eq("name", "张三"),表示查询名字为“张三”的记录。 2. ne:不等于 如:Wrapper.ne("age", 18),表示查询年龄不为18的记录。 3. gt:大于 如:Wrapper.gt("age", 18),表示查询年龄大于18的记录。 4. ge:大于等于 如:Wrapper.ge("age", 18),表示查询年龄大于等于18的记录。 5. lt:小于 如:Wrapper.lt("age", 20),表示查询年龄小于20的记录。 6. le:小于等于 如:Wrapper.le("age", 20),表示查询年龄小于等于20的记录。 7. like:模糊查询 如:Wrapper.like("name", "%张%"),表示查询名字中包含“张”的记录。 8. in:包含在某个数组或集合中 如:Wrapper.in("id", Arrays.asList(1,2,3)),表示查询ID为1、2、3中的记录。 9. and:多个条件同时成立 如:Wrapper.and(w -> w.eq("name", "张三").eq("age", 18)),表示查询名字为“张三”且年龄为18岁的记录。 10. or:多个条件成立之一 如:Wrapper.or(w -> w.eq("name", "张三").eq("name", "李四")),表示查询名字为“张三”或“李四”的记录。 以上是一些常用的Wrapper方法,通过组合使用这些方法,我们可以构建出非常灵活和复杂的查询条件。 总体来说,Mybatis-PlusWrapper功能非常强大,使用它能够极大地提高我们的开发效率和代码质量,我们应该在开发中充分利用它。 ### 回答3: Mybatis-Plus WrapperMybatis-Plus框架中提供的一种强大的查询构建器,它可以帮助开发人员更轻松、更快速地构造复杂的SQL查询语句。 使用Wrapper主要有两个步骤: 第一步,创建Wrapper对象 使用Wrapper构造器,创建一个Wrapper对象。Wrapper对象是Mybatis-Plus中的一个查询构建器,它可以帮助我们更轻松、更快速地构造复杂的SQL查询语句。Wrapper包含多种类型的查询条件,在构造过程中使用它们,可以组合出各种复杂的查询条件。 第二步,使用Wrapper对象查询数据库 使用Mybatis-Plus的service的方法,如list()或者page()方法,将Wrapper对象作为参数传入,即可实现对数据库表的查询操作。 Wrapper对象的几种常用操作: 1、eq、ne、gt、ge、lt、le、between、notBetween、like 这些操作用于构造等于、不等于、大于、大于等于、小于、小于等于、在两个值之间、不在两个值之间、like等条件。 2、in、notIn、isNull、isNotNull 这些操作用于构造在某个值集合中、不在某个值集合中、为空、不为空等条件。 3、groupBy、having 这些操作用于构造分组、分组后的过滤等条件。 4、orderBy、orderByAsc、orderByDesc 这些操作用于构造排序、升序排序、降序排序等条件。 除此之外,Wrapper还支持链式调用,可以更加优雅地构造查询条件。 总的来说,Mybatis-Plus Wrapper是一个功能强大的查询构建器,可以帮助开发人员更轻松、更快速地构造复杂的SQL查询语句,并且支持链式调用,让代码更加简洁优雅。在工作中,我们经常使用Wrapper来构建查询条件,它是开发高效的利器。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值