com.github.rexsheng.mybatis.extension

类 TableQueryBuilder<T>

java.lang.Object

com.github.rexsheng.mybatis.extension.EntityInfo<T>

com.github.rexsheng.mybatis.extension.TableQueryBuilder<T>

直接已知子类:

TableDeleteBuilder, TableUpdateBuilder

public class TableQueryBuilder<T>
extends EntityInfo<T>

作者:

RexSheng 2020年8月27日 下午8:07:18

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	TableQueryBuilder.JoinTableConditionInternal<L,R>

构造器概要

构造器

构造器和说明
TableQueryBuilder(Class<T> clazz)
TableQueryBuilder(Class<T> clazz, String tableName)

方法概要

限定符和类型	方法和说明
ConditionBuilder<T>	and()
QueryBuilder<T>	build()
<Z> QueryBuilder<Z>	build(Class<Z> outputClazz)
TableQueryBuilder<T>	distinct() distinct
static <T> TableQueryBuilder<T>	from(Class<T> clazz)
static <T> TableQueryBuilder<T>	from(Class<T> clazz, String tableName)
List<ConditionBuilder<T>>	getConditions()
Boolean	getDistinct()
Integer	getEndIndex() 获取截止序号
List<ColumnQueryBuilder<T>>	getGroupByColumns()
List<ConditionBuilder<T>>	getHavingConditions()
List<TableQueryBuilder.JoinTableConditionInternal<T,?>>	getJoinList()
List<ColumnQueryBuilder<T>>	getOrderByColumns()
Integer	getPageIndex()
Integer	getPageSize()
List<ColumnQueryBuilder<T>>	getSelectColumns()
Integer	getSkipSize()
Integer	getStartIndex() 获取开始序号
Boolean	getTemporarySkipSelectIfCountZero()
Boolean	getTotalCountEnabled() 是否在执行列表查询中同时计算总条数
long	getTotalItemCount()
TableQueryBuilder<T>	groupBy(SFunction<T,Object> field)
TableQueryBuilder<T>	groupBy(String columnName)
TableQueryBuilder<T>	having(String aggregationType, java.util.function.Consumer<ConditionBuilder<T>> field) 自定义聚合函数操作
TableQueryBuilder<T>	havingAvg(java.util.function.Consumer<ConditionBuilder<T>> field)
TableQueryBuilder<T>	havingCount(java.util.function.Consumer<ConditionBuilder<T>> field)
TableQueryBuilder<T>	havingMax(java.util.function.Consumer<ConditionBuilder<T>> field)
TableQueryBuilder<T>	havingMin(java.util.function.Consumer<ConditionBuilder<T>> field)
TableQueryBuilder<T>	havingSum(java.util.function.Consumer<ConditionBuilder<T>> field)
<R> JoinConditionBuilder<T,R>	innerJoin(TableQueryBuilder<R> relation)
<R> JoinConditionBuilder<T,R>	join(TableQueryBuilder<R> relation)
<R> JoinConditionBuilder<T,R>	leftJoin(TableQueryBuilder<R> relation)
ConditionBuilder<T>	or()
TableQueryBuilder<T>	orderBy(SFunction<T,Object> field)
TableQueryBuilder<T>	orderBy(String columnName)
TableQueryBuilder<T>	orderByAggregation(SFunction<T,Object> field, String aggregationType)
TableQueryBuilder<T>	orderByAggregation(String columnName, String aggregationType)
TableQueryBuilder<T>	orderByAggregationDesc(SFunction<T,Object> field, String aggregationType)
TableQueryBuilder<T>	orderByAggregationDesc(String columnName, String aggregationType)
TableQueryBuilder<T>	orderByAvg(SFunction<T,Object> field)
TableQueryBuilder<T>	orderByAvg(String columnName)
TableQueryBuilder<T>	orderByAvgDesc(SFunction<T,Object> field)
TableQueryBuilder<T>	orderByAvgDesc(String columnName)
TableQueryBuilder<T>	orderByCount(SFunction<T,Object> field)
TableQueryBuilder<T>	orderByCount(String columnName)
TableQueryBuilder<T>	orderByCountDesc(SFunction<T,Object> field)
TableQueryBuilder<T>	orderByCountDesc(String columnName)
TableQueryBuilder<T>	orderByDesc(SFunction<T,Object> field)
TableQueryBuilder<T>	orderByDesc(String columnName)
TableQueryBuilder<T>	orderByMax(SFunction<T,Object> field)
TableQueryBuilder<T>	orderByMax(String columnName)
TableQueryBuilder<T>	orderByMaxDesc(SFunction<T,Object> field)
TableQueryBuilder<T>	orderByMaxDesc(String columnName)
TableQueryBuilder<T>	orderByMin(SFunction<T,Object> field)
TableQueryBuilder<T>	orderByMin(String columnName)
TableQueryBuilder<T>	orderByMinDesc(SFunction<T,Object> field)
TableQueryBuilder<T>	orderByMinDesc(String columnName)
TableQueryBuilder<T>	orderBySum(SFunction<T,Object> field)
TableQueryBuilder<T>	orderBySum(String columnName)
TableQueryBuilder<T>	orderBySumDesc(SFunction<T,Object> field)
TableQueryBuilder<T>	orderBySumDesc(String columnName)
TableQueryBuilder<T>	page(int pageIndex, int pageSize)
TableQueryBuilder<T>	page(IPageInput page)
<R> JoinConditionBuilder<T,R>	rightJoin(TableQueryBuilder<R> relation)
TableQueryBuilder<T>	select(java.util.function.Predicate<Field> filter) 查询满足条件的字段 same as selectField(Predicate)}
TableQueryBuilder<T>	select(SFunction<T,Object>... fields)
TableQueryBuilder<T>	selectAll()
TableQueryBuilder<T>	selectAs(SFunction<T,Object> field, String aliasName)
TableQueryBuilder<T>	selectAs(String columnName, String aliasName)
TableQueryBuilder<T>	selectCount(SFunction<T,Object> field, String aliasName)
TableQueryBuilder<T>	selectCount(String columnName, String aliasName)
TableQueryBuilder<T>	selectExcept(java.util.function.Predicate<Field> filter) 查询不满足条件的字段
TableQueryBuilder<T>	selectField(java.util.function.Predicate<Field> filter) 查询满足条件的字段
TableQueryBuilder<T>	selectMax(SFunction<T,Object> field, String aliasName)
TableQueryBuilder<T>	selectMax(String columnName, String aliasName)
TableQueryBuilder<T>	selectMin(SFunction<T,Object> field, String aliasName)
TableQueryBuilder<T>	selectMin(String columnName, String aliasName)
TableQueryBuilder<T>	selectSum(SFunction<T,Object> field, String aliasName)
TableQueryBuilder<T>	selectSum(String columnName, String aliasName)
void	setTotalItemCount(long totalItemCount)
TableQueryBuilder<T>	skip(int skipSize)
TableQueryBuilder<T>	take(int pageSize)
TableQueryBuilder<T>	totalCountEnabled() 允许在查询过程中同时计算影响的总行数 用于分页计算总条数，执行查询后调用方法getTotalItemCount()来获取总条数 代码示例： int pageIndex=1; //要查询的页码 int pageSize=10; //页大小 TableQueryBuilder<AuthUser> query=TableQueryBuilder.from(AuthUser.class); query.selectAll().page(pageIndex, pageSize) .totalCountEnabled() //注意必须调用此方法，否则下方query.getTotalItemCount()无法获取总条数 .where().gt(AuthUser::getUserId, 0); List<AuthUser> userList=dao.selectByBuilder(query.build()); PagedList<AuthUser> pagedList=new PagedList<>(userList,pageIndex,pageSize,query.getTotalItemCount()); logger.info(objectMapper.writeValueAsString(pagedList));
TableQueryBuilder<T>	totalCountEnabled(Boolean skipSelectIfCountZero) 允许在查询过程中同时计算影响的总行数
ConditionBuilder<T>	where()

