mybatis plus條件拼接


來源: mybatis plus官網

mybatis plus條件拼接

條件構造器

說明:

  • 以下出現的第一個入參boolean condition表示該條件是否加入最后生成的sql中
  • 沒有標明condition的方法,默認為true
  • 以下出現的泛型Param均為Wrapper的子類實例(均具有AbstractWrapper的所有方法)
  • 以下方法在入參中出現的R為泛型,在普通wrapper中是String,在LambdaWrapper中是函數(例:Entity::getId,Entity為實體類,getId為字段idgetMethod)
  • 參數R column均表示數據庫字段,而不是實體類數據字段名!!!(字段名是數據庫關鍵字的自己用轉義符包裹!)!
  • 以下舉例均為使用普通wrapper,入參為MapList的均以json形式表現!
  • 使用中如果入參的Map或者List,則不會加入最后生成的sql中!!!
  • 有任何疑問就點開源碼看,看不懂函數點擊我學習新知識

警告:
不支持以及不贊成在 RPC 調用中把 Wrapper 進行傳輸(遠程調用)

  1. wrapper 很重
  2. 傳輸 wrapper 可以類比為你的 controller 用 map 接收值(開發一時爽,維護火葬場)
  3. 正確的 RPC 調用姿勢是寫一個 DTO 進行傳輸,被調用方再根據 DTO 執行相應的操作
  4. 我們拒絕接受任何關於 RPC 傳輸 Wrapper 報錯相關的 issue 甚至 pr

案例table

 
 
 
         
  1. CREATE TABLE `aaa_bbb_cc` (
  2. `ID` int(10) NOT NULL AUTO_INCREMENT,
  3. `aa_as` varchar(255) DEFAULT NULL,
  4. `ab_AAA` varchar(255) DEFAULT NULL,
  5. PRIMARY KEY (`ID`)
  6. ) ENGINE=InnoDB AUTO_INCREMENT=18 DEFAULT CHARSET=utf8;
 
 
 
         
  1. @Data
  2. @AllArgsConstructor
  3. @NoArgsConstructor
  4. public class AaaBbbCc implements Serializable {
  5. private static final long serialVersionUID = 1L;
  6. @TableId(value = "ID", type = IdType.AUTO)
  7. private Integer id;
  8. private String aaAs;
  9. @TableField("ab_AAA")
  10. private String abAaa;
  11. }

AbstractWrapper

說明:
QueryWrapper(LambdaQueryWrapper) 和 UpdateWrapper(LambdaUpdateWrapper) 的父類
用於生成 sql 的 where 條件, entity 屬性也用於生成 sql 的 where 條件
注意: entity 生成的 where 條件與 使用各個 api 生成的 where 條件沒有任何關聯行為

allEq:全部eq(或個別isNull)

 
 
 
         
  1. allEq(Map<R, V> params)
  2. allEq(Map<R, V> params, boolean null2IsNull)
  3. allEq(boolean condition, Map<R, V> params, boolean null2IsNull)
  4. allEq(BiPredicate<R, V> filter, Map<R, V> params)
  5. allEq(BiPredicate<R, V> filter, Map<R, V> params, boolean null2IsNull)
  6. allEq(boolean condition, BiPredicate<R, V> filter, Map<R, V> params, boolean null2IsNull)
  • 參數說明:
    params : key數據庫字段名(注意不是entity),value為字段值
    null2IsNull : 為true則在mapvaluenull時調用 isNull 方法,為false時則忽略valuenull
    filter : 過濾函數,是否允許字段傳入比對條件中

  • 案例

 
 
 
         
  1. Map<String,Object> stringTMap=new LinkedHashMap<>();
  2. stringTMap.put("ID",12 );
  3. stringTMap.put("aa_as",null);
  4. queryWrapper.allEq(stringTMap);//ID = ? AND aa_as IS NULL :null的直接is null
  5. queryWrapper.allEq(stringTMap,false);// WHERE ID = ? :null的不查詢
  6. queryWrapper.allEq(false,stringTMap,false);// condition為false,不拼接此查詢條件
  7. //x是字段,y是對應的值,使用Lambda表達式進行條件的校驗
  8. BiPredicate<String, Object> bi = (x, y) -> x .equals("ID");
  9. queryWrapper.allEq(bi,stringTMap);//WHERE ID = ?

