程序包 com.baomidou.mybatisplus.core.metadata

类 TableFieldInfo

java.lang.Object

com.baomidou.mybatisplus.core.metadata.TableFieldInfo

所有已实现的接口:

Constants, StringPool, java.io.Serializable

public class TableFieldInfo
extends java.lang.Object
implements Constants

数据库表字段反射信息

从以下版本开始:

2016-09-09

作者:

hubin sjy willenfoo tantan

另请参阅:

序列化表格

字段概要

从接口继承的字段 com.baomidou.mybatisplus.core.toolkit.Constants

AES, AES_CBC_CIPHER, AS, ASC, COLLECTION, COLUMN_MAP, COLUMN_MAP_IS_EMPTY, DESC, ENTITY, ENTITY_DOT, LIMIT, LIST, MD5, MP_OPTLOCK_VERSION_ORIGINAL, MYBATIS_PLUS, ORDER_BY, Q_WRAPPER_SQL_COMMENT, Q_WRAPPER_SQL_FIRST, Q_WRAPPER_SQL_SELECT, U_WRAPPER_SQL_SET, WHERE, WRAPPER, WRAPPER_DOT, WRAPPER_EMPTYOFNORMAL, WRAPPER_EMPTYOFWHERE, WRAPPER_ENTITY, WRAPPER_ENTITY_DOT, WRAPPER_EXPRESSION_ORDER, WRAPPER_NONEMPTYOFENTITY, WRAPPER_NONEMPTYOFNORMAL, WRAPPER_NONEMPTYOFWHERE, WRAPPER_PARAM, WRAPPER_PARAM_MIDDLE, WRAPPER_SQLSEGMENT

从接口继承的字段 com.baomidou.mybatisplus.core.toolkit.StringPool

AMPERSAND, AND, ASTERISK, AT, BACK_SLASH, BACKTICK, BYTES_NEW_LINE, COLON, COMMA, CRLF, DASH, DOLLAR, DOLLAR_LEFT_BRACE, DOT, DOT_CLASS, DOT_JAVA, DOT_NEWLINE, DOT_XML, DOTDOT, EMPTY, EMPTY_ARRAY, EQUALS, EXCLAMATION_MARK, FALSE, HASH, HASH_LEFT_BRACE, HAT, HTML_AMP, HTML_GT, HTML_LT, HTML_NBSP, HTML_QUOTE, ISO_8859_1, LEFT_BRACE, LEFT_BRACKET, LEFT_CHEV, LEFT_SQ_BRACKET, N, NEWLINE, NO, NULL, OFF, ON, ONE, PERCENT, PIPE, PLUS, QUESTION_MARK, QUOTE, RETURN, RIGHT_BRACE, RIGHT_BRACKET, RIGHT_CHEV, RIGHT_SQ_BRACKET, SEMICOLON, SINGLE_QUOTE, SLASH, SPACE, STAR, TAB, TILDA, TRUE, UNDERSCORE, US_ASCII, UTF_8, Y, YES, ZERO

构造器概要

构造器

构造器	说明
TableFieldInfo(GlobalConfig.DbConfig dbConfig, TableInfo tableInfo, java.lang.reflect.Field field, com.baomidou.mybatisplus.annotation.TableField tableField, org.apache.ibatis.reflection.Reflector reflector, boolean existTableLogic)	全新的 存在 TableField 注解时使用的构造函数
TableFieldInfo(GlobalConfig.DbConfig dbConfig, TableInfo tableInfo, java.lang.reflect.Field field, com.baomidou.mybatisplus.annotation.TableField tableField, org.apache.ibatis.reflection.Reflector reflector, boolean existTableLogic, boolean isOrderBy)	全新的 存在 TableField 注解时使用的构造函数
TableFieldInfo(GlobalConfig.DbConfig dbConfig, TableInfo tableInfo, java.lang.reflect.Field field, org.apache.ibatis.reflection.Reflector reflector, boolean existTableLogic)	不存在 TableField 注解时, 使用的构造函数
TableFieldInfo(GlobalConfig.DbConfig dbConfig, TableInfo tableInfo, java.lang.reflect.Field field, org.apache.ibatis.reflection.Reflector reflector, boolean existTableLogic, boolean isOrderBy)	不存在 TableField 注解时, 使用的构造函数

方法概要