从类继承的方法 com.github.rexsheng.mybatis.extension.EntityInfo

getEntityClass, getTableName, setEntityClass, setTableName

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

TableQueryBuilder

public TableQueryBuilder(Class<T> clazz)

TableQueryBuilder

public TableQueryBuilder(Class<T> clazz,
                         String tableName)

方法详细资料

from

public static <T> TableQueryBuilder<T> from(Class<T> clazz)

from

public static <T> TableQueryBuilder<T> from(Class<T> clazz,
                                            String tableName)

distinct

public TableQueryBuilder<T> distinct()

distinct

返回:

Boolean

从以下版本开始:

1.2.0

selectAll

public TableQueryBuilder<T> selectAll()

select

public TableQueryBuilder<T> select(java.util.function.Predicate<Field> filter)

查询满足条件的字段 same as selectField(Predicate)}

参数:

filter - 满足的条件

返回:

当前条件

selectField

public TableQueryBuilder<T> selectField(java.util.function.Predicate<Field> filter)

查询满足条件的字段

参数:

filter - 满足的条件

返回:

当前条件

从以下版本开始:

1.2.2

selectExcept

public TableQueryBuilder<T> selectExcept(java.util.function.Predicate<Field> filter)

查询不满足条件的字段

参数:

filter - 要排除的字段满足的条件

