条件构造器

条件构造器

---

说明 :

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

警告 :

  不支持以及不赞成在 RPC 调用中把 Wrapper 进行传输

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

AbstractWrapper :

说明:

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

allEq : 全部eq(或个别isNull)

allEq(Map<R, V> params)
allEq(Map<R, V> params, boolean null2IsNull)
allEq(boolean condition, Map<R, V> params, boolean null2IsNull)

个别参数说明:

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 值1 AND 值2

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 : NOT BETWEEN 值1 AND 值2

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 ‘%值%’

like(R column, Object val)
like(boolean condition, R column, Object val)

• LIKE ‘%值%’
• 例:like(“name”, “王”) —> name like ‘%王%’

notLike : NOT LIKE ‘%值%’

notLike(R column, Object val)
notLike(boolean condition, R column, Object val)

NOT LIKE ‘%值%’
例:notLike(“name”, “王”) —> name not like ‘%王%’

likeLeft : LIKE ‘%值’

likeLeft(R column, Object val)
likeLeft(boolean condition, R column, Object val)

• LIKE ‘%值’
• 例:likeLeft(“name”, “王”) —> name like ‘%王’

likeRight : LIKE ‘值%’

likeRight(R column, Object val)
likeRight(boolean condition, R column, Object val)

• LIKE ‘值%’
• 例: likeRight(“name”, “王”) —> name like ‘王%’

isNull : 字段 IS NULL

isNull(R column)
isNull(boolean condition, R column)

• 字段 IS NULL
• 例:isNull(“name”) —> name is null

isNotNull : 字段 IS NOT NULL

isNotNull(R column)
isNotNull(boolean condition, R column)

• 字段 IS NOT NULL
• 例:isNotNull(“name”) —> name is not null

in : 字段 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 : 字段 NOT IN()

notIn(R column, Collection<?> value)
notIn(boolean condition, R column, Collection<?> value)

• 字段 NOT 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 : 字段 IN ( sql语句 )

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 : 字段 NOT IN ( sql语句 )

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”)—>id 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 : 排序 ASC

orderByAsc(R... columns)
orderByAsc(boolean condition, R... columns)

• 排序：ORDER BY 字段, … ASC
• 例:orderByAsc(“id”, “name”)—>order by id ASC,name ASC

orderByDesc : 排序 DESC

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 ( sql语句 )

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

func : func 方法(主要方便在出现if…else下调用不同方法能不断链)

func(Consumer<Children> consumer)
func(boolean condition, Consumer<Children> consumer)

• func 方法(主要方便在出现if…else下调用不同方法能不断链)
• 例:func(i -> if(true) {i.eq(“id”, 1)} else {i.ne(“id”, 1)})

or : 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

and(Consumer<Param> consumer)
and(boolean condition, Consumer<Param> consumer)

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

nested : 正常嵌套 不带 AND 或者 OR

nested(Consumer<Param> consumer)
nested(boolean condition, Consumer<Param> consumer)

• 正常嵌套 不带 AND 或者 OR
• 例:nested(i -> i.eq(“name”, “李白”).ne(“status”, “活着”))—>(name = ‘李白’ and status <> ‘活着’)

apply : 拼接 sql

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 : 无视优化规则直接拼接到 sql 的最后

last(String lastSql)
last(boolean condition, String lastSql)

• 无视优化规则直接拼接到 sql 的最后
• 注意事项:只能调用一次,多次调用以最后一次为准 有sql注入的风险,请谨慎使用
• 例:last(“limit 1”)

exists : 拼接 EXISTS ( sql语句 )

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 : 拼接 NOT EXISTS ( sql语句 )

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<TableFieldInfo> predicate)
select(Class<T> entityClass, Predicate<TableFieldInfo> predicate)

设置查询字段

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

• 例:select(“id”, “name”, “age”)
• 例:select(i -> i.getProperty().startsWith(“test”))

UpdateWrapper

---

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

set : SET 字段

set(String column, Object val)
set(boolean condition, String column, Object val)

• SQL SET 字段
• 例:set(“name”, “老李头”)
• 例:set(“name”, “”) —> 数据库字段值变为空字符串
• 例:set(“name”, null)—>数据库字段值变为null

setSql : SET 部分 SQL

setSql(String sql)

• 设置 SET 部分 SQL
• 例:setSql(“name = ‘老李头’”)

lambda

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

使用 Wrapper 自定义SQL

---

注意事项:
需要mybatis-plus版本 >= 3.0.7 param 参数名要么叫ew,
要么加上注解@Param(Constants.WRAPPER) 使用${ew.customSqlSegment}
不支持 Wrapper 内的entity生成where语句

kotlin持久化对象定义最佳实践

由于kotlin相比于java多了数据对象（data class)，在未说明情况下可能会混用。建议按照以下形式定义持久化对象

@TableName("sys_user")
class User {
		@TableId(type = IdType.AUTO)
    var id: Int? = null

    @TableField("username")
    var name: String? = null

    var roleId: Int? = null
}

注意：这里的TableId及TableField并非必要，只是为了展示Mybatis-Plus中的annotation使用
这里所有成员都需要定义为可空类型（?），并赋予null的初始值，方便我们在以下场景中使用（类似java中的updateSelective）

val wrapper = KtUpdateWrapper(User::class.java).eq(User::id, 2)
val newRecord = User()
newRecord.name = "newName"
userMapper!!.update(newRecord, wrapper)

不建议使用data class及全参数构造方法，这样我们会写很多不必要的null来构造一个空对象

用注解

@Select("select * from mysql_data ${ew.customSqlSegment}")
List<MysqlData> getAll(@Param(Constants.WRAPPER) Wrapper wrapper);

用XML

List<MysqlData> getAll(Wrapper ew);

<select id="getAll" resultType="MysqlData">
	SELECT * FROM mysql_data ${ew.customSqlSegment}
</select>

kotlin使用wrapper

kotlin 可以使用 QueryWrapper 和 UpdateWrapper 但无法使用 LambdaQueryWrapper 和 LambdaUpdateWrapper
如果想使用 lambda 方式的 wrapper 请使用 KtQueryWrapper 和 KtUpdateWrapper

请参考实例(opens new window)

val queryWrapper = KtQueryWrapper(User()).eq(User::name, "sss").eq(User::roleId, "sss2")
userMapper!!.selectList(queryWrapper)

val updateConditionWrapper = KtUpdateWrapper(User()).eq(User::name, "sss").eq(User::roleId, "sss2")
val updateRecord = User()
updateRecord.name = "newName"
userMapper!!.update(updateRecord, updateConditionWrapper)

val updateRecord = User()
updateRecord.id = 2
updateRecord.name = "haha"
userMapper.updateById(updateRecord)

链式调用 lambda 式

// 区分:
// 链式调用 普通
UpdateChainWrapper<T> update();
// 链式调用 lambda 式。注意：不支持 Kotlin 
LambdaUpdateChainWrapper<T> lambdaUpdate();

// 等价示例：
query().eq("id", value).one();
lambdaQuery().eq(Entity::getId, value).one();

// 等价示例：
update().eq("id", value).remove();
lambdaUpdate().eq(Entity::getId, value).remove();

MyBatis-Plus 官方的文档 方便使用