修饰符和类型	方法	说明
protected boolean	canEqual(java.lang.Object other)
boolean	equals(java.lang.Object o)
java.lang.String	getColumn()	字段名
java.lang.String	getCondition()	where 字段比较条件
java.lang.String	getEl()	属性表达式#{property}, 可以指定jdbcType, typeHandler等
java.lang.reflect.Field	getField()	属性
com.baomidou.mybatisplus.annotation.FieldFill	getFieldFill()	字段填充策略
java.lang.String	getInsertSqlColumn()	获取 insert 时候字段 sql 脚本片段
java.lang.String	getInsertSqlColumnMaybeIf(java.lang.String prefix)	获取 insert 时候字段 sql 脚本片段
java.lang.String	getInsertSqlProperty(java.lang.String prefix)	获取 insert 时候插入值 sql 脚本片段
java.lang.String	getInsertSqlPropertyMaybeIf(java.lang.String prefix)	获取 insert 时候插入值 sql 脚本片段
com.baomidou.mybatisplus.annotation.FieldStrategy	getInsertStrategy()	字段验证策略之 insert Refer to TableField.insertStrategy()
org.apache.ibatis.type.JdbcType	getJdbcType()	JDBC类型
java.lang.String	getLogicDeleteValue()	逻辑删除值
java.lang.String	getLogicNotDeleteValue()	逻辑未删除值
java.lang.String	getMapping()	jdbcType, typeHandler等部分
short	getOrderBySort()	排序顺序
java.lang.String	getOrderByType()	排序类型
java.lang.String	getProperty()	属性名
java.lang.Class<?>	getPropertyType()	属性类型
java.lang.String	getSqlSelect()	缓存 sql select
java.lang.String	getSqlSet(boolean ignoreIf, java.lang.String prefix)	获取 set sql 片段
java.lang.String	getSqlSet(java.lang.String prefix)	获取 set sql 片段
java.lang.String	getSqlWhere(java.lang.String prefix)	获取 查询的 sql 片段
java.lang.Class<? extends org.apache.ibatis.type.TypeHandler<?>>	getTypeHandler()	类型处理器
java.lang.String	getUpdate()	字段 update set 部分注入
com.baomidou.mybatisplus.annotation.FieldStrategy	getUpdateStrategy()	字段验证策略之 update Refer to TableField.updateStrategy()
java.lang.String	getVersionOli(java.lang.String alias, java.lang.String prefix)
com.baomidou.mybatisplus.annotation.FieldStrategy	getWhereStrategy()	字段验证策略之 where Refer to TableField.whereStrategy()
int	hashCode()
boolean	isCharSequence()	属性是否是 CharSequence 类型
boolean	isLogicDelete()	是否是逻辑删除字段
boolean	isOrderBy()	是否存在OrderBy注解
boolean	isPrimitive()	是否是基本数据类型
boolean	isSelect()	是否进行 select 查询
boolean	isVersion()	是否是乐观锁字段
boolean	isWithInsertFill()	表字段是否启用了插入填充
boolean	isWithUpdateFill()	表字段是否启用了更新填充
java.lang.String	toString()

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

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

构造器详细资料

TableFieldInfo

public TableFieldInfo(GlobalConfig.DbConfig dbConfig,
                      TableInfo tableInfo,
                      java.lang.reflect.Field field,
                      com.baomidou.mybatisplus.annotation.TableField tableField,
                      org.apache.ibatis.reflection.Reflector reflector,
                      boolean existTableLogic,
                      boolean isOrderBy)

全新的 存在 TableField 注解时使用的构造函数

TableFieldInfo

public TableFieldInfo(GlobalConfig.DbConfig dbConfig,
                      TableInfo tableInfo,
                      java.lang.reflect.Field field,
                      com.baomidou.mybatisplus.annotation.TableField tableField,
                      org.apache.ibatis.reflection.Reflector reflector,
                      boolean existTableLogic)

全新的 存在 TableField 注解时使用的构造函数

TableFieldInfo

public TableFieldInfo(GlobalConfig.DbConfig dbConfig,
                      TableInfo tableInfo,
                      java.lang.reflect.Field field,
                      org.apache.ibatis.reflection.Reflector reflector,
                      boolean existTableLogic,
                      boolean isOrderBy)

不存在 TableField 注解时, 使用的构造函数

TableFieldInfo

public TableFieldInfo(GlobalConfig.DbConfig dbConfig,
                      TableInfo tableInfo,
                      java.lang.reflect.Field field,
                      org.apache.ibatis.reflection.Reflector reflector,
                      boolean existTableLogic)

不存在 TableField 注解时, 使用的构造函数

方法详细资料

getInsertSqlProperty

public java.lang.String getInsertSqlProperty(java.lang.String prefix)

获取 insert 时候插入值 sql 脚本片段

insert into table (字段) values (值)

位于 "值" 部位

不生成 if 标签

返回:

sql 脚本片段

getInsertSqlPropertyMaybeIf

public java.lang.String getInsertSqlPropertyMaybeIf(java.lang.String prefix)

获取 insert 时候插入值 sql 脚本片段

insert into table (字段) values (值)

