sidebarDepth: 3

條件構(gòu)造器

說(shuō)明

以下出現(xiàn)的第一個(gè)入?yún)?code>boolean condition表示該條件是否加入最后生成的SQL中，例如：

query.like(StringUtils.isNotBlank(name), Entity::getName, name)
  .eq(age!=null && age >= 0, Entity::getAge, age)

以下代碼塊內(nèi)的多個(gè)方法均為從上往下補(bǔ)全個(gè)別boolean類(lèi)型的入?yún)ⅲJ(rèn)為true，如：

以下出現(xiàn)的泛型Param均為Wrapper的子類(lèi)實(shí)例(均具有AbstractWrapper的所有方法)

以下方法在入?yún)⒅谐霈F(xiàn)的R為泛型,在普通wrapper中是String,在LambdaWrapper中是函數(shù)(例:Entity::getId,Entity為實(shí)體類(lèi),getId為字段id的getMethod)

• 以下方法入?yún)⒅械?code>R column均表示數(shù)據(jù)庫(kù)字段,當(dāng)R具體類(lèi)型為String時(shí)則為數(shù)據(jù)庫(kù)字段名(字段名是數(shù)據(jù)庫(kù)關(guān)鍵字的自己用轉(zhuǎn)義符包裹!)!而不是實(shí)體類(lèi)數(shù)據(jù)字段名!!!,另當(dāng)R具體類(lèi)型為SFunction時(shí)項(xiàng)目runtime不支持eclipse自家的編譯器!!!
• 以下舉例均為使用普通wrapper,入?yún)?code>Map和List的均以json形式表現(xiàn)!
• 使用中如果入?yún)⒌?code>Map或者List為空,則不會(huì)加入最后生成的sql中!!!

警告

不支持以及不贊成在 RPC 調(diào)用中把 Wrapper 進(jìn)行傳輸：

wrapper 很重

傳輸 wrapper 可以類(lèi)比為你的 controller 用 map 接收值(開(kāi)發(fā)一時(shí)爽,維護(hù)火葬場(chǎng))

正確的 RPC 調(diào)用姿勢(shì)是寫(xiě)一個(gè) DTO 進(jìn)行傳輸,被調(diào)用方再根據(jù) DTO 執(zhí)行相應(yīng)的操作

我們拒絕接受任何關(guān)于 RPC 傳輸 Wrapper 報(bào)錯(cuò)相關(guān)的 issue 甚至 pr

AbstratWrappr

說(shuō)明

QueryWrapper(LambdaQueryWrapper) 和 UpdateWrapper(LambdaUpdateWrapper) 的父類(lèi)
用于生成 sql 的 where 條件, entity 屬性也用于生成 sql 的 where 條件
注意: entity 生成的 where 條件與 使用各個(gè) api 生成的 where 條件沒(méi)有任何關(guān)聯(lián)行為
:::

allEq

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

全部eq(或個(gè)別isNull)
tip 個(gè)別參數(shù)說(shuō)明:
params : key為數(shù)據(jù)庫(kù)字段名,value為字段值
null2IsNull : 為true則在map的value為null時(shí)調(diào)用 isNull 方法,為false時(shí)則忽略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) 

個(gè)別參數(shù)說(shuō)明

filter : 過(guò)濾函數(shù),是否允許字段傳入比對(duì)條件中
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)

實(shí)例

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

le(R column, Object val)
le(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 (value.get(0), value.get(1), …)

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

例

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)

• 字段 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

inSql(R column, String inValue)
inSql(boolean condition, R column, String inValue)

• 字段 IN ( sql語(yǔ)句 )
• 例: 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語(yǔ)句 )
• 例: 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

排序：ORDER BY 字段, … ASC

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

實(shí)例

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語(yǔ)句 )
• 例: having("sum(age) > 10")—>having sum(age) > 10
• 例: having("sum(age) > {0}", 11)—>having sum(age) > 11

func

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

• func 方法(主要方便在出現(xiàn)if…else下調(diào)用不同方法能不斷鏈)
• 例: func(i -> if(true) {i.eq("id", 1)} else {i.ne("id", 1)})

or

or()
or(boolean condition)

• 拼接 OR

::: tip 注意事項(xiàng):
主動(dòng)調(diào)用or表示緊接著下一個(gè)方法不是用and連接!(不調(diào)用or則默認(rèn)為使用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(Consumer<Param> consumer)
and(boolean condition, Consumer<Param> consumer)

• AND 嵌套
• 例: and(i -> i.eq("name", "李白").ne("status", "活著"))—>and (name = '李白' and status <> '活著')

nested

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)

