跳至主要內容

where进阶

xuejmnet2023/7/14大约 10 分钟

API

动态控制where生效!!!

如果第一个参数为true则表示需要执行当前where,否则就是不需要比如where(false,o->o.id().eq("123"))因为第一个参数为false那么整个where将不会生效,不填写第一个参数则视为当前where生效

方法描述
where(expression)传入表达式方法筛选数据集结果
whereObject(Object)传入一个对象来实现对当前对象解析后的where生成 筛选数据集结果
whereById(Object)传入一个id来实现对数据库集合的筛选,当前表必须是有且仅有一个主键的时候才可以否则将会抛错
whereByIds(array)传入一个id集合来实现对数据库集合的筛选,当前表必须是有且仅有一个主键的时候才可以否则将会抛错

说明!!!

whereObject具体参考DTO映射基础

结构化对象返回


@Data
@Table("t_topic")
@EntityProxy
@EasyAssertMessage("未找到主题信息")
@EasyAlias("t_topic")//添加这个注解那么plugin可以快速帮助你生成别名
@FieldNameConstants
public class Topic implements ProxyEntityAvailable<Topic, TopicProxy> {

    @Column(primaryKey = true)
    private String id;
    private Integer stars;
    private String title;
    private LocalDateTime createTime;
}

where(expression)

在表达式链式中您可以用单个where来描述当前表达式的筛选,当然您也可以用多个where来组合,多个where之间不存在select或者groupBy那么多个where之间会互相append,
其中where的入参表示当前表的一个别名变量如果您熟悉java的stream api或者dotnet的linq那么当前表达式您可以易如反掌的写出来

单表where

单表的where入参我们只会有一个当前表的别名用来描述当前表,因为有上下文的约束所以用户无法使用非当前表达式的其他表可以减少用户在编写dsl时候的很多心智问题


easyEntityQuery.queryable(Topic.class)
        .where(t_topic -> {
            t_topic.title().like("123");
            t_topic.stars().gt(1);
        }).toList();
//上下两个写法一样
easyEntityQuery.queryable(Topic.class)
        .where(t_topic -> {
            t_topic.title().like("123");
        })
        .where(t_topic -> {
            t_topic.stars().gt(1);
        }).toList();

//当然如果您的`where`里面只有一个条件那么大括号也可以省略(这是lambda的基本常识不做过多解释)

easyEntityQuery.queryable(Topic.class)
        .where(t_topic -> t_topic.title().like("123"))
        .where(t_topic -> t_topic.stars().gt(1)).toList();

多表where

多表的where入参个数有两个选择一个是1个入参表示主表,一个是n个入参顺序上分别表示主表+join表*n,join后的on也是一样的处理

easyEntityQuery.queryable(Topic.class)
        .leftJoin(BlogEntity.class,(t_topic, t_blog) -> {
            t_topic.id().eq(t_blog.id());
        })
        .where((t_topic, t_blog) -> {
            t_topic.title().like("123");
            t_blog.status().eq(1);
        }).toList();

动态条件

通过 springboot 上传 json 对象实现条件查询,目前有两种解决方案,一个是动态条件来构建 where,一个是通过 object 对象来实现动态查询

默认配置项

模式优点缺点
动态条件可以实现任意复杂条件构建对于大部分业务场景过于复杂
对象查询可以快速实现基于 dto 的条件查询条件仅支持 and,且属性名需要一致,不一致需要手动映射为一致

动态条件

框架提供了多种动态条件方式

  • if条件包裹
  • api 第一个参数boolean,where 第一个参数boolean
  • filterConfigure
对象模式

条件接受

1.4.31^以上版本支持ValueFilter 条件接收器,Queryable默认行为AnyValueFilter.DEFAULT所有的条件都接受,框架提供了一个可选NotNullOrEmptyValueFilter.DEFAULT当传入的条件参数值非 null 且字符串的情况下非空那么才会增加到条件里面,仅 where 条件生效。并且只有左侧是属性而非属性函数时才会生效如果左侧为函数那么将不会生效

如果存在隐式 join 那么2.3.0^版本可以做到更加智能的处理

3.0.46^版本新增NotNullOrEmptyValueFilter.DEFAULT_PROPAGATION_SUPPORTS支持传递到整个dsl包括隐式子查询和隐式groupJoin和隐式partation，如果用户需要自己实现可以通过实现接口由ValueFilter变成PropagationValueFilter

用户也可以自定义实现接口

public interface ValueFilter {
    boolean accept(TableAvailable table, String property, Object value);
}

