MyBatis-Plus 注解

MyBatis-Plus

@TableName

描述：表名注解

属性	类型	是否 必须 指定	默认值	描述
value	String	否	""	表名 若不指定，则默认为驼峰转下划线。例：类名为UserStudent，则对应表名为user_student
schema	String	否	""	schema
keepGlobalPrefix	boolean	否	false	是否保持使用全局的 tablePrefix 的值(如果设置了全局 tablePrefix 且自行设置了 value 的值)
resultMap	String	否	""	xml 中 resultMap 的 id
autoResultMap	boolean	否	false	是否自动构建 resultMap 并使用(若设置 resultMap 则不进行 resultMap 的自动构建并注入)。 mp会自动构建一个 ResultMap 并注入到 mybatis 里(一般用不上)。 因为mp底层是 mybatis，所以一些mybatis的常识你要知道，mp 只是帮你注入了常用 crud 到 mybatis 里 注入之前可以说是动态的(根据你 entity 的字段以及注解变化而变化)，但是注入之后是静态的(等于你写在xml的东西) 而对于直接指定 typeHandler，mybatis 只支持你写在2个地方： 1.定义在resultMap里,只作用于select查询的返回结果封装 2.定义在 insert 和 updatesql 的 #{property} 里的 property 后面(例：#{property,typehandler=xxx.xxx.xxx})，只作用于设置值 而除了这两种直接指定 typeHandler，mybatis 有一个全局的扫描你自己的 typeHandler 包的配置,这是根据你的 property 的类型去找 typeHandler 并使用

value

若数据库中所有表都有表名前缀，比如想让 t_user_info 表对应 UserInfo 实体类，可以添加如下全局配置设置表名前缀：

mybatis-plus.global-config.db-config.table-prefix=t_

若所有表名都不是下划线命名（但能跟类名对应上），比如想让 userinfo 表对应 UserInfo 实体类，可以添加如下全局配置，表示数据库表不使用下划线命名：

mybatis-plus.global-config.db-config.table-underline=false

value

若数据库中所有表都有表名前缀，比如想让 t_user_info 表对应 UserInfo 实体类，可以添加如下全局配置设置表名前缀：

mybatis-plus.global-config.db-config.table-prefix=t_

若所有表名都不是下划线命名（但能跟类名对应上），比如想让 userinfo 表对应 UserInfo 实体类，可以添加如下全局配置，表示数据库表不使用下划线命名：

mybatis-plus.global-config.db-config.table-underline=false

@TableId

描述：表名注解

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

IdType

属性名	描述
AUTO	数据库ID自增。 需要将数据库ID设为自增，否则会报错。
NONE	未设置主键类型（注解里等于跟随全局（全局里默认为ASSIGN_ID)）
INPUT	用户输入ID。（该类型可自己注册自动填充插件进行填充）。 若自己指定ID的值，则用指定的；若未指定ID的值且数据库ID是自增的，则用数据库的自增ID。
ASSIGN_ID	分配ID（主键类型为Number(Long和Integer)或String）(since 3.3.0)。 若自己指定了ID的值，则用指定的；若未指定ID的值，则程序会自动生成。 使用接口IdentifierGenerator的方法nextId（默认实现类为DefaultIdentifierGenerator雪花算法）
ASSIGN_UUID	分配UUID，主键类型为String(since 3.3.0)。 若自己指定了ID的值，则用指定的；若未指定ID的值，则程序会自动生成。 使用接口IdentifierGenerator的方法nextUUID。32位UUID字符串(please use ASSIGN_UUID)
ID_WORKER	分布式全局唯一ID 长整型类型(please use ASSIGN_ID)
UUID	32位UUID字符串(please use ASSIGN_UUID)
ID_WORKER_STR	分布式全局唯一ID 字符串类型(please use ASSIGN_ID)

@TableField

属性	类型	是否 必须 指定	默认值	描述
value	String	否	""	数据库字段名
el	String	否	""	映射为原生 #{ ... } 逻辑,相当于写在 xml 里的 #{ ... } 部分
exist	boolean	否	true	是否为数据库表字段
condition	String	否	""	字段 where 实体查询比较条件,有值设置则按设置的值为准,没有则为默认全局的 %s=#{%s},参考
update	String	否	""	字段 update set 部分注入, 例如：update="%s+1"：表示更新时会set version=version+1(该属性优先级高于 el 属性)
insertStrategy	Enum	否	DEFAULT	@TableField(insertStrategy= FieldStrategy.IGNORED)
updateStrategy	Enum	否	DEFAULT	举例：@TableField(updateStrategy = FieldStrategy.IGNORED)
whereStrategy	Enum	否	DEFAULT	举例：@TableField(whereStrategy= FieldStrategy.IGNORED)
fill	Enum	否	FieldFill.DEFAULT	字段自动填充策略
select	boolean	否	true	是否进行 select 查询
keepGlobalFormat	boolean	否	false	是否保持使用全局的 format 进行处理
jdbcType	JdbcType	否	JdbcType.UNDEFINED	JDBC类型 (该默认值不代表会按照该值生效)。 若不配合@TableName#autoResultMap = true一起使用,只生效于 update 的sql。
typeHandler	Class<? extends TypeHandler>	否	UnknownTypeHandler.class	类型处理器 (该默认值不代表会按照该值生效)。 若不配合@TableName#autoResultMap = true一起使用,只生效于 update 的sql。 如果你的字段类型和set进去的类型为equals关系,则只需要让你的typeHandler让Mybatis加载到即可,不需要使用注解。
numericScale	String	否	""	指定小数点后保留的位数。 numericScale只生效于 update 的sql

FieldStrategy

属性值	描述
IGNORED	忽略判断。即：无论是否是NULL都会写入。默认：NULL时不写入
NOT_NULL	非NULL判断。即：操作前判断是否是NULL，若是则不操作。
NOT_EMPTY	非空判断。(只对字符串类型字段,其他类型字段依然为非NULL判断)
DEFAULT	追随全局配置。（默认为NOT_NULL）

FieldFill

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

@Version

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

@EnumValue

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

@TableLogic

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

属性	类型	是否 必须 指定	默认值	描述
value	String	否	"0"	逻辑未删除值。
delval	String	否	"1"	逻辑删除值。 也可写为字段名，如：id，这样删除时会将id的值写到逻辑删除字段

@SqlParser

描述：租户注解,支持method上以及mapper接口上

属性	类型	是否 必须 指定	默认值	描述
filter	boolean	否	flase	true: 表示过滤SQL解析，即不会进入ISqlParser解析链，否则会进解析链并追加例如tenant_id等条件

@KeySequence

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

属性	类型	是否 必须 指定	默认值	描述
value	String	否	""	序列名
clazz	Class	否	Long.class	id的类型, 可以指定String.class，这样返回的Sequence值是字符串"1"

******************** 结束啦 ********************