該方法可用于數(shù)據(jù)庫(kù)函數(shù)
動(dòng)態(tài)入?yún)⒌?code>params對(duì)應(yīng)前面applySql內(nèi)部的{index}部分.這樣是不會(huì)有sql注入風(fēng)險(xiǎn)的,反之會(huì)有!

實(shí)例

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)

• 無(wú)視優(yōu)化規(guī)則直接拼接到 sql 的最后

::: tip 注意事項(xiàng):
只能調(diào)用一次,多次調(diào)用以最后一次為準(zhǔn)
有sql注入的風(fēng)險(xiǎn),請(qǐng)謹(jǐn)慎使用
:::

• 例: last("limit 1")

exists

exists(String existsSql)
exists(boolean condition, String existsSql)

• 拼接 EXISTS ( sql語(yǔ)句 )
• 例: 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語(yǔ)句 )
• 例: notExists("select id from table where age = 1")—>not exists (select id from table where age = 1)

QueryWrapper

::: tip 說(shuō)明:
繼承自 AbstractWrapper ,自身的內(nèi)部屬性 entity 也用于生成 where 條件
及 LambdaQueryWrapper, 可以通過(guò) new QueryWrapper().lambda() 方法獲取
:::

select

select(String... sqlSelect)
select(Predicate<TableFieldInfo> predicate)
select(Class<T> entityClass, Predicate<TableFieldInfo> predicate)

• 設(shè)置查詢(xún)字段

::: tip 說(shuō)明:
以上方法分為兩類(lèi).
第二類(lèi)方法為:過(guò)濾查詢(xún)字段(主鍵除外),入?yún)⒉话?class 的調(diào)用前需要wrapper內(nèi)的entity屬性有值!
這兩類(lèi)方法重復(fù)調(diào)用以最后一次為準(zhǔn)
:::

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

UpdateWrapper

::: tip 說(shuō)明:
繼承自 AbstractWrapper ,自身的內(nèi)部屬性 entity 也用于生成 where 條件
及 LambdaUpdateWrapper, 可以通過(guò) new UpdateWrapper().lambda() 方法獲取!
:::

set

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

• SQL SET 字段
• 例: set("name", "老李頭")
• 例: set("name", "")—>數(shù)據(jù)庫(kù)字段值變?yōu)榭兆址?/li>
• 例: set("name", null)—>數(shù)據(jù)庫(kù)字段值變?yōu)?code>null

setSql

setSql(String sql)

• 設(shè)置 SET 部分 SQL
• 例: setSql("name = '老李頭'")

lambda

• 獲取 LambdaWrapper
  

在QueryWrapper中是獲取LambdaQueryWrapper
在UpdateWrapper中是獲取LambdaUpdateWrapper

使用 Wrapper 自定義SQL

::: tip 注意事項(xiàng):
需要mybatis-plus版本 >= 3.0.7
param 參數(shù)名要么叫ew,要么加上注解@Param(Constants.WRAPPER)
使用${ew.customSqlSegment}
不支持 Wrapper 內(nèi)的entity生成where語(yǔ)句
:::

kotlin持久化對(duì)象定義最佳實(shí)踐

由于kotlin相比于java多了數(shù)據(jù)對(duì)象（data class)，在未說(shuō)明情況下可能會(huì)混用。建議按照以下形式定義持久化對(duì)象

@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使用

這里所有成員都需要定義為可空類(lèi)型（?），并賦予null的初始值，方便我們?cè)谝韵聢?chǎng)景中使用（類(lèi)似java中的updateSelective）

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

不建議使用data class及全參數(shù)構(gòu)造方法，這樣我們會(huì)寫(xiě)很多不必要的null來(lái)構(gòu)造一個(gè)空對(duì)象

用注解

@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>

鏈?zhǔn)秸{(diào)用 lambda 式

// 區(qū)分:
// 鏈?zhǔn)秸{(diào)用 普通
UpdateChainWrapper<T> update();
// 鏈?zhǔn)秸{(diào)用 lambda 式。注意：不支持 Kotlin 
LambdaUpdateChainWrapper<T> lambdaUpdate();

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

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

到此這篇關(guān)于關(guān)于MyBatis plus條件構(gòu)造器的逐條詳解的文章就介紹到這了,更多相關(guān)MyBatis plus條件構(gòu)造器內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！