@TableName

表名注解,在类名上面使用,通过value属性的值可以让MyBatis-Plus知道当前实体类对应的是数据库的哪一个表

该注解的属性如下表所示:

属性 类型 必须指定 默认值 描述
value String “” 表名
schema String “” schema
keepGlobalPrefix boolean false 是否保持使用全局的 tablePrefix 的值(如果设置了全局 tablePrefix 且自行设置了 value 的值)
resultMap String “” xml 中 resultMap 的 id
autoResultMap boolean false 是否自动构建 resultMap 并使用(如果设置 resultMap 则不会进行 resultMap 的自动构建并注入)
excludeProperty String[] {} 需要排除的属性名(@since 3.3.1)

@TableId

主键注解,在id字段上使用,value属性值填数据库中主键id的名称,type属性值填主键的规则

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

主键的规则type的值如下:

描述
IdType.AUTO 数据库ID自增
IdType.NONE 无状态,该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT)
IdType.INPUT insert前自行set主键值
IdType.ASSIGN_ID 分配ID(主键类型为Number(Long和Integer)或String)(since 3.3.0),使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法)
IdType.ASSIGN_UUID 分配UUID,主键类型为String(since 3.3.0),使用接口IdentifierGenerator的方法nextUUID(默认default方法)

除了通过type属性值来配置主键的规则外,还可以通过application.yml文件来配置

1
2
3
4
mybatis-plus:
global-config:
db-config:
id-type: auto #主键规则为自增

@TableField

字段注解(非主键),在实体类字段上使用,value属性值填数据库对应的字段名,exist属性值则填true(true则代表是数据库中的字段)或false(false则代表不是数据库中的字段),更多属性如下:

属性 类型 必须指定 默认值 描述
value String “” 数据库字段名
el String “” 映射为原生 #{ ... } 逻辑,相当于写在 xml 里的 #{ ... } 部分
exist boolean true 是否为数据库表字段
condition String “” 字段 where 实体查询比较条件,有值设置则按设置的值为准,没有则为默认全局的 %s=#{%s},参考(opens new window)
update String “” 字段 update set 部分注入, 例如:update=”%s+1”:表示更新时会set version=version+1(该属性优先级高于 el 属性)
insertStrategy Enum N DEFAULT 举例:NOT_NULL: insert into table_a(<if test="columnProperty != null">column</if>) values (<if test="columnProperty != null">#{columnProperty}</if>)
updateStrategy Enum N DEFAULT 举例:IGNORED: update table_a set column=#{columnProperty}
whereStrategy Enum N DEFAULT 举例:NOT_EMPTY: where <if test="columnProperty != null and columnProperty!=''">column=#{columnProperty}</if>
fill Enum FieldFill.DEFAULT 字段自动填充策略
select boolean true 是否进行 select 查询
keepGlobalFormat boolean false 是否保持使用全局的 format 进行处理
jdbcType JdbcType JdbcType.UNDEFINED JDBC类型 (该默认值不代表会按照该值生效)
typeHandler Class<? extends TypeHandler> UnknownTypeHandler.class 类型处理器 (该默认值不代表会按照该值生效)
numericScale String “” 指定小数点后保留的位数

@Version

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

@EnumValue

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

@TableLogic

表字段逻辑处理注解(逻辑删除)

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

@KeySequence

序列主键策略 oracle

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

@InterceptorIgnore

插件主体(必看!)(since 3.4.0) | MyBatis-Plus (baomidou.com)

@OrderBy

内置 SQL 默认指定排序,优先级低于 wrapper 条件查询

属性 类型 必须指定 默认值 描述
isDesc boolean 是否倒序查询
sort short Short.MAX_VALUE 数字越小越靠前