io.jboot.db.model

类 Columns

java.lang.Object

io.jboot.db.model.Columns

所有已实现的接口:

Serializable

public class Columns
extends Object
implements Serializable

Column 的工具类，用于方便组装sql

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
private List<Column>	cols
static Columns	EMPTY
private static char	SQL_CACHE_SEPARATOR
private boolean	useSafeMode 在很多场景下，只会根据字段来查询，如果字段值为 null 的情况，Columns 会直接忽略 null 值，此时会造成结果不准确的情况 比如 ： ``` public ShopInfo findFirstByAccountId(BigInteger accountId) { return findFirstByColumns(Columns.create("account_id", accountId)); } ``` 根据账户 id 来查询该账户对应的 ShopInfo，此时 如果传入 null 值，则返回了 第一个 ShopInfo，这个 ShopInfo 可能并不是该账户的。

构造器概要

构造器

构造器和说明
Columns()

方法概要

限定符和类型	方法和说明
Columns	add(Column column) add new column in Columns
Columns	add(Columns columns) add Columns
Columns	addToFirst(Column column) add new column in Columns
Columns	addToFirst(Columns columns) add Columns To First
Columns	append(Columns columns) 追加 新的 columns
Columns	appendIf(Columns columns, Boolean condition) 追加 新的 columns
Columns	between(String name, Object start, Object end) between
private void	buildCacheKey(StringBuilder s, List<Column> columns)
boolean	containsName(String name)
static Columns	create()
static Columns	create(Column column)
static Columns	create(List<Column> columns)
static Columns	create(String name, Object value)
Columns	eq(String name, Object value) equals
Columns	ge(String name, Object value) 大于等于 great or equal
String	getCacheKey()
List<Column>	getList()
private static String	getLogicString(String logic)
Object[]	getValueArray()
Columns	group(Columns columns) group
Columns	groupBy(String name)
Columns	groupIf(Columns columns, Boolean condition)
Columns	gt(String name, Object value) 大于 great than
Columns	having(Columns columns)
Columns	having(String name)
Columns	having(String sql, Object... paras)
Columns	in(String name, Collection<?> collection) in Collection
Columns	in(String name, Object... arrays) in arrays
boolean	isEmpty()
Columns	isNotNull(String name) IS NOT NULL
Columns	isNotNullIf(String name, Boolean condition) IS NOT NULL
Columns	isNull(String name) IS NULL
Columns	isNullIf(String name, Boolean condition)
boolean	isUseSafeMode()
Columns	le(String name, Object value) 小于等于 less or equal
Columns	like(String name, Object value) like
Columns	likeAppendPercent(String name, Object value) 自动添加两边 % 的like
Columns	lt(String name, Object value) 小于 less than
static void	main(String[] args)
Columns	ne(String name, Object value) not equals !
Columns	notBetween(String name, Object start, Object end) not between
Columns	notIn(String name, Collection<?> collection) not in Collection
Columns	notIn(String name, Object... arrays) not int arrays
Columns	or()
Columns	orEqs(String name, Object... values)
Columns	ors(String name, String logic, Object... values)
static Columns	safeCreate(String name, Object value)
static Columns	safeMode()
Columns	sqlPart(String sql) customize string sql
Columns	sqlPart(String sql, Object... paras) customize string sql
Columns	sqlPartIf(String sql, Boolean condition) customize string sql
Columns	sqlPartIf(String sql, Boolean condition, Object... paras) customize string sql
Columns	sqlPartWithoutLink(String sql) customize string sql
Columns	sqlPartWithoutLink(String sql, Object... paras) customize string sql
Columns	sqlPartWithoutLinkIf(String sql, Boolean condition) customize string sql
Columns	sqlPartWithoutLinkIf(String sql, Boolean condition, Object... paras) customize string sql
private String	toMysqlSql() 这个只是用于调试
private String	toSqlServerSql() 这个只是用于调试
String	toString()
String	toWherePartSql() 输出 where 后面的 sql 部分，风格是 mysql 的风格 SQL
String	toWherePartSql(boolean withWhereKeyword) 输出 where 后面的 sql 部分，风格是 mysql 的风格 SQL
String	toWherePartSql(char separator, boolean withWhereKeyword) 输出 where 部分的 sql
Columns	unUseSafeMode()
Columns	useSafeMode()

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

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

字段详细资料

EMPTY

public static final Columns EMPTY

cols

private List<Column> cols

useSafeMode

private boolean useSafeMode

在很多场景下，只会根据字段来查询，如果字段值为 null 的情况，Columns 会直接忽略 null 值，此时会造成结果不准确的情况

比如 ： ``` public ShopInfo findFirstByAccountId(BigInteger accountId) { return findFirstByColumns(Columns.create("account_id", accountId)); } ``` 根据账户 id 来查询该账户对应的 ShopInfo，此时 如果传入 null 值，则返回了 第一个 ShopInfo，这个 ShopInfo 可能并不是该账户的。

在这种场景下，我们就不应该允许用户传入 null 值进行查询，当传入 null 的时候直接抛出异常即可 。

此时，我们可以使用如下代码进行查询。

``` public ShopInfo findFirstByAccountId(BigInteger accountId) { return findFirstByColumns(Columns.safeMode().eq("account_id", accountId)); } ```

SQL_CACHE_SEPARATOR

private static final char SQL_CACHE_SEPARATOR

另请参阅:

常量字段值

构造器详细资料

Columns

public Columns()

方法详细资料

create

public static Columns create()

create

public static Columns create(Column column)

create

public static Columns create(List<Column> columns)

create

public static Columns create(String name,
                             Object value)

safeMode

public static Columns safeMode()

safeCreate

public static Columns safeCreate(String name,
                                 Object value)

add

public Columns add(Column column)

add new column in Columns

参数:

column -

addToFirst

public Columns addToFirst(Column column)

add new column in Columns

参数:

column -

add

public Columns add(Columns columns)

add Columns

参数:

columns -

返回:

addToFirst

public Columns addToFirst(Columns columns)

add Columns To First

参数:

columns -

返回:

eq

public Columns eq(String name,
                  Object value)

equals

参数:

name -

value -

返回:

ne

public Columns ne(String name,
                  Object value)

not equals !=

参数:

name -

value -

返回:

like

public Columns like(String name,
                    Object value)

like

参数:

name -

value -

返回:

likeAppendPercent

public Columns likeAppendPercent(String name,
                                 Object value)

自动添加两边 % 的like

参数:

name -

value -

返回:

gt

public Columns gt(String name,
                  Object value)

大于 great than

参数:

name -

value -

返回:

ge

public Columns ge(String name,
                  Object value)

大于等于 great or equal

参数:

name -

value -

返回:

lt

public Columns lt(String name,
                  Object value)

小于 less than

参数:

name -

value -

返回:

le

public Columns le(String name,
                  Object value)

小于等于 less or equal

参数:

name -

value -

返回:

isNull

public Columns isNull(String name)

IS NULL

参数:

name -

返回:

isNullIf

public Columns isNullIf(String name,
                        Boolean condition)

参数:

name -

condition -

返回:

isNotNull

public Columns isNotNull(String name)

IS NOT NULL

参数:

name -

返回:

isNotNullIf

public Columns isNotNullIf(String name,
                           Boolean condition)

IS NOT NULL

参数:

name -

condition -

返回:

in

public Columns in(String name,
                  Object... arrays)

in arrays

参数:

name -

arrays -

返回:

in

public Columns in(String name,
                  Collection<?> collection)

in Collection

参数:

name -

collection -

返回:

notIn

public Columns notIn(String name,
                     Object... arrays)

not int arrays

参数:

name -

arrays -

