MP-2 常用注解

MyBatis-Plus 提供的注解可以帮我们解决一些数据库与实体之间相互映射的问题。

1 @TableName

解决实体类的类名和要操作的表的表名不一致的问题

1.1 注解解决

在实体类类型上添加 @TableName("t_user")，标识实体类对应的表，即可成功执行 SQL 语句

@Data
@TableName("t_user")
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

1.2 全局配置解决

在开发的过程中，我们经常遇到以上的问题，即实体类所对应的表都有固定的前缀，例如 t_ 或 tbl_ 此时，可以使用 MyBatis-Plus 提供的全局配置，为实体类所对应的表名设置默认的前缀，那么就不需要在每个实体类上通过@TableName 标识实体类对应的表

mybatis-plus:
  global-config:
    db-config:
      # 设置实体类所对应的表的统一前缀
      table-prefix: t_

2 @TableId

MyBatis-Plus 在实现 CRUD 时，会默认将变量名为 id 的成员变量作为主键列，并在插入数据时，默认基于雪花算法的策略生成 id。如果没有，则不存在/报错。

2.1 注解解决

在实体类中 uid 属性上通过 @TableId 将其标识为主键，即可成功执行 SQL 语句

@Date
public class User {
    @TableId
    private Long uid;
    private String name;
    private Integer age;
    private String email;
}

2.2 @TableId 的 value 属性

若实体类中主键对应的属性为 id，而表中表示主键的字段为 uid，此时若只在属性 id 上添加注解@TableId，则抛出异常Unknown column ‘id’ in ‘field list’，即 MyBatis-Plus 仍然会将 id 作为表的主键操作，而表中表示主键的是字段 uid 此时需要通过@TableId 注解的 value 属性，指定表中的主键字段，@TableId("uid") 或 @TableId(value="uid")

2.3 @TableId 的 type 属性

type 属性用来定义主键策略：默认雪花算法

值	描述
IdType.ASSIGN_ID（默认）	基于雪花算法的策略生成数据 id，与数据库 id 是否设置自增无关
IdType.AUTO	使用数据库的自增策略，注意，该类型请确保数据库设置了 id 自增，

配置全局主键策略：

#MyBatis -Plus 相关配置
mybatis-plus:
  configuration:
    #配置日志
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
    db-config:
      #配置mp的主键策略为自增
      id-type: auto
      # 设置实体类所对应的表的统一前缀
      table-prefix: t_

3 @TbaleField

如果实体类中的属性名和字段名不一致的情况，会出现什么问题呢？

3.1 自动：驼峰 → 下划线

若实体类中的属性使用的是驼峰命名风格，而表中的字段使用的是下划线命名风格

例如实体类属性 userName，表中字段 user_name

此时 MyBatis-Plus 会自动将下划线命名风格转化为驼峰命名风格

3.2 注解解决

例如实体类属性 name，表中字段 username

此时需要在实体类属性上使用 @TableField("username") 设置属性所对应的字段名

public class User {
    @TableId("uid")
    private Long id;
    @TableField("username")
    private String name;
    private Integer age;
    private String email;
}

4 @TableLogic

4.1 逻辑删除

物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除的数据

逻辑删除：假删除，将对应数据中代表是否被删除字段的状态修改为“被删除状态”，之后在数据库中仍旧能看到此条数据记录

使用场景：可以进行数据恢复

4.2 实现逻辑删除

• 数据库中创建逻辑删除状态列，设置默认值为 0!
  

• 实体类中添加逻辑删除属性
  

• 测试删除功能，真正执行的是修改

  public void testDeleteById(){
      int result = userMapper.deleteById(1527472864163348482L);
      System.out.println(result > 0 ? "删除成功！" : "删除失败！");
      System.out.println("受影响的行数为：" + result);
  }

  

• 此时执行查询方法，查询的结果为自动添加条件 is_deleted=0