public class AnyValueFilter implements ValueFilter {
    public static final ValueFilter DEFAULT=new AnyValueFilter();
    private AnyValueFilter(){

    }
    @Override
    public boolean accept(TableAvailable table, String property, Object value) {
        return true;
    }
}
public class NotNullOrEmptyValueFilter implements ValueFilter {
    public static final ValueFilter DEFAULT=new NotNullOrEmptyValueFilter();
    @Override
    public boolean accept(TableAvailable table, String property, Object value) {
        if(value==null){
            return false;
        }
        if(value instanceof String){
            return EasyStringUtil.isNotBlank((String) value);
        }
        return true;
    }
}
  String toSql = easyQuery
                .queryable(Topic.class)
                .leftJoin(BlogEntity.class, (t, t1) -> t.eq(t1, Topic::getId, BlogEntity::getId))
                .leftJoin(BlogEntity.class, (t,t1, t2) -> t.eq(t2, Topic::getId, BlogEntity::getId))
                .leftJoin(BlogEntity.class, (t, t1, t2, t3) -> t.eq(t3, Topic::getId, BlogEntity::getId))
                .filterConfigure(NotNullOrEmptyValueFilter.DEFAULT)//设置非null字符串非空 后续的where才会添加到条件中
                .where(o -> o.eq(Topic::getId, ""))
                //.filterConfigure(AnyValueFilter.DEFAULT)//恢复如果后面没有自定义where那么不需要恢复
                .limit(1, 2)
                .toSQL();
// SELECT t.`id`,t.`stars`,t.`title`,t.`create_time` FROM `t_topic` t
// LEFT JOIN `t_blog` t1 ON t1.`deleted` = ? AND t.`id` = t1.`id`
// LEFT JOIN `t_blog` t2 ON t2.`deleted` = ? AND t.`id` = t2.`id`
// LEFT JOIN `t_blog` t3 ON t3.`deleted` = ? AND t.`id` = t3.`id`
// LIMIT 2 OFFSET 1

条件拦截,加入我的 where 条件大部分都符合极个别不符合可以通过提前返回不符的来保证剩余的都可以进行

String id="";
String userName=null;
String nickname="BBB";
Boolean leftEnable=true;


    String sql = easyQuery.queryable(DefTable.class)
            .leftJoin(DefTableLeft1.class, (t, t1) -> t.eq(t1, DefTable::getId, DefTableLeft1::getDefId))
            .filterConfigure((t, p, v) -> {//分别是table，property，value
                if ("id".equals(p)) { //无论.eq(DefTable::getId, id) 这个方法属性为id的比较是啥结果都会添加到条件里面
                    return true;
                }
                return NotNullOrEmptyValueFilter.DEFAULT.accept(t, p, v);
            })
            .where((t, t1) -> t
                    .eq(DefTable::getId, id)//虽然id为空但是还是加入到了sql中
                    .eq(DefTable::getUserName, userName)
                    .eq(DefTable::getNickname, nickname)
                    .then(t1).eq(DefTableLeft1::getEnable, leftEnable)).toSQL();
// SELECT t.id,t.user_name,t.nickname,t.enable,t.score,t.mobile,t.avatar,t.number,t.status,t.created,t.options FROM t_def_table t
// LEFT JOIN t_def_table_left1 t1 ON t.id = t1.def_id
// WHERE t.id = ? AND t.nickname = ? AND t1.enable = ?

注意点及说明!!!

必须写到对应的where前面后续的where才会生效，用户可以自定义,比如满足的条件是优先满足eq、ge、gt等的第一个 boolean 条件,后续才会判断valueFilter，如果有多个where部分 where 需要自定义那么可以采用filterConfigure(AnyValueFilter.DEFAULT)来恢复到所有参数都接受,一般用于查询时可以少写很多判断

条件接受默认接口ValueFilter如果你自定义的直接实现这个那么同一个表达式的子查询则不会生效,依然需要你手动去处理,为了让同一个表达式的子查询生效,请使用PropagationValueFilter接口来实现这个接口相关操作,默认.filterConfigure(NotNullOrEmptyValueFilter.DEFAULT)可以改为.filterConfigure(NotNullOrEmptyValueFilter.DEFAULT_PROPAGATION_SUPPORTS)那么同一个表达式的子查询也会对其参数null或空的使用忽略模式。

注意点及说明!!!

什么是同一个表达式的子查询,就是非easyEntityQuerybean注入的子查询，譬如o.userList()....或者o.expression().subQueryable(xxx.class)这一类子查询我们认为是同一个表达式子查询,由easyEntityQuery.queryable(xxx.class)创建的我们认为是不同表达式的子查询这种子查询是独立配置

动态列

有时候我们的搜索不一定是动态是否生效有可能需要实现动态的列名处理,这边eq提供了任意列anyColumn需要eq2.6.2+

anyColumn(property)支持隐式join:比如o.anyColumn("user.age")等于o.user().age()


        List<DocBankCard> list = easyEntityQuery.queryable(DocBankCard.class)
                .where(bank_card -> {
                    bank_card.anyColumn("code").eq("456");
                    //上下两者写法一样
                    //bank_card.code().eq("321");
                }).toList();

相关搜索

注解查询 动态查询 json查询 对象查询 form查询 表单查询

贡献者

xuejiamingHoysing
默认页脚
Copyright © 2025 xuejmnet