返回:

notIn

public Columns notIn(String name,
                     Collection<?> collection)

not in Collection

参数:

name -

collection -

返回:

between

public Columns between(String name,
                       Object start,
                       Object end)

between

参数:

name -

start -

end -

返回:

notBetween

public Columns notBetween(String name,
                          Object start,
                          Object end)

not between

参数:

name -

start -

end -

返回:

group

public Columns group(Columns columns)

group

参数:

columns -

返回:

groupIf

public Columns groupIf(Columns columns,
                       Boolean condition)

参数:

columns -

condition -

返回:

groupBy

public Columns groupBy(String name)

参数:

name -

返回:

having

public Columns having(String name)

参数:

name -

返回:

having

public Columns having(String sql,
                      Object... paras)

参数:

sql -

返回:

having

public Columns having(Columns columns)

参数:

columns -

返回:

sqlPart

public Columns sqlPart(String sql)

customize string sql

参数:

sql -

返回:

sqlPart

public Columns sqlPart(String sql,
                       Object... paras)

customize string sql

参数:

sql -

paras -

返回:

sqlPartIf

public Columns sqlPartIf(String sql,
                         Boolean condition)

customize string sql

参数:

sql -

condition -

返回:

sqlPartIf

public Columns sqlPartIf(String sql,
                         Boolean condition,
                         Object... paras)

customize string sql

参数:

sql -

condition -

paras -

返回:

sqlPartWithoutLink

public Columns sqlPartWithoutLink(String sql)

customize string sql

参数:

sql -

返回:

sqlPartWithoutLink

public Columns sqlPartWithoutLink(String sql,
                                  Object... paras)

customize string sql

参数:

sql -

paras -

返回:

sqlPartWithoutLinkIf

public Columns sqlPartWithoutLinkIf(String sql,
                                    Boolean condition)

customize string sql

参数:

sql -

condition -

返回:

sqlPartWithoutLinkIf

public Columns sqlPartWithoutLinkIf(String sql,
                                    Boolean condition,
                                    Object... paras)

customize string sql

参数:

sql -

condition -

paras -

返回:

or

public Columns or()

ors

public Columns ors(String name,
                   String logic,
                   Object... values)

orEqs

public Columns orEqs(String name,
                     Object... values)

append

public Columns append(Columns columns)

追加 新的 columns

参数:

columns -

返回:

appendIf

public Columns appendIf(Columns columns,
                        Boolean condition)

追加 新的 columns

参数:

columns -

返回:

isUseSafeMode

public boolean isUseSafeMode()

useSafeMode

public Columns useSafeMode()

unUseSafeMode

public Columns unUseSafeMode()

isEmpty

public boolean isEmpty()

getValueArray

public Object[] getValueArray()

getList

public List<Column> getList()

containsName

public boolean containsName(String name)

getCacheKey

public String getCacheKey()

buildCacheKey

private void buildCacheKey(StringBuilder s,
                           List<Column> columns)

getLogicString

private static String getLogicString(String logic)

参数:

logic -

返回:

toWherePartSql

public String toWherePartSql()

输出 where 后面的 sql 部分，风格是 mysql 的风格 SQL

返回:

toWherePartSql

public String toWherePartSql(boolean withWhereKeyword)

输出 where 后面的 sql 部分，风格是 mysql 的风格 SQL

参数:

withWhereKeyword - 是否带上 where 关键字

返回:

toWherePartSql

public String toWherePartSql(char separator,
                             boolean withWhereKeyword)

输出 where 部分的 sql

参数:

separator - 字段分隔符

withWhereKeyword - 是否带上 "where 关键字"

返回:

toString

public String toString()

覆盖:

toString 在类中 Object

main

public static void main(String[] args)

toMysqlSql

private String toMysqlSql()

这个只是用于调试

返回:

toSqlServerSql

private String toSqlServerSql()

这个只是用于调试

返回: