com.github.yuxiaobin.mybatis.gm

类 GeneralEntityWrapper<T>

java.lang.Object

com.baomidou.mybatisplus.mapper.EntityWrapper<T>

com.github.yuxiaobin.mybatis.gm.GeneralEntityWrapper<T>

所有已实现的接口:

Serializable

public class GeneralEntityWrapper<T>
extends com.baomidou.mybatisplus.mapper.EntityWrapper<T>

This object is used to solve EntityWrapper.where/and/or... Parameter Type of Date. Mybatis-plus_v_1.5


Eg:
EntityWrapper ew = new EntityWrapper(entity);
ew.andNew("col1_date > {0} and col1_date<{1}", LocalDate.of(2017,2,10), LocalDate.of(2017,2,15));

SQL:
select xx from tbl_entity where col1_date>2017-2-10 and col1_date<2017-2-15

Question:
1) Mysql: no record will be found due to condition is false forever.(actual sql: col1_date>2005 and col1_date<2000) : do subtraction
2) Other db(oracle), sql will encounter error

Solution:
1) just use: ew.andNew("col1_date > {0} and col1_date<{1}", LocalDate.of(2017,2,10), LocalDate.of(2017,2,15));
sqlSegment will be replaced to : col1_date > #{GENVAL1} and col1_date<#{GENVAL2},
And GENVAL1,GENVAL2 will be passed to mybatis via Map.
2) OR try like this: ew.andNew("col1_date > #{dateFrom} and col1_date<#{dateTo}", LocalDate.of(2017,2,10), LocalDate.of(2017,2,15));
3) BUT {0} and #{value}, mixed use currently NOT supported.

作者:

Kelly Lake(179634696@qq.com)

另请参阅:

序列化表格

字段概要

字段

限定符和类型	字段和说明
static String	CLOSE_TOKEN
static String	OPEN_TOKEN

从类继承的字段 com.baomidou.mybatisplus.mapper.EntityWrapper

entity, sql, sqlSelect

构造器概要

构造器

构造器和说明
GeneralEntityWrapper()
GeneralEntityWrapper(T entity)
GeneralEntityWrapper(T entity, String sqlSelect)

方法概要