返回:

当前条件

从以下版本开始:

1.2.2

select

@SafeVarargs
public final TableQueryBuilder<T> select(SFunction<T,Object>... fields)

selectAs

public TableQueryBuilder<T> selectAs(SFunction<T,Object> field,
                                     String aliasName)

selectAs

public TableQueryBuilder<T> selectAs(String columnName,
                                     String aliasName)

selectSum

public TableQueryBuilder<T> selectSum(SFunction<T,Object> field,
                                      String aliasName)

selectSum

public TableQueryBuilder<T> selectSum(String columnName,
                                      String aliasName)

selectCount

public TableQueryBuilder<T> selectCount(SFunction<T,Object> field,
                                        String aliasName)

selectCount

public TableQueryBuilder<T> selectCount(String columnName,
                                        String aliasName)

selectMax

public TableQueryBuilder<T> selectMax(SFunction<T,Object> field,
                                      String aliasName)

selectMax

public TableQueryBuilder<T> selectMax(String columnName,
                                      String aliasName)

selectMin

public TableQueryBuilder<T> selectMin(SFunction<T,Object> field,
                                      String aliasName)

selectMin

public TableQueryBuilder<T> selectMin(String columnName,
                                      String aliasName)

groupBy

public TableQueryBuilder<T> groupBy(SFunction<T,Object> field)

groupBy

public TableQueryBuilder<T> groupBy(String columnName)

havingSum

public TableQueryBuilder<T> havingSum(java.util.function.Consumer<ConditionBuilder<T>> field)

havingCount

public TableQueryBuilder<T> havingCount(java.util.function.Consumer<ConditionBuilder<T>> field)

havingMax

public TableQueryBuilder<T> havingMax(java.util.function.Consumer<ConditionBuilder<T>> field)

havingMin

public TableQueryBuilder<T> havingMin(java.util.function.Consumer<ConditionBuilder<T>> field)

havingAvg

public TableQueryBuilder<T> havingAvg(java.util.function.Consumer<ConditionBuilder<T>> field)

having

public TableQueryBuilder<T> having(String aggregationType,
                                   java.util.function.Consumer<ConditionBuilder<T>> field)

自定义聚合函数操作

参数:

aggregationType - 聚合类型，例如SUM,AVG,COUNT等

field - 条件构造器

返回:

当前条件

where

public ConditionBuilder<T> where()

and

public ConditionBuilder<T> and()

or

public ConditionBuilder<T> or()

leftJoin

public <R> JoinConditionBuilder<T,R> leftJoin(TableQueryBuilder<R> relation)

rightJoin

public <R> JoinConditionBuilder<T,R> rightJoin(TableQueryBuilder<R> relation)

innerJoin

public <R> JoinConditionBuilder<T,R> innerJoin(TableQueryBuilder<R> relation)

join

public <R> JoinConditionBuilder<T,R> join(TableQueryBuilder<R> relation)

orderBy

public TableQueryBuilder<T> orderBy(SFunction<T,Object> field)

orderBy

public TableQueryBuilder<T> orderBy(String columnName)

orderByDesc

public TableQueryBuilder<T> orderByDesc(SFunction<T,Object> field)

orderByDesc

public TableQueryBuilder<T> orderByDesc(String columnName)

orderBySum

public TableQueryBuilder<T> orderBySum(SFunction<T,Object> field)

orderBySum

public TableQueryBuilder<T> orderBySum(String columnName)

orderBySumDesc

public TableQueryBuilder<T> orderBySumDesc(SFunction<T,Object> field)

orderBySumDesc

public TableQueryBuilder<T> orderBySumDesc(String columnName)

orderByCount

public TableQueryBuilder<T> orderByCount(SFunction<T,Object> field)

orderByCount

public TableQueryBuilder<T> orderByCount(String columnName)

orderByCountDesc

public TableQueryBuilder<T> orderByCountDesc(SFunction<T,Object> field)

orderByCountDesc

public TableQueryBuilder<T> orderByCountDesc(String columnName)

orderByMax

public TableQueryBuilder<T> orderByMax(SFunction<T,Object> field)

orderByMax

public TableQueryBuilder<T> orderByMax(String columnName)

orderByMaxDesc

public TableQueryBuilder<T> orderByMaxDesc(SFunction<T,Object> field)

