com.gframework.sqlparam

类 SqlParam

java.lang.Object

com.gframework.sqlparam.SqlParam

所有已实现的接口:

Serializable

直接已知子类:

BeanSqlParam

public class SqlParam
extends Object
implements Serializable

简单的单表Sql操作条件封装类，本类实际上也是一个链表结构.

【警告】请勿让条件组互相引用形成循环引用，否则会出现问题！同时本类也是只可增不可减的

每一个本类对象都是一个条件组，多个条件组可以使用 orNext(SqlParam) 和 andNext(SqlParam) 方法串联起来，类似于链表，他们之间的分隔符是由你连接时调用的方法决定的。

1、如果一个条件组对象的条件有A、B，另一个条件组的条件是C、D，两个条件组内部都是and连接，两个条件组则是or连接，那么最终生成的where条件是： (A and B) or (C and D)

  【例1】
  
  SqlParam.and().eq("x","x").orNext(SqlParam.and().eq("y","y"))
  
  【例1结果】
  (x = 'x') or (y = 'y')
  【例2】
  
  SqlParam.and().eq("x","x").ne("z","z").orNext(SqlParam.and().eq("y","y"))
  
  【例2结果】
  (x = 'x' and z != 'z') or (y = 'y')
 

2、整个SqlParam就是一个链表，在任意节点中执行 orNext(SqlParam) 或 andNext(SqlParam) 方法，都会在链表最后添加增加节点，而不会改变当前节点的next属性。

  【例3】
  
  SqlParam s1 = SqlParam.and().eq("x","x");
  SqlParam s2 = SqlParam.and().ne("y","y");
  s1.andNext(s2);
  s1.orNext(SqlParam.and().eq("z","z"))
  
  【例3结果】
  (x = 'x') and (y != 'y') or (z = 'z')
 

3、如果你实例化了一个空的本类对象例如直接：SqlParam.and(); SqlParam.or(); 那么实际上是不会产生任何where条件的。

本类是线程不安全的。 同时本类支持序列化和RPC传输，但是请务必保证设置的value值也是可序列化的。

从以下版本开始:

1.0.0

作者:

Ghwolf

另请参阅:

ParamMode, SqlParamUtils, 序列化表格

字段概要

字段

限定符和类型	字段和说明
static String	AND_STR where条件and连接符
static String	OR_STR where条件or连接符

构造器概要

构造器

限定符	构造器和说明
protected	SqlParam(String innerOp)

方法概要

限定符和类型	方法和说明
static SqlParam	and() 取得一个内部条件全是用and连接的条件组对象.
SqlParam	andNext(SqlParam sqlParam) 和另外一个条件组建立and连接运算.
<T extends Serializable> SqlParam	betweenAnd(String column, T start, T end) 添加一个BETWEEN AND判断规则
static SqlParam	buildByParamModeAnd(Object obj) 用and连接符连接条件，解析对象属性中的ParamMode注解，并生成一个SqlParam类对象
static SqlParam	buildByParamModeOr(Object obj) 用or连接符连接条件，解析对象属性中的ParamMode注解，并生成一个SqlParam类对象
SqlParam	eq(String column, Object value) 添加一个等值判断规则
SqlParam	ge(String column, Object value) 添加一个大于等于>=判断规则
int	getCurrentParamSize() 取得当前条件组的条件数量.
protected String	getCurrentSql(Map<String,Object> param, NameGenerator ng, com.gframework.sqlparam.StringWrapper stringWrapper) 取得当前SqlParam节点的sql语句，不含左右括号
String	getInnerOp() 取得本条件组内部的连接符号
String	getOuterOp() 取得本条件和上一个条件组之间的连接符号，如果此条件组是首个，则为null.
List<SqlParam>	getParamList() 取得条件组集合链表，包括所有关联的条件组.
protected List<Param>	getParams() 取得当前条件组中的所有条件参数集合
int	getParamSize() 取得从当前节点开始的所有条件数量.
String	getSql(List<Object> params) 取得where子句的sql语句（不含where，左右无括号），同时将其中包含的动态参数设置到params中.
String	getSql(Map<String,Object> params) 取得where子句的sql语句（不含where，左右无括号），同时将其中包含的动态参数设置到params中.
String	getSql(Map<String,Object> params, NameGenerator ng) 取得where子句的sql语句（不含where，左右无括号），同时将其中包含的动态参数设置到params中.
SqlParam	gt(String column, Object value) 添加一个大于>判断规则
SqlParam	in(String column, Collection<?> values) 添加一个IN判断规则
SqlParam	in(String column, Object[] values) 添加一个IN判断规则
SqlParam	isNotNull(String column) 添加一个IS NOT NULL判断规则
SqlParam	isNull(String column) 添加一个IS NULL判断规则
SqlParam	le(String column, Object value) 添加一个小于等于<=判断规则
SqlParam	like(String column, String value) 添加一个LIKE判断规则
SqlParam	lt(String column, Object value) 添加一个小于<判断规则
SqlParam	ne(String column, Object value) 添加一个不等判断规则
SqlParam	notIn(String column, Collection<?> values) 添加一个NOT IN判断规则
SqlParam	notIn(String column, Object[] values) 添加一个NOT IN判断规则
SqlParam	notLike(String column, String value) 添加一个NOT LIKE判断规则
static SqlParam	or() 取得一个内部条件全是用or连接的条件组对象.
SqlParam	orNext(SqlParam sqlParam) 和另外一个条件组建立or连接运算.
static <T extends Serializable> Param	sbetweenAnd(String column, T start, T end) 获取一个BETWEEN AND判断规则
static Param	seq(String column, Object value) 获取一个等值判断规则
static Param	sge(String column, Object value) 获取一个大于等于>=判断规则
static Param	sgt(String column, Object value) 获取一个大于>判断规则
static Param	sin(String column, Collection<?> values) 获取一个IN判断规则
static Param	sin(String column, Object[] values) 获取一个IN判断规则
static Param	sisNotNull(String column) 获取一个IS NOT NULL判断规则
static Param	sisNull(String column) 获取一个IS NULL判断规则
static Param	sle(String column, Object value) 获取一个小于等于<=判断规则
static Param	slike(String column, String value) 获取一个LIKE判断规则
static Param	slt(String column, Object value) 获取一个小于<判断规则
static Param	sne(String column, Object value) 获取一个不等判断规则
static Param	snotIn(String column, Collection<?> values) 获取一个NOT IN判断规则
static Param	snotIn(String column, Object[] values) 获取一个NOT IN判断规则
static Param	snotLike(String column, String value) 获取一个NOT LIKE判断规则
String	toString()

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

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

字段详细资料

AND_STR

public static final String AND_STR

where条件and连接符

另请参阅:

常量字段值

OR_STR

public static final String OR_STR

where条件or连接符

另请参阅:

常量字段值

构造器详细资料

SqlParam

protected SqlParam(String innerOp)

方法详细资料

buildByParamModeAnd

public static SqlParam buildByParamModeAnd(@Nullable
                                           Object obj)

用and连接符连接条件，解析对象属性中的ParamMode注解，并生成一个SqlParam类对象

参数:

obj - 参数信息存放对象，只有包含了ParamMode注解的属性和方法才会被解析，可为null

返回:

返回SqlParam类对象，如果参数为null，则返回一个没有sql的SqlParam类对象

buildByParamModeOr

public static SqlParam buildByParamModeOr(Object obj)

用or连接符连接条件，解析对象属性中的ParamMode注解，并生成一个SqlParam类对象

参数:

obj - 参数信息存放对象，只有包含了ParamMode注解的属性和方法才会被解析，可为null

返回:

返回SqlParam类对象，如果参数为null，则返回一个没有sql的SqlParam类对象

and

public static SqlParam and()

取得一个内部条件全是用and连接的条件组对象.

返回:

返回内部条件连接符都是and的对象

or

public static SqlParam or()

取得一个内部条件全是用or连接的条件组对象.

返回:

返回内部条件连接符都是or的对象

getParamList

public List<SqlParam> getParamList()

取得条件组集合链表，包括所有关联的条件组.

链表的首个节点是当前节点，如果当前节点存在上个节点，则无法取得。 没有任何条件的条件组也不会存在在返回的链表中。

返回:

返回关联的条件组，如果没有则集合长度为0

andNext

public SqlParam andNext(@Nullable
                        SqlParam sqlParam)

和另外一个条件组建立and连接运算.

如果已经连接了一个条件组，则会放到整个条件链表的最后面去

参数:

sqlParam - 要建立运算的另一个条件组，如果为null则什么都不做并返回null

返回:

返回当前对象

orNext

public SqlParam orNext(SqlParam sqlParam)

和另外一个条件组建立or连接运算.

如果已经连接了一个条件组，则会放到整个条件链表的最后面去

参数:

sqlParam - 要建立运算的另一个条件组，如果为null则什么都不做并返回null

返回:

返回当前对象

getCurrentParamSize

public int getCurrentParamSize()

取得当前条件组的条件数量.

如果要取得从当前节点开始的所有条件总数，可以调用getParamSize()方法。

返回:

返回条件数量，没有返回0

getParamSize

public int getParamSize()

取得从当前节点开始的所有条件数量.

返回:

返回从当前节点开始的全部条件数量，没有返回0

getSql

public String getSql(@Nullable
                     Map<String,Object> params,
                     NameGenerator ng)

取得where子句的sql语句（不含where，左右无括号），同时将其中包含的动态参数设置到params中.

此方法会生成基于mybatis类型的，采用自定义预编译参数名称的方式进行生成。

