mybatisplus

注解

@TableName

  • 描述：表名注解，标识实体类对应的表
  • 使用位置：实体类
属性类型必须指定默认值描述
valueString否""表名
schemaString否""schema
keepGlobalPrefixboolean否false是否保持使用全局的 tablePrefix 的值（当全局 tablePrefix 生效时）
resultMapString否""xml 中 resultMap 的 id（用于满足特定类型的实体类对象绑定）
autoResultMapboolean否false是否自动构建 resultMap 并使用（如果设置 resultMap 则不会进行 resultMap 的自动构建与注入）
excludePropertyString[]否{}需要排除的属性名 @since 3.3.1

@TableId

  • 描述：主键注解
  • 使用位置：实体类主键字段
属性类型必须指定默认值描述
valueString否""主键字段名
typeEnum否IdType.NONE指定主键类型

IdType

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

@TableField

  • 描述：字段注解（非主键）
属性类型必须指定默认值描述
valueString否""数据库字段名
existboolean否true是否为数据库表字段
conditionString否""字段 where 实体查询比较条件，有值设置则按设置的值为准，没有则为默认全局的 %s=#{%s}，参考
updateString否""字段 update set 部分注入，例如：当在version字段上注解update="%s+1" 表示更新时会 set version=version+1 （该属性优先级高于 el 属性）
insertStrategyEnum否FieldStrategy.DEFAULT举例：NOT_NULLinsert into table_a(<if test="columnProperty != null">column</if>) values (<if test="columnProperty != null">#{columnProperty}</if>)
updateStrategyEnum否FieldStrategy.DEFAULT举例：IGNOREDupdate table_a set column=#{columnProperty}
whereStrategyEnum否FieldStrategy.DEFAULT举例：NOT_EMPTYwhere <if test="columnProperty != null and columnProperty!=''">column=#{columnProperty}</if>
fillEnum否FieldFill.DEFAULT字段自动填充策略
selectboolean否true是否进行 select 查询
keepGlobalFormatboolean否false是否保持使用全局的 format 进行处理
jdbcTypeJdbcType否JdbcType.UNDEFINEDJDBC 类型 (该默认值不代表会按照该值生效)
typeHandlerClass<? extends TypeHandler>否UnknownTypeHandler.class类型处理器 (该默认值不代表会按照该值生效)
numericScaleString否""指定小数点后保留的位数

FieldStrategy

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

FieldFill

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

@OrderBy

  • 描述：内置 SQL 默认指定排序，优先级低于 wrapper 条件查询
属性类型必须指定默认值描述
isDescboolean否true是否倒序查询
sortshort否Short.MAX_VALUE数字越小越靠前

lombok

注解

注解作用
@Getter类注解，代替 getter 方法。
@Setter类注解，代替 setter 方法。
@ToString类注解，生成 toString 方法。
@ToString.Exclude字段注解，排除不需要在 toString 中出现的字段。
@ToString.Include字段注解，标记需要出现在 toString 中的字段。
构造器相关注解
@NoArgsConstructor类注解，生成无参构造方法。
@AllArgsConstructor类注解，生成除static字段之外带有各参数的构造方法。
@RequiredArgsConstructor作用于类，生成包含 final 和 @NonNull 注解的成员变量的构造方法。
@EqualsAndHashCode根据类所拥有的非静态字段自动重写 equals() 方法和 hashCode() 方法。
@EqualsAndHashCode.Exclude排除字段在重写的 equals 方法和 hashCode 方法中。
@EqualsAndHashCode.Include指定字段在重写的 equals 方法和 hashCode 方法中。
@Data类注解，综合注解，包含 ：@Getter, @Setter, @ToString , @RequiredArgsConstructor, @EqualsAndHashCode。
@Value类注解，综合注解，包含：@Getter, @ToString, @RequiredArgsConstructor, @EqualsAndHashCode。