说明:
以下出现的第一个入参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中!!!
警告:
wrapper 很重
传输 wrapper 可以类比为你的 controller 用 map 接收值(开发一时爽,维护火葬场)
正确的 RPC 调用姿势是写一个 DTO 进行传输,被调用方再根据 DTO 执行相应的操作
我们拒绝接受任何关于 RPC 传输 Wrapper 报错相关的 issue 甚至 pr
1. AbstractWrapper
说明:QueryWrapper(LambdaQueryWrapper) 和 UpdateWrapper(LambdaUpdateWrapper) 的父类。用于生成 sql 的 where 条件, entity 属性也用于生成 sql 的 where 条件
注意: entity 生成的 where 条件与 使用各个 api 生成的 where 条件没有任何关联行为
1.1 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 = '老王'
1.2 eq (等于 =)
eq(R column, Object val) eq(boolean condition, R column, Object val)
例: eq("name", "老王")--->name = '老王'
1.3 ne(不等于 <>)
ne(R column, Object val) ne(boolean condition, R column, Object val)
例: ne("name", "老王")--->name <> '老王'
1.4 gt(大于 >)
gt(R column, Object val) gt(boolean condition, R column, Object val)
例: gt("age", 18)--->age > 18
1.5 ge(大于等于 >=)
ge(R column, Object val) ge(boolean condition, R column, Object val)
例: ge("age", 18)--->age >= 18
1.6 lt(小于 <)
lt(R column, Object val) lt(boolean condition, R column, Object val)
例: lt("age", 18)--->age < 18
1.7 le(小于等于 <=)
le(R column, Object val) le(boolean condition, R column, Object val)
例: le("age", 18)--->age <= 18
1.8 between(BETWEEN 值1 AND 值2)
between(R column, Object val1, Object val2) between(boolean condition, R column, Object val1, Object val2)
例: between("age", 18, 30)--->age between 18 and 30
1.9 notBetween(NOT BETWEEN 值1 AND 值2)
notBetween(R column, Object val1, Object val2) notBetween(boolean condition, R column, Object val1, Object val2)
例: notBetween("age", 18, 30)--->age not between 18 and 30
1.10 like(LIKE '%值%')
like(R column, Object val) like(boolean condition, R column, Object val)
例: like("name", "王")--->name like '%王%'
1.11 notLike(NOT LIKE '%值%')
notLike(R column, Object val) notLike(boolean condition, R column, Object val)
例: notLike("name", "王")--->name not like '%王%'
1.12 likeLeft(LIKE '%值')
likeLeft(R column, Object val) likeLeft(boolean condition, R column, Object val)
例: likeLeft("name", "王")--->name like '%王'
1.13 likeRight(LIKE '值%')
likeRight(R column, Object val) likeRight(boolean condition, R column, Object val)
例: likeRight("name", "王")--->name like '王%'
1.14 isNull(字段 IS NULL)
isNull(R column) isNull(boolean condition, R column)
例: isNull("name")--->name is null
1.15 isNotNull(字段 IS NOT NULL)
isNotNull(R column) isNotNull(boolean condition, R column)
例: isNotNull("name")--->name is not null
1.16 in(字段 IN (字段 IN (v0, v1, ...)),参数可以是Collection的实现类,或者数组
in(R column, Collection<?> value) in(boolean condition, R column, Collection<?> value) in(R column, Object... values) in(boolean condition, R column, Object... values)
例: in("age",{1,2,3})--->age in (1,2,3)
例: in("age", 1, 2, 3)--->age in (1,2,3)
1.17 notIn(NOT IN (v0, v1, ...)),参数可以是Collection的实现类,或者数组
notIn(R column, Collection<?> value) notIn(boolean condition, R column, Collection<?> value) notIn(R column, Object... values) notIn(boolean condition, R column, Object... values)
例: notIn("age",{1,2,3})--->age not in (1,2,3)
例: notIn("age", 1, 2, 3)--->age not in (1,2,3)
1.18 inSql(字段 IN ( sql语句 ))
inSql(R column, String inValue) inSql(boolean condition, R column, String inValue)
例: 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)
1.19 notInSql(字段 NOT IN ( sql语句 ))
notInSql(R column, String inValue) notInSql(boolean condition, R column, String inValue)
例: 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)
1.20 groupBy(分组:GROUP BY 字段, ...)
groupBy(R... columns) groupBy(boolean condition, R... columns)
例: groupBy("id", "name")--->group by id,name
1.21 orderByAsc(排序:ORDER BY 字段, ... ASC)
orderByAsc(R... columns) orderByAsc(boolean condition, R... columns)
例: orderByAsc("id", "name")--->order by id ASC,name ASC
1.22 orderByDesc(排序:ORDER BY 字段, ... DESC)
orderByDesc(R... columns) orderByDesc(boolean condition, R... columns)
例: orderByDesc("id", "name")--->order by id DESC,name DESC
1.23 orderBy(排序:ORDER BY 字段, ...)
orderBy(boolean condition, boolean isAsc, R... columns)
例: orderBy(true, true, "id", "name")--->order by id ASC,name ASC
1.24 having(HAVING ( sql语句 ))
having(String sqlHaving, Object... params) having(boolean condition, String sqlHaving, Object... params)
例: having("sum(age) > 10")--->having sum(age) > 10
例: having("sum(age) > {0}", 11)--->having sum(age) > 11
1.25 or(拼接 OR)
or() or(boolean condition) or(Consumer<Param> consumer) or(boolean condition, Consumer<Param> consumer)
注意事项: 主动调用or表示紧接着下一个方法不是用and连接!(不调用or则默认为使用and连接)
例: eq("id",1).or().eq("name","老王")--->id = 1 or name = '老王'
例: or(i -> i.eq("name", "李白").ne("status", "活着"))--->or (name = '李白' and status <> '活着')
1.26 and(AND 嵌套)
and(Consumer<Param> consumer) and(boolean condition, Consumer<Param> consumer)
例: and(i -> i.eq("name", "李白").ne("status", "活着"))--->and (name = '李白' and status <> '活着')
1.27 nested(正常嵌套 不带 AND 或者 OR)
nested(Consumer<Param> consumer) nested(boolean condition, Consumer<Param> consumer)
例: nested(i -> i.eq("name", "李白").ne("status", "活着"))--->(name = '李白' and status <> '活着')
1.28 apply(拼接 sql)
apply(String applySql, Object... params) apply(boolean condition, String applySql, Object... params)
注意事项:该方法可用于数据库函数 动态入参的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'")
1.29 last(无视优化规则直接拼接到 sql 的最后)
last(String lastSql) last(boolean condition, String lastSql)
注意事项:只能调用一次,多次调用以最后一次为准 有sql注入的风险,请谨慎使用
例: last("limit 1")
1.30 exists(拼接 EXISTS ( sql语句 ))
exists(String existsSql) exists(boolean condition, String existsSql)
例: exists("select id from table where age = 1")--->exists (select id from table where age = 1)
1.31 notExists(拼接 NOT EXISTS ( sql语句 ))
notExists(String notExistsSql) notExists(boolean condition, String notExistsSql)
例: notExists("select id from table where age = 1")--->not exists (select id from table where age = 1)
2. QueryWrapper
说明:
继承自 AbstractWrapper ,自身的内部属性 entity 也用于生成 where 条件
及 LambdaQueryWrapper, 可以通过 new QueryWrapper().lambda() 方法获取
2.1 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.getP
3. UpdateWrapper
说明:
继承自 AbstractWrapper ,自身的内部属性 entity 也用于生成 where 条件
及 LambdaUpdateWrapper, 可以通过 new UpdateWrapper().lambda() 方法获取!
3.1 set(SQL SET 字段)
set(String column, Object val) set(boolean condition, String column, Object val)
例: set("name", "老李头")
例: set("name", "")--->数据库字段值变为空字符串
例: set("name", null)--->数据库字段值变为null
3.2 setSql(设置 SET 部分 SQL)
setSql(String sql)
例: setSql("name = '老李头'")