位于 "值" 部位

根据规则会生成 if 标签

返回:

sql 脚本片段

getInsertSqlColumn

public java.lang.String getInsertSqlColumn()

获取 insert 时候字段 sql 脚本片段

insert into table (字段) values (值)

位于 "字段" 部位

不生成 if 标签

返回:

sql 脚本片段

getInsertSqlColumnMaybeIf

public java.lang.String getInsertSqlColumnMaybeIf(java.lang.String prefix)

获取 insert 时候字段 sql 脚本片段

insert into table (字段) values (值)

位于 "字段" 部位

根据规则会生成 if 标签

返回:

sql 脚本片段

getSqlSet

public java.lang.String getSqlSet(java.lang.String prefix)

获取 set sql 片段

参数:

prefix - 前缀

返回:

sql 脚本片段

getSqlSet

public java.lang.String getSqlSet(boolean ignoreIf,
                                  java.lang.String prefix)

获取 set sql 片段

参数:

ignoreIf - 忽略 IF 包裹

prefix - 前缀

返回:

sql 脚本片段

getSqlWhere

public java.lang.String getSqlWhere(java.lang.String prefix)

获取 查询的 sql 片段

参数:

prefix - 前缀

返回:

sql 脚本片段

getVersionOli

public java.lang.String getVersionOli(java.lang.String alias,
                                      java.lang.String prefix)

getField

public java.lang.reflect.Field getField()

属性

从以下版本开始:

3.3.1

getColumn

public java.lang.String getColumn()

字段名

getProperty

public java.lang.String getProperty()

属性名

getEl

public java.lang.String getEl()

属性表达式#{property}, 可以指定jdbcType, typeHandler等

getMapping

public java.lang.String getMapping()

jdbcType, typeHandler等部分

getPropertyType

public java.lang.Class<?> getPropertyType()

属性类型

isPrimitive

public boolean isPrimitive()

是否是基本数据类型

从以下版本开始:

3.4.0 @2020-6-19

isCharSequence

public boolean isCharSequence()

属性是否是 CharSequence 类型

getInsertStrategy

public com.baomidou.mybatisplus.annotation.FieldStrategy getInsertStrategy()

字段验证策略之 insert Refer to TableField.insertStrategy()

从以下版本开始:

added v_3.1.2 @2019-5-7

getUpdateStrategy

public com.baomidou.mybatisplus.annotation.FieldStrategy getUpdateStrategy()

字段验证策略之 update Refer to TableField.updateStrategy()

从以下版本开始:

added v_3.1.2 @2019-5-7

getWhereStrategy

public com.baomidou.mybatisplus.annotation.FieldStrategy getWhereStrategy()

字段验证策略之 where Refer to TableField.whereStrategy()

从以下版本开始:

added v_3.1.2 @2019-5-7

isVersion

public boolean isVersion()

是否是乐观锁字段

isSelect

public boolean isSelect()

是否进行 select 查询

大字段可设置为 false 不加入 select 查询范围

getLogicDeleteValue

public java.lang.String getLogicDeleteValue()

逻辑删除值

getLogicNotDeleteValue

public java.lang.String getLogicNotDeleteValue()

逻辑未删除值

getUpdate

public java.lang.String getUpdate()

字段 update set 部分注入

getCondition

public java.lang.String getCondition()

where 字段比较条件

getFieldFill

public com.baomidou.mybatisplus.annotation.FieldFill getFieldFill()

字段填充策略

isWithInsertFill

public boolean isWithInsertFill()

表字段是否启用了插入填充

从以下版本开始:

3.3.0

isWithUpdateFill

public boolean isWithUpdateFill()

表字段是否启用了更新填充

从以下版本开始:

3.3.0

getSqlSelect

public java.lang.String getSqlSelect()

缓存 sql select

getJdbcType

public org.apache.ibatis.type.JdbcType getJdbcType()

JDBC类型

从以下版本开始:

3.1.2

getTypeHandler

public java.lang.Class<? extends org.apache.ibatis.type.TypeHandler<?>> getTypeHandler()

类型处理器

从以下版本开始:

3.1.2

isOrderBy

public boolean isOrderBy()

是否存在OrderBy注解

getOrderByType

public java.lang.String getOrderByType()

排序类型

getOrderBySort

public short getOrderBySort()

排序顺序

toString

public java.lang.String toString()

覆盖:

toString 在类中 java.lang.Object

equals

public boolean equals(java.lang.Object o)

覆盖:

equals 在类中 java.lang.Object

canEqual

protected boolean canEqual(java.lang.Object other)

hashCode

public int hashCode()

覆盖:

hashCode 在类中 java.lang.Object

isLogicDelete

public boolean isLogicDelete()

是否是逻辑删除字段