條件構造器
案例table
AbstractWrapper
allEq:所有eq(或個別isNull)
eq:等於 =
ne:不等於 <>
gt:大於 >
ge:大於等於 >=
lt:小於 <
le:小於等於 <=
between:BETWEEN 值1 AND 值2
notBetween:NOT BETWEEN 值1 AND 值2
like:LIKE '%值%'
notLike:NOT LIKE '%值%'
likeLeft:LIKE '%值'
likeRight:LIKE '值%'
isNull:字段 IS NULL
isNotNull: 字段 IS NULL
in:字段 IN
notIn:字段 NOT IN
inSql:字段 IN ( sql語句 )
notInSql:字段 NOT IN ( sql語句 )
groupBy:分組:GROUP BY 字段, ...
orderByAsc:排序:ORDER BY 字段, ... ASC
orderByDesc 排序:ORDER BY 字段, ... DESC
orderBy:排序:ORDER BY 字段, ...
having:HAVING ( sql語句 )
or:拼接 OR
and:AND 嵌套
nested:正常嵌套 不帶 AND 或者 OR
apply:拼接 sql
last:無視優化規則直接拼接到 sql 的最後
exists:拼接 EXISTS ( sql語句 )
notExists:拼接 NOT EXISTS ( sql語句 )
QueryWrapper(select)
select:設置查詢字段
excludeColumns:排除查詢字段
UpdateWrapper(update)
set
setSql:設置 SET 部分 SQL
lambda
使用 Wrapper 自定義SQL
Service.java
方案一 註解方式 Mapper.java
方案二 XML形式 Mapper.xml
分頁查詢
自定義SQL查詢分頁數據
熱部署(已過期)
邏輯刪除(不建議使用)
配置
使用
枚舉
配置
實現 IEnum 接口
使用
來源: mybatis plus官網html
mybatis plus條件拼接
條件構造器
說明
:java
- 如下出現的第一個入參
boolean condition
表示該條件是否加入最後生成的sql中- 沒有標明
condition
的方法,默認爲true
- 如下出現的泛型
Param
均爲Wrapper
的子類實例(均具備AbstractWrapper
的全部方法)- 如下方法在入參中出現的
R
爲泛型,在普通wrapper中是String
,在LambdaWrapper中是函數(例:Entity::getId
,Entity
爲實體類,getId
爲字段id
的getMethod)- 參數
R column
均表示數據庫字段
,而不是實體類數據字段名!!!(字段名是數據庫關鍵字的本身用轉義符包裹!)!- 如下舉例均爲使用普通wrapper,入參爲
Map
和List
的均以json
形式表現!- 使用中若是入參的
Map
或者List
爲空,則不會加入最後生成的sql中!!!- 有任何疑問就點開源碼看,看不懂函數的點擊我學習新知識
警告
:
不支持以及不同意在 RPC 調用中把 Wrapper 進行傳輸(遠程調用)mysql
- wrapper 很重
- 傳輸 wrapper 能夠類比爲你的 controller 用 map 接收值(開發一時爽,維護火葬場)
- 正確的 RPC 調用姿式是寫一個 DTO 進行傳輸,被調用方再根據 DTO 執行相應的操做
- 咱們拒絕接受任何關於 RPC 傳輸 Wrapper 報錯相關的 issue 甚至 pr
案例table
CREATE TABLE `aaa_bbb_cc` ( `ID` int(10) NOT NULL AUTO_INCREMENT, `aa_as` varchar(255) DEFAULT NULL, `ab_AAA` varchar(255) DEFAULT NULL, PRIMARY KEY (`ID`)) ENGINE=InnoDB AUTO_INCREMENT=18 DEFAULT CHARSET=utf8;
@Data@AllArgsConstructor@NoArgsConstructorpublic class AaaBbbCc implements Serializable { private static final long serialVersionUID = 1L; @TableId(value = "ID", type = IdType.AUTO) private Integer id; private String aaAs; @TableField("ab_AAA") private String abAaa;}
AbstractWrapper
說明:
QueryWrapper(LambdaQueryWrapper) 和 UpdateWrapper(LambdaUpdateWrapper) 的父類
用於生成 sql 的 where 條件, entity 屬性也用於生成 sql 的 where 條件
注意: entity 生成的 where 條件與 使用各個 api 生成的 where 條件沒有任何關聯行爲spring
allEq:所有eq(或個別isNull)
allEq(Map<R, V> params)allEq(Map<R, V> params, boolean null2IsNull)allEq(boolean condition, Map<R, V> params, boolean null2IsNull)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)
參數說明:
params
:key
爲數據庫字段名(注意不是entity),value
爲字段值
null2IsNull
: 爲true
則在map
的value
爲null
時調用 isNull 方法,爲false
時則忽略value
爲null
的
filter
: 過濾函數,是否容許字段傳入比對條件中 sql案例數據庫
Map<String,Object> stringTMap=new LinkedHashMap<>();stringTMap.put("ID",12 );stringTMap.put("aa_as",null);queryWrapper.allEq(stringTMap);//ID = ? AND aa_as IS NULL :null的直接is nullqueryWrapper.allEq(stringTMap,false);// WHERE ID = ? :null的不查詢queryWrapper.allEq(false,stringTMap,false);// condition爲false,不拼接此查詢條件 //x是字段,y是對應的值,使用Lambda表達式進行條件的校驗BiPredicate<String, Object> bi = (x, y) -> x .equals("ID");queryWrapper.allEq(bi,stringTMap);//WHERE ID = ?
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("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)
- 例:
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("name", "王")
--->name like '%王%'
notLike:NOT LIKE '%值%'
notLike(R column, Object val)notLike(boolean condition, R column, Object val)
- 例:
notLike("name", "王")
--->name not like '%王%'
likeLeft:LIKE '%值'
likeLeft(R column, Object val)likeLeft(boolean condition, R column, Object val)
- 例:
likeLeft("name", "王")
--->name like '%王'
likeRight:LIKE '值%'
likeRight(R column, Object val)likeRight(boolean condition, R column, Object val)
- 例:
likeRight("name", "王")
--->name like '王%'
isNull:字段 IS NULL
isNull(R column)isNull(boolean condition, R column)
- 例:
isNull("name")
--->name is null
isNotNull: 字段 IS NULL
isNotNull(R column)isNotNull(boolean condition, R column)
- 例:
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)
- 字段 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)
- 例:
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)
- 例:
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)
groupBy:分組:GROUP BY 字段, ...
groupBy(R... columns)groupBy(boolean condition, R... columns)
- 例:
groupBy("id", "name")
--->group by id,name
orderByAsc:排序:ORDER BY 字段, ... ASC
orderByAsc(R... columns)orderByAsc(boolean condition, R... columns)
- 例:
orderByAsc("id", "name")
--->order by id ASC,name ASC
orderByDesc 排序:ORDER BY 字段, ... DESC
orderByDesc(R... columns)orderByDesc(boolean condition, R... columns)
- 例:
orderByDesc("id", "name")
--->order by id DESC,name DESC
orderBy:排序:ORDER BY 字段, ...
orderBy(boolean condition, boolean isAsc, R... columns)
- 排序:ORDER BY 字段, ...
- 例:
orderBy(true, true, "id", "name")
--->order by id ASC,name ASC
queryWrapper.orderByAsc("aa_as");queryWrapper.orderByDesc("ab_AAA");//ORDER BY aa_as ASC , ab_AAA DESC
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
or:拼接 OR
or()or(boolean condition)
注意事項:
主動調用or
表示緊接着下一個方法不是用and
鏈接!(不調用or
則默認爲使用and
鏈接)json
- 例:
eq("id",1).or().eq("name","老王")
--->id = 1 or name = '老王'
or(Function<Param, Param> func)or(boolean condition, Function<Param, Param> func)
- OR 嵌套
- 例:
or(i -> i.eq("name", "李白").ne("status", "活着"))
--->or (name = '李白' and status <> '活着')
queryWrapper.eq("ID" ,13 );queryWrapper.or();queryWrapper.eq("ID" ,14);queryWrapper.ne("aa_as","rtget" );//ID = ? OR (ID = ? AND aa_as <> ?)queryWrapper.eq("ID" ,13 ).or(i->i.eq("ID" ,14 ).ne("aa_as","rtget" )).or(i->i.eq("aa_as","測試2" ))//要在一條上才能連上 or(Function<Param, Param> func)//WHERE ID = ? OR ( ID = ? AND aa_as <> ? ) OR ( aa_as = ? )
and:AND 嵌套
and(Function<Param, Param> func)and(boolean condition, Function<Param, Param> func)
- 例:
and(i -> i.eq("name", "李白").ne("status", "活着"))
--->and (name = '李白' and status <> '活着')
nested:正常嵌套 不帶 AND 或者 OR
nested(Function<Param, Param> func)nested(boolean condition, Function<Param, Param> func)
- 例:
nested(i -> i.eq("name", "李白").ne("status", "活着"))
--->(name = '李白' and status <> '活着')
apply:拼接 sql
apply(String applySql, Object... params)apply(boolean condition, String applySql, Object... params)
注意事項:
該方法可用於數據庫函數
動態入參的params
對應前面applySql
內部的{index}
部分.這樣是不會有sql注入風險的,反之會有!api
- 例:
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注入的風險,請謹慎使用springboot
- 例:
last("limit 1")
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)
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)
QueryWrapper(select)
說明:
繼承自 AbstractWrapper ,自身的內部屬性 entity 也用於生成 where 條件
及 LambdaQueryWrapper, 能夠經過 new QueryWrapper().lambda() 方法獲取mybatis
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"))
excludeColumns:排除查詢字段
已從
3.0.5
版本上移除此方法!
UpdateWrapper(update)
說明:
繼承自AbstractWrapper
,自身的內部屬性entity
也用於生成 where 條件
及LambdaUpdateWrapper
, 能夠經過new UpdateWrapper().lambda()
方法獲取!
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("name = '老李頭')
lambda
- 獲取
LambdaWrapper
在QueryWrapper
中是獲取LambdaQueryWrapper
在UpdateWrapper
中是獲取LambdaUpdateWrapper
使用 Wrapper 自定義SQL
需求來源:
在使用了mybatis-plus
以後, 自定義SQL的同時也想使用Wrapper
的便利應該怎麼辦?
在mybatis-plus
版本3.0.7
獲得了完美解決
版本須要大於或等於3.0.7
, 如下兩種方案取其一便可
Service.java
mysqlMapper.getAll(Wrappers.<MysqlData>lambdaQuery().eq(MysqlData::getGroup, 1));
方案一 註解方式 Mapper.java
@Select("select * from mysql_data ${ew.customSqlSegment}")List<MysqlData> getAll(@Param(Constants.WRAPPER) Wrapper wrapper);
方案二 XML形式 Mapper.xml
<select id="getAll" resultType="MysqlData"> SELECT * FROM mysql_data ${ew.customSqlSegment}</select>
分頁查詢
mybatis plus提供了分頁功能,能夠輕鬆實現分頁;
//設置查詢參數Page<AaaBbbCc> page=new Page<>();page.setCurrent(1);page.setSize(2);//開始查詢IPage<AaaBbbCc> page2 = aaaBbbCcDao.page(page);/**getCurrent():當前頁數;getPages():總頁數;getSize():查詢數量;getTotal():總數量;getRecords():查詢結果;如果當前頁>總頁數,返回[];如果當前頁數<1,查詢第一頁數據;*/
自定義SQL查詢分頁數據
- 將
Page<T> page
參數設置爲查詢的第一個參數,不須要拼接分頁查詢條件,mybatis plus會自動執行分頁查詢; - 例:
/** * <p> * 查詢 : 根據state狀態查詢用戶列表,分頁顯示 * 注意!!: 若是入參是有多個,須要加註解指定參數名才能在xml中取值 * </p> * * @param page 分頁對象,xml中能夠從裏面進行取值,傳遞參數 Page 即自動分頁,必須放在第一位(你能夠繼承Page實現本身的分頁對象) * @param state 狀態 * @return 分頁對象 */@Select("SELECT id,name FROM user WHERE state=#{state}")IPage<User> selectPageVo(Page page, @Param("state") Integer state);
熱部署(已過期)
在3.1.0已經徹底移除了....咱們用的是3.1.1,用不了了o(╥﹏╥)o
邏輯刪除(不建議使用)
在正式項目中,刪除數據時不少時候不是將數據直接刪除,而是建立一個字段,用不一樣的數據表示不一樣的狀態;
好比建立一個enable
字段,enable=1
,則表示數據使用中,enable=0
,則表示數據邏輯上已經刪除了,平時使用時,這條數據默認不查詢;
在mybatis plus中能夠設置邏輯刪除的查詢;
配置
- yml
mybatis-plus: global-config: db-config: logic-delete-value: 0 # 邏輯已刪除值(默認爲 1) logic-not-delete-value: 1 # 邏輯未刪除值(默認爲 0)
- entity
//在表明刪除的字段上添加註解:@TableLogicprivate Integer enable;
使用
//默認在查詢的時候就會拼接上enable的條件dao.list();//where enable=1
注意,此查詢條件不會被覆蓋,使用功能需謹慎
//如果想要查詢已經刪除的數據,將沒法查詢....queryWrapper.eq("enable","0" );dao.list(queryWrapper);//WHERE enable=1 AND enable = 0
因此仍是本身寫吧o(╥﹏╥)o
枚舉
自3.1.0開始,可配置默認枚舉處理類來省略掃描通用枚舉配置,3.1.0以前和以後的配置是不一樣的,咱們就不研究3.1.0以前的使用方法了(#^.^#)
配置
- 掃描通用枚舉
mybatis-plus: # 支持統配符 * 或者 ; 分割 typeEnumsPackage: com.baomidou.springboot.entity.enums,自定義枚舉
- entity配置/JSON序列化處理
- Jackson
在須要響應描述字段的get方法上添加@JsonValue註解便可
- Fastjson
- 全局處理方式
```java
FastJsonConfig config = new FastJsonConfig();
//設置WriteEnumUsingToString
config.setSerializerFeatures(SerializerFeature.WriteEnumUsingToString);
converter.setFastJsonConfig(config);
- 全局處理方式
- 局部處理方式```java@JSONField(serialzeFeatures= SerializerFeature.WriteEnumUsingToString)private UserStatus status;
實現 IEnum 接口
- 例:年齡使用枚舉
建立枚舉
entity中設置枚舉
使用
數據庫中數據爲":張三",3
json轉換後爲:"張三","THREE"
注意:age在set的時候須要設置枚舉而不是以前的Integer了,可是用戶能夠本身設置set方法,將傳入的Integer轉爲枚舉再賦值....