注解

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

注解类包：

👉 mybatis-plus-annotation

@TableName

• 描述：表名注解

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

关于autoResultMap的说明:

从mp的原理上讲,因为底层是mybatis,所以一些mybatis的常识你要知道,mp只是帮你注入了常用crud注入之前可以说是动态的(根据你entity的字段以及注解变化而变化),但是注入之后是静态的(等于你写在xml的东西)而对于直接指定typeHandler,mybatis只支持你写在2个地方:

• 定义在resultMap里,只作用于select查询的返回结果封装
• 定义在insert和updatesql的#{property}里的property后面(例:#{property,typehandler=xxx.xxx.xxx}),只作用于设置值而除了这两种直接指定typeHandler,mybatis有一个全局的扫描你自己的typeHandler包的配置,这是根据你的property的类型去找typeHandler并使用这个属性的作用就是:如果你的property类型… todo

@TableId

• 描述：主键注解

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

IdType

@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 属性)
  strategy	Enum	否	FieldStrategy.DEFAULT	字段验证策略 3.1.2+使用下面3个替代
  insertStrategy	Enum	N	DEFAULT	举例：NOT_NULL: insert into table_a(<if test="columnProperty != null">column</if>) values (<if test="columnProperty != null">#{columnProperty}</if>) (since v_3.1.2)
  updateStrategy	Enum	N	DEFAULT	举例：IGNORED: update table_a set column=#{columnProperty} (since v_3.1.2)
  whereStrategy	Enum	N	DEFAULT	举例：NOT_EMPTY: where <if test="columnProperty != null and columnProperty!=''">column=#{columnProperty}</if> (since v_3.1.2)
  fill	Enum	否	FieldFill.DEFAULT	字段自动填充策略
  select	boolean	否	true	是否进行 select 查询
  keepGlobalFormat	boolean	否	false	是否保持使用全局的 format 进行处理(@since 3.1.1)

FieldStrategy

FieldFill

@Version

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

@EnumValue

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

@TableLogic

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

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

@SqlParser

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

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

@KeySequence

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

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