top.chukongxiang.mybatis.basemapper.model.annnotations

注释类型 TableField

@Inherited
 @Retention(value=RUNTIME)
 @Target(value={FIELD,ANNOTATION_TYPE})
public @interface TableField

版本:

1.0.0

作者:

楚孔响

可选元素概要

可选元素

限定符和类型	可选元素和说明
SqlCondition	condition 生成where时使用的条件
boolean	exist 是否为数据库表字段 默认 true 存在，false 不存在
FieldStrategy	insertStrategy 字段验证策略之 insert: 当insert操作时，该字段拼接insert语句时的策略 IGNORED: 直接拼接 insert into table_a(column) values (#{columnProperty}); NOT_NULL: insert into table_a(	boolean	mapUnderlineCase 生成ResultMap时是否自动映射大写到下划线，仅当没有配置字段名称时才生效
boolean	select 是否加入select查询列
String	update 字段 update set 部分注入, 该注解优于 el 注解使用 例1：@TableField(.. , update="%s+1") 其中 %s 会填充为字段 输出 SQL 为：update 表 set 字段=字段+1 where ...
FieldStrategy	updateStrategy 字段验证策略之 update: 当更新操作时，该字段拼接set语句时的策略 IGNORED: 直接拼接 update table_a set column=#{columnProperty}, 属性为null/空string都会被set进去 NOT_NULL: update table_a set	String	value 数据库字段值 不需要配置该值的情况: 当 mapUnderlineCase() 为 true 时, (mp下默认是true,mybatis默认是false), 数据库字段值.replace("_","").toUpperCase() == 实体属性名.toUpperCase() 当 mapUnderlineCase() 为 false 时, 数据库字段值.toUpperCase() == 实体属性名.toUpperCase()
FieldStrategy	whereStrategy 字段验证策略之 where: 表示该字段在拼接where条件时的策略 IGNORED: 直接拼接 column=#{columnProperty} NOT_NULL:	String	wrap 包装字符串，例：`
WrapType	wrapType 表名前后包装，例：`table_name`

元素详细资料

value

public abstract String value

数据库字段值

不需要配置该值的情况:

当 mapUnderlineCase() 为 true 时, (mp下默认是true,mybatis默认是false), 数据库字段值.replace("_","").toUpperCase() == 实体属性名.toUpperCase() 当 mapUnderlineCase() 为 false 时, 数据库字段值.toUpperCase() == 实体属性名.toUpperCase()

默认值:

""

exist

public abstract boolean exist

是否为数据库表字段

默认 true 存在，false 不存在

默认值:

true

update

public abstract String update

字段 update set 部分注入, 该注解优于 el 注解使用

例1：@TableField(.. , update="%s+1") 其中 %s 会填充为字段 输出 SQL 为：update 表 set 字段=字段+1 where ...

例2：@TableField(.. , update="now()") 使用数据库时间 输出 SQL 为：update 表 set 字段=now() where ...

默认值:

""

insertStrategy

public abstract FieldStrategy insertStrategy

字段验证策略之 insert: 当insert操作时，该字段拼接insert语句时的策略

IGNORED: 直接拼接 insert into table_a(column) values (#{columnProperty}); NOT_NULL: insert into table_a(column) values (#{columnProperty}) NOT_EMPTY: insert into table_a(column) values (#{columnProperty}) NOT_EMPTY 如果针对的是非 CharSequence 类型的字段则效果等于 NOT_NULL

从以下版本开始:

3.1.2

默认值:

top.chukongxiang.mybatis.basemapper.model.enums.FieldStrategy.DEFAULT

updateStrategy

public abstract FieldStrategy updateStrategy

字段验证策略之 update: 当更新操作时，该字段拼接set语句时的策略

IGNORED: 直接拼接 update table_a set column=#{columnProperty}, 属性为null/空string都会被set进去 NOT_NULL: update table_a set column=#{columnProperty} NOT_EMPTY: update table_a set column=#{columnProperty} NOT_EMPTY 如果针对的是非 CharSequence 类型的字段则效果等于 NOT_NULL

从以下版本开始:

3.1.2

默认值:

top.chukongxiang.mybatis.basemapper.model.enums.FieldStrategy.DEFAULT

whereStrategy

public abstract FieldStrategy whereStrategy

字段验证策略之 where: 表示该字段在拼接where条件时的策略

IGNORED: 直接拼接 column=#{columnProperty} NOT_NULL: column=#{columnProperty} NOT_EMPTY: column=#{columnProperty} NOT_EMPTY 如果针对的是非 CharSequence 类型的字段则效果等于 NOT_NULL

从以下版本开始:

3.1.2

默认值:

top.chukongxiang.mybatis.basemapper.model.enums.FieldStrategy.DEFAULT

mapUnderlineCase

public abstract boolean mapUnderlineCase

生成ResultMap时是否自动映射大写到下划线，仅当没有配置字段名称时才生效

返回:

布尔值

默认值:

true

wrapType

public abstract WrapType wrapType

表名前后包装，例：`table_name`

返回:

类型

默认值:

top.chukongxiang.mybatis.basemapper.model.enums.WrapType.AUTO

wrap

public abstract String wrap

包装字符串，例：`

返回:

包装字符

默认值:

""

condition

public abstract SqlCondition condition

生成where时使用的条件

返回:

默认值:

top.chukongxiang.mybatis.basemapper.model.enums.SqlCondition.EQ

select

public abstract boolean select

是否加入select查询列

返回:

默认值:

true