Mybatis-Plus 常用注解

快乐的小三菊

已于 2024-03-01 10:18:04 修改

阅读量1k

点赞数

分类专栏： # Mybatis-Plus 文章标签： mybatis

于 2021-02-02 17:15:32 首次发布

本文链接：https://blog.csdn.net/xhf852963/article/details/113567184

版权

Mybatis-Plus 专栏收录该内容

11 篇文章 0 订阅

订阅专栏

一、@TableName 注解

1.1 说明

在使用 MyBatis-Plus 实现基本的 CRUD 时，我们并没有指定要操作的表，只是在 Mapper 接口继承 BaseMapper 时，设置了泛型 User，而操作的表为 user 表。

由此得出结论，MyBatis-Plus 在确定操作的表时，由 BaseMapper 的泛型决定，即实体类型决定，且默认操作的表名和实体类型的类名一致

1.2 问题

若实体类类型的类名和要操作的表的表名不一致，会出现什么问题？

我们将表 user 更名为 t_user，测试查询功能程序抛出异常，Table 'mybatis_plus.user' doesn't exist，因为现在的表名为 t_user，而默认操作的表名和实体类型的类名一致，即 user 表。

1.3 使用 @TableName 解决

在实体类类型上添加 @TableName，标识实体类对应的表，即可成功执行 sql 语句。

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

1.4 使用全局配置解决

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

# 配置MyBatis日志
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
    db-config:
    # 配置MyBatis-Plus操作表的默认前缀
      table-prefix: t_

二、@TableId 注解

2.1 说明

MyBatis-Plus 在实现 CRUD 时，会默认将 id 作为主键列，并在插入数据时，默认基于雪花算法的策略生成 id。

2.2 问题

若实体类和表中表示主键的不是 id，而是其他字段，例如 uid，MyBatis-Plus 会自动识别 uid 为主键列吗？

我们将实体类中的属性 id 改为 uid，将表中的字段 id 也改为 uid，测试添加功能程序抛出异常，Field 'uid' doesn't have a default value，说明 MyBatis-Plus 没有将 uid 作为主键赋值，如下图：

2.3 使用 @TableId 解决

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

@Data
public class User {

    // 将属性所对应的字段指定为主键
    @TableId
    private Long uid;
    private String name;
    private Integer age;
    private String email;
}

2.4 @TableId 的 value 属性

若实体类中主键对应的属性为 id，而表中表示主键的字段为 uid，此时若只在属性 id 上添加注解 @TableId，则抛出异常 Unknown column 'id' in 'field list'，即 MyBatis-Plus 仍然会将 id 作为表的主键操作，而表中表示主键的是字段 uid。如下图：

此时需要通过 @TableId 注解的 value 属性，指定表中的主键字段，@TableId("uid") 或 @TableId(value="uid")，如下：

@Data
public class User {

    // 将属性所对应的字段指定为主键
    @TableId("uid") 
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

2.5 @TableId 的 type 属性

type 属性用来定义主键策略，现在默认的主键生成策略为雪花算法，如果我们现在不想要雪花算法了，想要主键自动递增，此时就需要使用 type 属性了。

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

@Data
public class User {

    @TableId(value = "uid",type = IdType.AUTO)
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

也可以通过配置全局的主键策略来实现自动递增，如下：

# 配置MyBatis日志
mybatis-plus:
  configuration:
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl
  global-config:
    db-config:
    # 配置MyBatis-Plus操作表的默认前缀
      table-prefix: t_
      # 配置MyBatis-Plus的主键策略
      id-type: auto

三、@TableField 注解

MyBatis-Plus 在执行 SQL 语句时，要保证实体类中的属性名和表中的字段名一致，如果实体类中的属性名和字段名不一致的情况，会出现什么问题呢？

3.1 情况一

若实体类中的属性使用的是驼峰命名风格，而表中的字段使用的是下划线命名风格，例如实体类属性 userName，表中字段 user_name 此时 MyBatis-Plus 会自动将下划线命名风格转化为驼峰命名风格相当于在 MyBatis 中配置。

3.2 情况二

若实体类中的属性和表中的字段不满足情况一，例如实体类属性 name，表中字段 username，此时需要在实体类属性上使用 @TableField("username") 设置属性所对应的字段名，如下：

public class User {

    private Long id;

    @TableField("username")
    private String name;
    private Integer age;
    private String email;
}

四、@TableLogic 注解

4.1 逻辑删除

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

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

4.2 实现逻辑删除

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

然后在实体类中添加逻辑删除属性，如下

public class User {

    @TableId(value = "uid",type = IdType.AUTO)
    private Long id;

    @TableField("username")
    private String name;
    private Integer age;
    private String email;

    @TableLogic
    private Integer isDeleted;
}

测试删除功能，真正执行的是修改功能，如下图：