温馨提示

如果您之前已经有了解过MP的条件构造器,那么您只需要关注MP中没有的索引条件构造器即可,其它与MP几乎一致. 条件构造器是整个框架的核心,CRUD中出现的查询条件基本都是靠它来封装的,也正是依靠它提供的链式API以及MP 语法,来简化整个ES复杂API的使用,可以把它理解为一个转换器或是中介,就好比你想吃饺子,你可以去找嫂子说你想吃 韭菜馅的饺子补补身子,剩下的嫂子会帮你搞定... Wrapper支持两种方式创建:

• 直接new,例如 new LambdaEsQueryWrapper<>().
• 通过EsWrappers.lambdaQuery()创建,可支撑链式编程的场景,对标MP的Wrappers

说明

• 以下出现的第一个入参boolean condition表示该条件是否加入最后生成的语句中，例如：query.like(StringUtils.isNotBlank(name), Entity::getName, name) .eq(age!=null && age >= 0, Entity::getAge, age)
• 以下代码块内的多个方法均为从上往下补全个别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中!
• 有任何疑问就点开源码看,看不懂函数的点击我学习新知识 (opens new window)

警告

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

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

AbstractWrapper

说明

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

QueryWrapper

说明

继承自 AbstractWrapper ,自身的内部属性 entity 也用于生成 where 条件及 LambdaEsQueryWrapper

UpdateWrapper

说明

继承自 AbstractWrapper ,自身的内部属性 entity 也用于生成 where 条件及 LambdaEsUpdateWrapper

AbstractChainWrapper

说明

继承自 Wrapper ,用于支持链式调用