eq:等於 =

 
 
 
         
  1. eq(R column, Object val)
  2. eq(boolean condition, R column, Object val)
  • 例: eq("name", "老王")--->name = '老王'

ne:不等於 <>

 
 
 
         
  1. ne(R column, Object val)
  2. ne(boolean condition, R column, Object val)
  • 例: ne("name", "老王")--->name <> '老王'

gt:大於 >

 
 
 
         
  1. gt(R column, Object val)
  2. gt(boolean condition, R column, Object val)
  • 例: gt("age", 18)--->age > 18

ge:大於等於 >=

 
 
 
         
  1. ge(R column, Object val)
  2. ge(boolean condition, R column, Object val)
  • 例: ge("age", 18)--->age >= 18

lt:小於 <

 
 
 
         
  1. lt(R column, Object val)
  2. lt(boolean condition, R column, Object val)
  • 例: lt("age", 18)--->age < 18

le:小於等於 <=

 
 
 
         
  1. le(R column, Object val)
  2. le(boolean condition, R column, Object val)
  • 例: le("age", 18)--->age <= 18

between:BETWEEN 值1 AND 值2

 
 
 
         
  1. between(R column, Object val1, Object val2)
  2. between(boolean condition, R column, Object val1, Object val2)
  • 例: between("age", 18, 30)--->age between 18 and 30

notBetween:NOT BETWEEN 值1 AND 值2

 
 
 
         
  1. notBetween(R column, Object val1, Object val2)
  2. notBetween(boolean condition, R column, Object val1, Object val2)
  • 例: notBetween("age", 18, 30)--->age not between 18 and 30

like:LIKE '%值%'

 
 
 
         
  1. like(R column, Object val)
  2. like(boolean condition, R column, Object val)
  • 例: like("name", "王")--->name like '%王%'

notLike:NOT LIKE '%值%'

 
 
 
         
  1. notLike(R column, Object val)
  2. notLike(boolean condition, R column, Object val)
  • 例: notLike("name", "王")--->name not like '%王%'

likeLeft:LIKE '%值'

 
 
 
         
  1. likeLeft(R column, Object val)
  2. likeLeft(boolean condition, R column, Object val)
  • 例: likeLeft("name", "王")--->name like '%王'

likeRight:LIKE '值%'

 
 
 
         
  1. likeRight(R column, Object val)
  2. likeRight(boolean condition, R column, Object val)
  • 例: likeRight("name", "王")--->name like '王%'

isNull:字段 IS NULL

 
 
 
         
  1. isNull(R column)
  2. isNull(boolean condition, R column)
  • 例: isNull("name")--->name is null

isNotNull: 字段 IS NULL

 
 
 
         
  1. isNotNull(R column)
  2. isNotNull(boolean condition, R column)
  • 例: isNotNull("name")--->name is not null

in:字段 IN

 
 
 
         
  1. in(R column, Collection<?> value)
  2. in(boolean condition, R column, Collection<?> value)
  • 字段 IN (value.get(0), value.get(1), ...)
  • 例: in("age",{1,2,3})--->age in (1,2,3)
 
 
 
         
  1. in(R column, Object... values)
  2. in(boolean condition, R column, Object... values)
  • 字段 IN (v0, v1, ...)
  • 例: in("age", 1, 2, 3)--->age in (1,2,3)

notIn:字段 NOT IN

 
 
 
         
  1. notIn(R column, Collection<?> value)
  2. 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)
 
 
 
         
  1. notIn(R column, Object... values)
  2. 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語句 )

 
 
 
         
  1. inSql(R column, String inValue)
  2. 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語句 )

 
 
 
         
  1. notInSql(R column, String inValue)
  2. 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 字段, ...

 
 
 
         
  1. groupBy(R... columns)
  2. groupBy(boolean condition, R... columns)
  • 例: groupBy("id", "name")--->group by id,name

orderByAsc:排序:ORDER BY 字段, ... ASC

 
 
 
         
  1. orderByAsc(R... columns)
  2. orderByAsc(boolean condition, R... columns)
  • 例: orderByAsc("id", "name")--->order by id ASC,name ASC

orderByDesc 排序:ORDER BY 字段, ... DESC

 
 
 
         
  1. orderByDesc(R... columns)
  2. orderByDesc(boolean condition, R... columns)
  • 例: orderByDesc("id", "name")--->order by id DESC,name DESC

