4.mybatis-plus-常用注解

1.@TableName

• 描述：表名注解，标识实体类对应的表
• 使用位置：实体类

将数据库中user表更名为mp_user

@TableName("mp_user")
public class User {private Long id;private String name;private Integer age;private String email;
}# 或者配置mybatis-plus全局配置
mybatis-plus:configuration:# 日志log-impl: org.apache.ibatis.logging.stdout.StdOutImpl#开启映射时驼峰命名map-underscore-to-camel-case: true# 设置mybatis-plus全局配置global-config:db-config:# 设置表名前缀table-prefix: mp_

参数说明

关于 autoResultMap 的说明：

MP会自动构建一个 resultMap 并注入到 MyBatis 里（一般用不上），请注意以下内容：

因为 MP 底层是 MyBatis，所以 MP 只是帮您注入了常用 CRUD 到MyBatis 里，注入之前是动态的（根据您的 Entity 字段以及注解变化而变化），但是注入之后是静态的（等于 XML 配置中的内容）。

而对于 typeHandler 属性，MyBatis 只支持写在 2 个地方:

1. 定义在 resultMap 里，作用于查询结果的封装
2. 定义在 insert 和 update 语句的 #{property} 中的 property 后面（例：#{property,typehandler=xxx.xxx.xxx}），并且只作用于当前 设置值

除了以上两种直接指定 typeHandler 的形式，MyBatis 有一个全局扫描自定义 typeHandler 包的配置，原理是根据您的 property 类型去找其对应的 typeHandler 并使用。

2.@TableId

• 描述：主键注解
• 使用位置：实体类主键字段

将mp_user表中id字段更改uid，mybatis-plus默认主键字段为id，不是id的话需要指定添加@TableId注解指定为主键

public class User {# 将字段uid映射为id,将数据库中设置为自增可以使用IdType@TableId(value = "uid",type = IdType.AUTO)private Long  id;private String name;private Integer age;private String email;
}

默认自增为雪花算法，可通过注解@TableId实现，也可以通过全局配置配置主键生成策略

mybatis-plus:
global-config:db-config:# 设置统一的主键生成策略id-type: auto

参数说明

1.@IdType

3.@TableField

• 描述：字段注解（非主键）

将mp_user表中name字段更改user_name，添加@TableField注解将user_name映射为name

@TableName("mp_user")
public class User {@TableIdprivate Long id;@TableField("user_name")private String name;private Integer age;private String email;
}

参数说明

关于jdbcType和typeHandler以及numericScale的说明:

numericScale只生效于 update 的 sql. jdbcType和typeHandler如果不配合@TableName#autoResultMap = true一起使用,也只生效于 update 的 sql. 对于typeHandler如果你的字段类型和 set 进去的类型为equals关系,则只需要让你的typeHandler让 Mybatis 加载到即可,不需要使用注解

1.@ieldStrategy

2.FieldFill

实现元对象处理器接口

@Data
public class User {......@TableField(value="create_time",fill = FieldFill.INSERT)private Date createTime;@TableField(value="update_time",fill = FieldFill.INSERT_UPDATE)private Date updateTime;
}@Component
public class MyObjectHandler implements MetaObjectHandler {@Overridepublic void insertFill(MetaObject metaObject) {//添加时填充的数据......this.setFieldValByName("createTime", new Date(), metaObject);this.setFieldValByName("updateTime", new Date(), metaObject);}
}

4.@Version

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

*数据库中添加version字段*

ALTER TABLE `user` ADD COLUMN `version` INT

实体类添加version字段并添加 @Version 注解

    @Version@TableField(fill = FieldFill.INSERT)private Integer version;

元对象处理器接口添加version的insert默认值

@Component
public class MyObjectHandler implements MetaObjectHandler {@Overridepublic void insertFill(MetaObject metaObject) {//添加时填充的数据......this.setFieldValByName("version", 1, metaObject);}
}

特别说明:

• 支持的数据类型只有 int,Integer,long,Long,Date,Timestamp,LocalDateTime

• 整数类型下 newVersion = oldVersion + 1

• newVersion 会回写到 entity 中

• 仅支持 updateById(id) 与 update(entity, wrapper) 方法

  在 update(entity, wrapper) 方法下, wrapper 不能复用!!!

在 MybatisPlusConfig 中注册 Bean

创建配置类

@EnableTransactionManagement
@Configuration
@MapperScan("com.atguigu.mybatis_plus.mapper")
public class MyOptimisticLockerInterceptor {/*** 乐观锁插件*/@Beanpublic OptimisticLockerInterceptor optimisticLockerInterceptor() {return new OptimisticLockerInterceptor();}
}

# 测试/*** 测试 乐观锁插件*/
@Test
public void testOptimisticLocker() {//查询User user = userMapper.selectById(1L);//修改数据user.setName("Helen Yao");user.setEmail("helen@qq.com");//执行更新userMapper.updateById(user);
}

5.@EnumValue

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

6.@TableLogic

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

数据库中添加 deleted字段

手动添加在数据库中可添加字段`is_deleted`，数据类型为`int`，默认值为`0`
# 或
ALTER TABLE `user` ADD COLUMN `deleted` boolean

实体类添加deleted字段

并加上 @TableLogic 注解 和 @TableField(fill = FieldFill.INSERT) 注解

    @TableLogic@TableField(fill = FieldFill.UPDATE)private Integer isDeleted;

元对象处理器接口添加deleted的insert默认值

@Component
public class MyObjectHandler implements MetaObjectHandler {@Overridepublic void insertFill(MetaObject metaObject) {//添加时填充的数据//0-未删除  1-已删除......this.setFieldValByName("is_deleted", 0, metaObject);}
}@Component
public class MpInterceptor {/*** 创建乐观锁拦截器，存入Spring容器* 拦截生成的sql语句，注入版本号的字段*/@Beanpublic OptimisticLockerInterceptor optimisticLockerInterceptor() {return new OptimisticLockerInterceptor();}
}

全局配置

mybatis-plus:global-config:db-config:# versionlogic-delete-field: is_deleted # 全局逻辑删除的实体字段名logic-delete-value: 1 # 逻辑已删除值(默认为 1)logic-not-delete-value: 0 # 逻辑未删除值(默认为 0)

7.@KeySequence

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

8.@InterceptorIgnore

• value 值为 1 | yes | on 视为忽略，例如 @InterceptorIgnore(tenantLine = "1")
• value 值为 0 | false | off | 空值不变 视为正常执行。

9.@OrderBy

• 描述：内置 SQL 默认指定排序，优先级低于 wrapper 条件查询