orderByMaxDesc

public TableQueryBuilder<T> orderByMaxDesc(String columnName)

orderByMin

public TableQueryBuilder<T> orderByMin(SFunction<T,Object> field)

orderByMin

public TableQueryBuilder<T> orderByMin(String columnName)

orderByMinDesc

public TableQueryBuilder<T> orderByMinDesc(SFunction<T,Object> field)

orderByMinDesc

public TableQueryBuilder<T> orderByMinDesc(String columnName)

orderByAvg

public TableQueryBuilder<T> orderByAvg(SFunction<T,Object> field)

orderByAvg

public TableQueryBuilder<T> orderByAvg(String columnName)

orderByAvgDesc

public TableQueryBuilder<T> orderByAvgDesc(SFunction<T,Object> field)

orderByAvgDesc

public TableQueryBuilder<T> orderByAvgDesc(String columnName)

orderByAggregation

public TableQueryBuilder<T> orderByAggregation(SFunction<T,Object> field,
                                               String aggregationType)

orderByAggregation

public TableQueryBuilder<T> orderByAggregation(String columnName,
                                               String aggregationType)

orderByAggregationDesc

public TableQueryBuilder<T> orderByAggregationDesc(SFunction<T,Object> field,
                                                   String aggregationType)

orderByAggregationDesc

public TableQueryBuilder<T> orderByAggregationDesc(String columnName,
                                                   String aggregationType)

page

public TableQueryBuilder<T> page(IPageInput page)

page

public TableQueryBuilder<T> page(int pageIndex,
                                 int pageSize)

take

public TableQueryBuilder<T> take(int pageSize)

skip

public TableQueryBuilder<T> skip(int skipSize)

build

public QueryBuilder<T> build()

build

public <Z> QueryBuilder<Z> build(Class<Z> outputClazz)

getConditions

public List<ConditionBuilder<T>> getConditions()

getSelectColumns

public List<ColumnQueryBuilder<T>> getSelectColumns()

getJoinList

public List<TableQueryBuilder.JoinTableConditionInternal<T,?>> getJoinList()

getGroupByColumns

public List<ColumnQueryBuilder<T>> getGroupByColumns()

getHavingConditions

public List<ConditionBuilder<T>> getHavingConditions()

getSkipSize

public Integer getSkipSize()

getStartIndex

public Integer getStartIndex()

获取开始序号

返回:

开始序号

从以下版本开始:

1.2.0

getEndIndex

public Integer getEndIndex()

获取截止序号

返回:

截止序号

从以下版本开始:

1.2.0

getPageSize

public Integer getPageSize()

getPageIndex

public Integer getPageIndex()

getOrderByColumns

public List<ColumnQueryBuilder<T>> getOrderByColumns()

getTotalItemCount

public long getTotalItemCount()

setTotalItemCount

public void setTotalItemCount(long totalItemCount)

getTotalCountEnabled

public Boolean getTotalCountEnabled()

是否在执行列表查询中同时计算总条数

返回:

true是，false否

另请参阅:

totalCountEnabled()

totalCountEnabled

public TableQueryBuilder<T> totalCountEnabled()

允许在查询过程中同时计算影响的总行数 用于分页计算总条数，执行查询后调用方法getTotalItemCount()来获取总条数

代码示例：

 int pageIndex=1; //要查询的页码
 int pageSize=10; //页大小
 TableQueryBuilder<AuthUser> query=TableQueryBuilder.from(AuthUser.class);
 query.selectAll().page(pageIndex, pageSize)
 .totalCountEnabled() //注意必须调用此方法，否则下方query.getTotalItemCount()无法获取总条数
 .where().gt(AuthUser::getUserId, 0);
 List<AuthUser> userList=dao.selectByBuilder(query.build());
 PagedList<AuthUser> pagedList=new PagedList<>(userList,pageIndex,pageSize,query.getTotalItemCount());
 logger.info(objectMapper.writeValueAsString(pagedList));
 

返回:

当前条件

totalCountEnabled

public TableQueryBuilder<T> totalCountEnabled(Boolean skipSelectIfCountZero)

允许在查询过程中同时计算影响的总行数

参数:

skipSelectIfCountZero - 是否在总行数为0时，继续执行原有查询，忽略全局配置IDatabaseDialect.skipSelectIfCountZero()

返回:

当前条件

从以下版本开始:

1.3.0

getDistinct

public Boolean getDistinct()

getTemporarySkipSelectIfCountZero

public Boolean getTemporarySkipSelectIfCountZero()