orderBy:排序:ORDER BY 字段, ...

 
 
 
         
  1. orderBy(boolean condition, boolean isAsc, R... columns)
  • 排序:ORDER BY 字段, ...
  • 例: orderBy(true, true, "id", "name")--->order by id ASC,name ASC
 
 
 
         
  1. queryWrapper.orderByAsc("aa_as");
  2. queryWrapper.orderByDesc("ab_AAA");
  3. //ORDER BY aa_as ASC , ab_AAA DESC

having:HAVING ( sql語句 )

 
 
 
         
  1. having(String sqlHaving, Object... params)
  2. 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

 
 
 
         
  1. or()
  2. or(boolean condition)

注意事項:
主動調用or表示緊接着下一個方法不是用and連接!(不調用or則默認為使用and連接)

  • 例: eq("id",1).or().eq("name","老王")--->id = 1 or name = '老王'
 
 
 
         
  1. or(Function<Param, Param> func)
  2. or(boolean condition, Function<Param, Param> func)
  • OR 嵌套
  • 例: or(i -> i.eq("name", "李白").ne("status", "活着"))--->or (name = '李白' and status <> '活着')
 
 
 
         
  1. queryWrapper.eq("ID" ,13 );
  2. queryWrapper.or();
  3. queryWrapper.eq("ID" ,14);
  4. queryWrapper.ne("aa_as","rtget" );
  5. //ID = ? OR (ID = ? AND aa_as <> ?)
  6. 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)
  7. //WHERE ID = ? OR ( ID = ? AND aa_as <> ? ) OR ( aa_as = ? )

and:AND 嵌套

 
 
 
         
  1. and(Function<Param, Param> func)
  2. and(boolean condition, Function<Param, Param> func)
  • 例: and(i -> i.eq("name", "李白").ne("status", "活着"))--->and (name = '李白' and status <> '活着')

nested:正常嵌套 不帶 AND 或者 OR

 
 
 
         
  1. nested(Function<Param, Param> func)
  2. nested(boolean condition, Function<Param, Param> func)
  • 例: nested(i -> i.eq("name", "李白").ne("status", "活着"))--->(name = '李白' and status <> '活着')

apply:拼接 sql

 
 
 
         
  1. apply(String applySql, Object... params)
  2. 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'")

last:無視優化規則直接拼接到 sql 的最后

 
 
 
         
  1. last(String lastSql)
  2. last(boolean condition, String lastSql)

注意事項:
只能調用一次,多次調用以最后一次為准
有sql注入的風險,請謹慎使用

  • 例: last("limit 1")

exists:拼接 EXISTS ( sql語句 )

 
 
 
         
  1. exists(String existsSql)
  2. 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語句 )

 
 
 
         
  1. notExists(String notExistsSql)
  2. 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() 方法獲取

select:設置查詢字段

 
 
 
         
  1. select(String... sqlSelect)
  2. select(Predicate<TableFieldInfo> predicate)
  3. 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

 
 
 
         
  1. set(String column, Object val)
  2. set(boolean condition, String column, Object val)
  • SQL SET 字段
  • 例: set("name", "老李頭")
  • 例: set("name", "")--->數據庫字段值變為空字符串
  • 例: set("name", null)--->數據庫字段值變為null

setSql:設置 SET 部分 SQL

 
 
 
         
  1. 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

 
 
 
         
  1. mysqlMapper.getAll(Wrappers.<MysqlData>lambdaQuery().eq(MysqlData::getGroup, 1));

方案一 注解方式 Mapper.java

 
 
 
         
  1. @Select("select * from mysql_data ${ew.customSqlSegment}")
  2. List<MysqlData> getAll(@Param(Constants.WRAPPER) Wrapper wrapper);

方案二 XML形式 Mapper.xml

 
 
 
         
  1. <select id="getAll" resultType="MysqlData">
  2. SELECT * FROM mysql_data ${ew.customSqlSegment}
  3. </select>

分頁查詢

mybatis plus提供了分頁功能,可以輕松實現分頁;

 
 
 
         
  1. //設置查詢參數
  2. Page<AaaBbbCc> page=new Page<>();
  3. page.setCurrent(1);
  4. page.setSize(2);
  5. //開始查詢
  6. IPage<AaaBbbCc> page2 = aaaBbbCcDao.page(page);
  7. /**
  8. getCurrent():當前頁數;
  9. getPages():總頁數;
  10. getSize():查詢數量;
  11. getTotal():總數量;
  12. getRecords():查詢結果;
  13. 若是當前頁>總頁數,返回[];
  14. 若是當前頁數<1,查詢第一頁數據;
  15. */

自定義SQL查詢分頁數據

  • Page<T> page 參數設置為查詢的第一個參數,不需要拼接分頁查詢條件,mybatis plus會自動執行分頁查詢;
  • 例:
 
 
 
         
  1. /**
  2. * <p>
  3. * 查詢 : 根據state狀態查詢用戶列表,分頁顯示
  4. * 注意!!: 如果入參是有多個,需要加注解指定參數名才能在xml中取值
  5. * </p>
  6. *
  7. * @param page 分頁對象,xml中可以從里面進行取值,傳遞參數 Page 即自動分頁,必須放在第一位(你可以繼承Page實現自己的分頁對象)
  8. * @param state 狀態
  9. * @return 分頁對象
  10. */
  11. @Select("SELECT id,name FROM user WHERE state=#{state}")
  12. 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
 
 
 
         
  1. mybatis-plus:
  2. global-config:
  3. db-config:
  4. logic-delete-value: 0 # 邏輯已刪除值(默認為 1)
  5. logic-not-delete-value: 1 # 邏輯未刪除值(默認為 0)
  • entity
 
 
 
         
  1. //在代表刪除的字段上添加注解:
  2. @TableLogic
  3. private Integer enable;

使用

 
 
 
         
  1. //默認在查詢的時候就會拼接上enable的條件
  2. dao.list();//where enable=1

注意,此查詢條件不會被覆蓋,使用功能需謹慎

 
 
 
         
  1. //若是想要查詢已經刪除的數據,將無法查詢....
  2. queryWrapper.eq("enable","0" );
  3. dao.list(queryWrapper);//WHERE enable=1 AND enable = 0

所以還是自己寫吧o(╥﹏╥)o

枚舉

自3.1.0開始,可配置默認枚舉處理類來省略掃描通用枚舉配置,3.1.0之前和之后的配置是不同的,我們就不研究3.1.0之前的使用方法了(#^.^#)

配置

  • 掃描通用枚舉
 
 
 
         
  1. mybatis-plus:
  2. # 支持統配符 * 或者 ; 分割
  3. typeEnumsPackage: com.baomidou.springboot.entity.enums,自定義枚舉
  • entity配置/JSON序列化處理
    • Jackson
 
 
 
         
  1. 在需要響應描述字段的get方法上添加@JsonValue注解即可
  • Fastjson
    • 全局處理方式
      ```java
      FastJsonConfig config = new FastJsonConfig();
      //設置WriteEnumUsingToString
      config.setSerializerFeatures(SerializerFeature.WriteEnumUsingToString);
      converter.setFastJsonConfig(config);
 
 
 
         
  1. - 局部處理方式
  2. ```java
  3. @JSONField(serialzeFeatures= SerializerFeature.WriteEnumUsingToString)
  4. private UserStatus status;

實現 IEnum 接口

  • 例:年齡使用枚舉
    • 創建枚舉

           
           
           
                   
      1. @AllArgsConstructor
      2. public enum AgeEnum implements IEnum<Integer> {
      3. ONE(1, "一歲"),
      4. TWO(2, "二歲"),
      5. THREE(3, "三歲");
      6. private int value;
      7. private String desc;
      8. @Override
      9. public Integer getValue() {
      10. return this.value;
      11. }
      12. public String geDesc() {
      13. return this.desc;
      14. }
      15. }
    • entity中設置枚舉

           
           
           
                   
      1. public class User{
      2. /**
      3. * 名字
      4. * 數據庫字段: name varchar(20)
      5. */
      6. private String name;
      7. /**
      8. * 年齡,IEnum接口的枚舉處理
      9. * 數據庫字段:age INT(3)
      10. */
      11. private AgeEnum age;
      12. }

使用

數據庫中數據為":張三",3
json轉換后為:"張三","THREE"

注意:age在set的時候需要設置枚舉而不是之前的Integer了,但是用戶可以自己設置set方法,將傳入的Integer轉為枚舉再賦值....






免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM