mybatis plus条件拼接

来源: mybatis plus官网html

mybatis plus条件拼接

条件构造器

说明:java

  • 如下出现的第一个入参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 进行传输(远程调用)mysql

  1. wrapper 很重
  2. 传输 wrapper 能够类比为你的 controller 用 map 接收值(开发一时爽,维护火葬场)
  3. 正确的 RPC 调用姿式是写一个 DTO 进行传输,被调用方再根据 DTO 执行相应的操做
  4. 咱们拒绝接受任何关于 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则在mapvaluenull时调用 isNull 方法,为false时则忽略valuenull
    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 接口

  • 例:年龄使用枚举
    • 建立枚举

           
           
            
            
                     
            
            
      @AllArgsConstructorpublic enum AgeEnum implements IEnum<Integer> { ONE(1, "一岁"), TWO(2, "二岁"), THREE(3, "三岁"); private int value; private String desc; @Override public Integer getValue() { return this.value; } public String geDesc() { return this.desc; }}
    • entity中设置枚举

           
           
            
            
                     
            
            
      public class User{ /** * 名字 * 数据库字段: name varchar(20) */ private String name; /** * 年龄,IEnum接口的枚举处理 * 数据库字段:age INT(3) */ private AgeEnum age;}

使用

数据库中数据为":张三",3
json转换后为:"张三","THREE"

注意:age在set的时候须要设置枚举而不是以前的Integer了,可是用户能够本身设置set方法,将传入的Integer转为枚举再赋值....



相关文章
相关标签/搜索