动态SQL条件

说明

hsweb定义了一种支持动态条件的数据结构:

{  //where name like 张%
    terms:[
        {
            column:"name", //属性名或者列名
            value:"张", //值,为null或者为""时,此条件将被忽略
            type:"and", // 连接类型,and 或者 or
            termType:"like", // like
            options:["startWith"], //可选项,不同的termType支持不同.
            terms:[
                //嵌套,结构同上
                
            ]
        }
    ]
}

对应的Java类有: QueryParamEntity，UpdateParamEntity，DeleteParamEntity

DSL

hsweb提供了通过DSL的方式来构造上述结构，用例:

如果继承了GenericEntityService的类可以直接使用DSL进行查询,修改,删除操作

//select * from table where name = ? limit 0,20
createQuery().where("name",name).list()
// select * from table where name like ?||'%';
// 构造并调用其他的dao
DefaultDSLQueryService.createQuery(userDao)
                .where("name$like$startWith",name)
                .listNoPaging();

上述例子中 name$like$startWith的含义: name(列), like(条件),startWith(条件选项)

默认支持的SQL条件

termType	SQL	DSL	说明
is 或者 eq	=	.is()	等于
not	!=	.not()	不等于
gt	>	.gt()	大于
lt	<	.lt()	小于
gte	>=	.gte()	大于等于
lte	<=	.lte()	小于等于
like	like	.like()	模糊匹配.支持options reverse 反转，如: ? like name startWith: like ?||% endWith: like %||?
nlike	not like	.notLike()	同like
in	in	.in()	值可以为以下格式: 1,2,3,4 字符串以半角逗号分割. [1,2,3,4] 集合.
nin	not in	.notIn()	同in
isnull	is null	.isNull()	为null
notnull	not null	.notNull()	不为null
empty	= ''	.isEmpty()	为空字符
nempty	!=''	.notEmpty()	不为字符
bwt	between	.between()	在之间
nbwt	not between	.notBetween	不在之间

自定义SQL条件

上述默认支持的SQL条件其实就是用来定义列与条件的拼接方式。在某些场景，我们可能需要定义一些通用的查询条件。

例如： 根据部门ID 查询所有此部门下所有人员的数据，而且有很多功能都要使用此条件。

按照以前的方式，需要在各个需要使用此查询条件的功能里 添加Dao方法或者修改查询配置

hsweb提供了SQL条件的拓展功能，用于添加特殊的查询条件。让自定义的条件用起来就像 like ,> , <一样方便。

创建拓展类

//AbstractSqlTermCustomer提供了一些便利的方法
@org.springframework.stereotype.Component //注入到spring自动开启支持此条件
public class UserInDepartmentTerm extends AbstractSqlTermCustomizer{

    @Override
    public String getTermType() {
        //对应Term参数中的属性termType
        return "user-in-dept";
    }

    @Override
    public Dialect[] forDialect() {
        //对特定对数据库类型生效,返回null时对全部支持对数据库类型生效
        return null;
    }

    @Override
    public SqlAppender accept(String wherePrefix, Term term, RDBColumnMetaData column, String tableAlias) {
        //当传入了my-term条件对时候,会调用此方法进行拼接
        //对传入对参数进行转换,此步骤为必须的
       ChangedTermValue termValue =createChangedValue(term);
        
       //转换参数,将参数转为集合,以支持in查询. 
       List<Object> idList = BoostTermTypeMapper.convertList(column, termValue.getOld());
        
       SqlAppender appender=  new SqlAppender();
      
       appender.add(createColumnName(column,tableAlias),"in (select user_id from user_department where t_id");
        
        //根据参数的数量,构造对应的=或者in条件
       Object newValue= appendCondition(idList,wherePrefix,appender);
        
       appender.add(")");
       //设置新的值到条件中
       termValue.setValue(newValue);
        
        return appender;
    }
}

使用:

// where user_id in(select user_id from user_department where t_id = ? )
createQuery().where("userId$user-in-dept","test")

这样，无需修改其他任何配置，即可支持查询任何表里指定部门下用户的数据了。

在组织架构功能中,提供了一些已经拓展好的SQL条件。