params可以为null，为null则不设置参数只生成sql语句。

如果无sql则返回null

参数:

params - 保存预编译参数的集合，可以为null

唯一的参数名称生成器 -

返回:

返回从当前节点一直向后递归生成的sql语句，如果无法生成sql即无where条件，则返回""

getSql

public String getSql(@Nullable
                     Map<String,Object> params)

取得where子句的sql语句（不含where，左右无括号），同时将其中包含的动态参数设置到params中.

此方法会生成基于mybatis类型的，采用自定义预编译参数名称的方式进行生成。

params可以为null，为null则不设置参数只生成sql语句。

如果无sql则返回null

参数:

params - 保存预编译参数的集合，可以为null

返回:

返回从当前节点一直向后递归生成的sql语句，如果无法生成sql即无where条件，则返回""

getSql

public String getSql(@Nullable
                     List<Object> params)

取得where子句的sql语句（不含where，左右无括号），同时将其中包含的动态参数设置到params中.

此方法会生成基于jdbc原生类型，预编译参数使用"?"进行填充的sql语句，并将参数按照顺序填充到params中。

params可以为null，为null则不设置参数只生成sql语句。

如果无sql则返回null

参数:

param - 保存预编译参数的集合，可以为null

返回:

返回从当前节点一直向后递归生成的sql语句，如果无法生成sql即无where条件，则返回""

getCurrentSql

protected String getCurrentSql(Map<String,Object> param,
                               NameGenerator ng,
                               com.gframework.sqlparam.StringWrapper stringWrapper)

取得当前SqlParam节点的sql语句，不含左右括号

参数:

param - 设置参数的map集合，为null则不设置参数

ng - 参数绑定名称生成器

返回:

返回sql语句，没有返回""

eq

public SqlParam eq(@Nullable
                   String column,
                   @Nullable
                   Object value)

添加一个等值判断规则

参数:

column - 判断的列，如果为null则什么都不做

value - 要进行比较的值，如果为null则什么都不做

返回:

返回当前调用对象

ne

public SqlParam ne(@Nullable
                   String column,
                   @Nullable
                   Object value)

添加一个不等判断规则

参数:

column - 判断的列，如果为null则什么都不做

value - 要进行比较的值，如果为null则什么都不做

返回:

返回当前调用对象

in

public SqlParam in(@Nullable
                   String column,
                   @Nullable
                   Object[] values)

添加一个IN判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回当前调用对象

in

public SqlParam in(@Nullable
                   String column,
                   @Nullable
                   Collection<?> values)

添加一个IN判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回当前调用对象

notIn

public SqlParam notIn(@Nullable
                      String column,
                      @Nullable
                      Object[] values)

添加一个NOT IN判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回当前调用对象

notIn

public SqlParam notIn(@Nullable
                      String column,
                      @Nullable
                      Collection<?> values)

添加一个NOT IN判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回当前调用对象

like

public SqlParam like(@Nullable
                     String column,
                     @Nullable
                     String value)

添加一个LIKE判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值(%：匹配0个或多个值，_:匹配任意一个值)，如果为null则什么都不做

返回:

返回当前调用对象

notLike

public SqlParam notLike(@Nullable
                        String column,
                        @Nullable
                        String value)

添加一个NOT LIKE判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值(%：匹配0个或多个值，_:匹配任意一个值)，如果为null则什么都不做

返回:

返回当前调用对象

isNull

public SqlParam isNull(@Nullable
                       String column)

添加一个IS NULL判断规则

参数:

column - 判断的列，如果为null则什么都不做

返回:

返回当前调用对象

isNotNull

public SqlParam isNotNull(@Nullable
                          String column)

添加一个IS NOT NULL判断规则

参数:

column - 判断的列，如果为null则什么都不做

返回:

返回当前调用对象

lt

public SqlParam lt(@Nullable
                   String column,
                   @Nullable
                   Object value)

添加一个小于<判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回当前调用对象

le

public SqlParam le(@Nullable
                   String column,
                   @Nullable
                   Object value)

添加一个小于等于<=判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回当前调用对象

gt

public SqlParam gt(@Nullable
                   String column,
                   @Nullable
                   Object value)

添加一个大于>判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回当前调用对象

ge

public SqlParam ge(@Nullable
                   String column,
                   @Nullable
                   Object value)

添加一个大于等于>=判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回当前调用对象

betweenAnd

public <T extends Serializable> SqlParam betweenAnd(@Nullable
                                                    String column,
                                                    @Nullable
                                                    T start,
                                                    @Nullable
                                                    T end)

添加一个BETWEEN AND判断规则

类型参数:

T - 泛型的目的保证start和end数据类型一致

参数:

column - 判断的列，如果为null则什么都不做

start - 范围起始值，如果为null则什么都不做

end - 范围结束值，如果为null则什么都不做

返回:

返回当前调用对象

seq

@Nullable
public static Param seq(@Nullable
                                   String column,
                                   @Nullable
                                   Object value)

获取一个等值判断规则

参数:

column - 判断的列，如果为null则什么都不做

value - 要进行比较的值，如果为null则什么都不做

返回:

返回Param类，如果无法创建有效的Param类对象，则返回nul

sne

@Nullable
public static Param sne(@Nullable
                                   String column,
                                   @Nullable
                                   Object value)

获取一个不等判断规则

参数:

column - 判断的列，如果为null则什么都不做

value - 要进行比较的值，如果为null则什么都不做

返回:

返回Param类，如果无法创建有效的Param类对象，则返回nul

sin

@Nullable
public static Param sin(@Nullable
                                   String column,
                                   @Nullable
                                   Object[] values)

获取一个IN判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回Param类，如果无法创建有效的Param类对象，则返回nul

sin

@Nullable
public static Param sin(@Nullable
                                   String column,
                                   @Nullable
                                   Collection<?> values)

获取一个IN判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回Param类，如果无法创建有效的Param类对象，则返回nul

snotIn

@Nullable
public static Param snotIn(@Nullable
                                      String column,
                                      @Nullable
                                      Object[] values)

获取一个NOT IN判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回Param类，如果无法创建有效的Param类对象，则返回nul

snotIn

@Nullable
public static Param snotIn(@Nullable
                                      String column,
                                      @Nullable
                                      Collection<?> values)

获取一个NOT IN判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回Param类，如果无法创建有效的Param类对象，则返回nul

slike

@Nullable
public static Param slike(@Nullable
                                     String column,
                                     @Nullable
                                     String value)

获取一个LIKE判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值(%：匹配0个或多个值，_:匹配任意一个值)，如果为null则什么都不做

返回:

返回Param类，如果无法创建有效的Param类对象，则返回nul

snotLike

@Nullable
public static Param snotLike(@Nullable
                                        String column,
                                        @Nullable
                                        String value)

获取一个NOT LIKE判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值(%：匹配0个或多个值，_:匹配任意一个值)，如果为null则什么都不做

返回:

返回Param类，如果无法创建有效的Param类对象，则返回nul

sisNull

@Nullable
public static Param sisNull(@Nullable
                                       String column)

获取一个IS NULL判断规则

参数:

column - 判断的列，如果为null则什么都不做

返回:

返回Param类，如果无法创建有效的Param类对象，则返回nul

sisNotNull

@Nullable
public static Param sisNotNull(@Nullable
                                          String column)

获取一个IS NOT NULL判断规则

参数:

column - 判断的列，如果为null则什么都不做

返回:

返回Param类，如果无法创建有效的Param类对象，则返回nul

slt

@Nullable
public static Param slt(@Nullable
                                   String column,
                                   @Nullable
                                   Object value)

获取一个小于<判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回Param类，如果无法创建有效的Param类对象，则返回nul

sle

@Nullable
public static Param sle(@Nullable
                                   String column,
                                   @Nullable
                                   Object value)

获取一个小于等于<=判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回Param类，如果无法创建有效的Param类对象，则返回nul

sgt

@Nullable
public static Param sgt(@Nullable
                                   String column,
                                   @Nullable
                                   Object value)

获取一个大于>判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回Param类，如果无法创建有效的Param类对象，则返回nul

sge

@Nullable
public static Param sge(@Nullable
                                   String column,
                                   @Nullable
                                   Object value)

获取一个大于等于>=判断规则

参数:

column - 判断的列，如果为null则什么都不做

values - 要进行匹配的值，如果为null则什么都不做

返回:

返回Param类，如果无法创建有效的Param类对象，则返回nul

sbetweenAnd

@Nullable
public static <T extends Serializable> Param sbetweenAnd(@Nullable
                                                                    String column,
                                                                    @Nullable
                                                                    T start,
                                                                    @Nullable
                                                                    T end)

获取一个BETWEEN AND判断规则

类型参数:

T - 泛型的目的保证start和end数据类型一致

参数:

column - 判断的列，如果为null则什么都不做

start - 范围起始值，如果为null则什么都不做

end - 范围结束值，如果为null则什么都不做

返回:

返回Param类，如果无法创建有效的Param类对象，则返回nul

getInnerOp

public String getInnerOp()

取得本条件组内部的连接符号

返回:

and或or

getOuterOp

public String getOuterOp()

取得本条件和上一个条件组之间的连接符号，如果此条件组是首个，则为null.

返回:

and或or，如果为首个条件组则返回null

getParams

protected List<Param> getParams()

取得当前条件组中的所有条件参数集合

返回:

Param 类对象集合，如果没有，则集合长度为0

toString

public String toString()

覆盖:

toString 在类中 Object