說明:
以下出現的第一個入參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 = '老李頭'")