限定符和类型	方法和说明
com.baomidou.mybatisplus.mapper.EntityWrapper<T>	addFilter(String sqlWhere, Object... params) 已过时。 instead use where(String sqlWhere, Object... params),and(String sqlAnd, Object... params)...
com.baomidou.mybatisplus.mapper.EntityWrapper<T>	addFilterIfNeed(boolean need, String sqlWhere, Object... params) 已过时。 instead use where(String sqlWhere, Object... params),and(String sqlAnd, Object... params)...
com.baomidou.mybatisplus.mapper.EntityWrapper<T>	and(String sqlAnd, Object... params) Code: ew.and("col1=18").and("col2={0}", 20) SQL: AND col1=18 AND col2=20
com.baomidou.mybatisplus.mapper.EntityWrapper<T>	andNew(String sqlAnd, Object... params) Use () to separate sql segment.
boolean	checkFieldValueNotNull() Get corresponding class and check property values NOT null.
protected String	formatSqlIfNeed(boolean need, String sqlStr, Object... params) Format SQL for methods: EntityWrapper.where/and/or...
Map<String,Object>	getParamNameValuePairs()
String	getSqlSegment() Plus Injected Sql will use EntityWrapper.sqlSegment in sql script Refer to AutoSqlInjector.sqlWhereEntityWrapper() If ew.entity is an empty object, sql structure: select col1, col2 from tbl_entity #{sqlSegment}, sqlSegment should start with "WHERE"; If ew.entity has property values, sql structure: select col1, col2 from tbl_entity where col1=#{propertyVal1} #{sqlSegment}, sqlSegment should start with "AND"
com.baomidou.mybatisplus.mapper.EntityWrapper<T>	having(String sqlHaving, Object... params) Code: eg: ew.groupBy("id,name").having("id={0}",22).and("password is not null") SQL: group by id, name having id=22 and password is not null
com.baomidou.mybatisplus.mapper.EntityWrapper<T>	or(String sqlOr, Object... params) Code: ew.or("col1=18").or("col2={0}", 20) SQL: OR col1=18 OR col2=20
com.baomidou.mybatisplus.mapper.EntityWrapper<T>	orNew(String sqlOr, Object... params) Code: ew.or("col1=18").orNew("col2={0} and col3={0}", 20) SQL: OR col1=18 OR ( col2=20 and col3=20 )
com.baomidou.mybatisplus.mapper.EntityWrapper<T>	where(String sqlWhere, Object... params) ew.where("col_1>{0} and col_1<{1}", Object val1, Object val2); eg: ew.where("name='Bob'").where("id=#{value1}",123).where("age>#{value2}", 18); OR ew.where("name='Bob'").where("id={0}",123).where("age>{1}", 18); sql: where (name='Bob' and id=#{value1} and age>#{value2}) The values of "value1" and "value2" will be passed to mybatis via Map param.

从类继承的方法 com.baomidou.mybatisplus.mapper.EntityWrapper

between, dealParams, exists, formatSql, getEntity, getSqlSelect, groupBy, in, in, in, isNotNull, isNull, like, notExists, notIn, notIn, notIn, notLike, orderBy, orderBy, setEntity, setSqlSelect, stripSqlInjection

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

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

字段详细资料

OPEN_TOKEN

public static final String OPEN_TOKEN

另请参阅:

常量字段值

CLOSE_TOKEN

public static final String CLOSE_TOKEN

另请参阅:

常量字段值

构造器详细资料

GeneralEntityWrapper

public GeneralEntityWrapper()

GeneralEntityWrapper

public GeneralEntityWrapper(T entity,
                            String sqlSelect)

GeneralEntityWrapper

public GeneralEntityWrapper(T entity)

方法详细资料

getSqlSegment

public String getSqlSegment()

Plus Injected Sql will use EntityWrapper.sqlSegment in sql script

Refer to AutoSqlInjector.sqlWhereEntityWrapper()

If ew.entity is an empty object, sql structure:
select col1, col2 from tbl_entity #{sqlSegment}, sqlSegment should start with "WHERE";
If ew.entity has property values, sql structure:
select col1, col2 from tbl_entity where col1=#{propertyVal1} #{sqlSegment}, sqlSegment should start with "AND"

覆盖:

getSqlSegment 在类中 com.baomidou.mybatisplus.mapper.EntityWrapper<T>

从以下版本开始:

1.6

checkFieldValueNotNull

public boolean checkFieldValueNotNull()

Get corresponding class and check property values NOT null.

返回:

从以下版本开始:

1.6

getParamNameValuePairs

public Map<String,Object> getParamNameValuePairs()

返回:

从以下版本开始:

1.6

formatSqlIfNeed

protected String formatSqlIfNeed(boolean need,
                                 String sqlStr,
                                 Object... params)

Format SQL for methods: EntityWrapper.where/and/or...("name={0}", value);

ew.where("sample_name={0}", "haha").and("sample_age >{0} and sample_age<{1}", 18, 30);
OR
ew.where("sample_name=#{name}", "haha").and("sample_age >#{ageFrom} and sample_age<#{ageTo}", 18, 30);
BUT
{0} and #{value} cannot be mixed used.
eg:
ew.and("sample_age >{0} and sample_age<#{ageTo}", 18, 30);//not support

覆盖:

formatSqlIfNeed 在类中 com.baomidou.mybatisplus.mapper.EntityWrapper<T>

参数:

need - true

sqlStr - normally like: "column_name={0}"

params -

从以下版本开始:

1.6

where

public com.baomidou.mybatisplus.mapper.EntityWrapper<T> where(String sqlWhere,
                                                              Object... params)

ew.where("col_1>{0} and col_1<{1}", Object val1, Object val2);


eg:
ew.where("name='Bob'").where("id=#{value1}",123).where("age>#{value2}", 18);
OR
ew.where("name='Bob'").where("id={0}",123).where("age>{1}", 18);
sql:
where (name='Bob' and id=#{value1} and age>#{value2})
The values of "value1" and "value2" will be passed to mybatis via Map param.


NOTE: NOT support mixed usage for {0} and #{value1}.

ew.where("id={0}",123).where("age>#{age}", 18) currently NOT SUPPORT.

覆盖:

where 在类中 com.baomidou.mybatisplus.mapper.EntityWrapper<T>

参数:

sqlWhere - sql segment: "col_1>{0} AND col_1<{1}" or "col_1>#{val1} AND col_1<#{val2}"

params -

从以下版本开始:

1.6 just show how to deal

and

public com.baomidou.mybatisplus.mapper.EntityWrapper<T> and(String sqlAnd,
                                                            Object... params)

Code:
ew.and("col1=18").and("col2={0}", 20)
SQL:
AND col1=18 AND col2=20

覆盖:

and 在类中 com.baomidou.mybatisplus.mapper.EntityWrapper<T>

andNew

public com.baomidou.mybatisplus.mapper.EntityWrapper<T> andNew(String sqlAnd,
                                                               Object... params)

Use () to separate sql segment.

Code:
ew.and("col1=18").andNew("col2>2 or col2<10")
SQL:
AND col1=18 AND ( col2>2 or col2<10 )

覆盖:

andNew 在类中 com.baomidou.mybatisplus.mapper.EntityWrapper<T>

or

public com.baomidou.mybatisplus.mapper.EntityWrapper<T> or(String sqlOr,
                                                           Object... params)

Code:
ew.or("col1=18").or("col2={0}", 20)
SQL:
OR col1=18 OR col2=20

覆盖:

or 在类中 com.baomidou.mybatisplus.mapper.EntityWrapper<T>

orNew

public com.baomidou.mybatisplus.mapper.EntityWrapper<T> orNew(String sqlOr,
                                                              Object... params)

Code:
ew.or("col1=18").orNew("col2={0} and col3={0}", 20)
SQL:
OR col1=18 OR ( col2=20 and col3=20 )

覆盖:

orNew 在类中 com.baomidou.mybatisplus.mapper.EntityWrapper<T>

having

public com.baomidou.mybatisplus.mapper.EntityWrapper<T> having(String sqlHaving,
                                                               Object... params)

Code:
eg: ew.groupBy("id,name").having("id={0}",22).and("password is not null")
SQL:
group by id, name having id=22 and password is not null

覆盖:

having 在类中 com.baomidou.mybatisplus.mapper.EntityWrapper<T>

addFilter

@Deprecated
public com.baomidou.mybatisplus.mapper.EntityWrapper<T> addFilter(String sqlWhere,
                                                                               Object... params)

已过时。 instead use where(String sqlWhere, Object... params),and(String sqlAnd, Object... params)...

覆盖:

addFilter 在类中 com.baomidou.mybatisplus.mapper.EntityWrapper<T>

addFilterIfNeed

@Deprecated
public com.baomidou.mybatisplus.mapper.EntityWrapper<T> addFilterIfNeed(boolean need,
                                                                                     String sqlWhere,
                                                                                     Object... params)

已过时。 instead use where(String sqlWhere, Object... params),and(String sqlAnd, Object... params)...

覆盖:

addFilterIfNeed 在类中 com.baomidou.mybatisplus.mapper.EntityWrapper<T>