# 注解

介绍 MybatisPlus 注解包相关类详解(更多详细描述可点击查看源码注释)

注解类包：

👉 mybatis-plus-annotation

# @TableName

• 描述：表名注解

属性	类型	必须指定	默认值	描述
value	String	否	""	表名
resultMap	String	否	""	xml 中 resultMap 的 id
schema	String	否	""	schema(@since 3.1.1)
keepGlobalPrefix	boolean	否	false	是否保持使用全局的 tablePrefix 的值(如果设置了全局 tablePrefix 且自行设置了 value 的值)(@since 3.1.1)

# @TableId

• 描述：主键注解

属性	类型	必须指定	默认值	描述
value	String	否	""	主键字段名
type	Enum	否	IdType.NONE	主键类型

# IdType

值	描述
AUTO	数据库自增
INPUT	自行输入
ID_WORKER	分布式全局唯一ID 长整型类型
UUID	32位UUID字符串
NONE	无状态
ID_WORKER_STR	分布式全局唯一ID 字符串类型

# @TableField

• 描述：字段注解(非主键)

属性	类型	必须指定	默认值	描述
value	String	否	""	字段名
el	String	否	""	映射为原生 #{ ... } 逻辑,相当于写在 xml 里的 #{ ... } 部分
exist	boolean	否	true	是否为数据库表字段
condition	String	否	""	字段 where 实体查询比较条件,有值设置则按设置的值为准,没有则为默认全局的 %s=#{%s},参考
update	String	否	""	字段 update set 部分注入(该属性优先级高于 el 属性)
strategy	Enum	否	FieldStrategy.DEFAULT	字段验证策略
fill	Enum	否	FieldFill.DEFAULT	字段自动填充策略
select	boolean	否	true	是否进行 select 查询
keepGlobalFormat	boolean	否	false	是否保持使用全局的 format 进行处理(@since 3.1.1)

# FieldStrategy

值	描述
IGNORED	忽略判断
NOT_NULL	非NULL判断
NOT_EMPTY	非空判断(只对字符串类型字段,其他类型字段依然为非NULL判断)
DEFAULT	追随全局配置

# FieldFill

值	描述
DEFAULT	默认不处理
INSERT	插入时填充字段
UPDATE	更新时填充字段
INSERT_UPDATE	插入和更新时填充字段

# @Version

• 描述：乐观锁注解、标记 @Verison 在字段上

# @EnumValue

• 描述：通枚举类注解(注解在枚举字段上)

# @TableLogic

• 描述：表字段逻辑处理注解（逻辑删除）

属性	类型	必须指定	默认值	描述
value	String	否	""	逻辑未删除值
delval	String	否	""	逻辑删除值

# @SqlParser

• 描述：租户注解 目前只支持注解在 mapper 的方法上(3.1.1开始支持注解在mapper上)

属性	类型	必须指定	默认值	描述
filter	boolean	否	false	过滤 SQL 解析

# @KeySequence

• 描述：序列主键策略 oracle
• 属性：value、resultMap

属性	类型	必须指定	默认值	描述
value	String	否	""	序列名
clazz	Class	否	Long.class	id的类型