MyBatisPlus--常用注解

最新推荐文章于 2025-01-23 19:53:11 发布

lh_freak

最新推荐文章于 2025-01-23 19:53:11 发布

阅读量1.5k

点赞数 36

本文链接：https://blog.youkuaiyun.com/jlihan/article/details/145181636

版权

文章目录

@TableName
@TableId
@TableField
@TableLogic

@TableName

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

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

问题:

如果将数据库的表名改为t_user,实体类仍为User,执行方法则会报错

原因:

MyBatis-Plus 默认根据实体类名称推断表名。

解决办法:

1.使用@TableName注解,指定表名

//lombok注解
@Data
@ToString
@NoArgsConstructor
@AllArgsConstructor
//@TableName("t_user")
public class User {

    private Long id;

    private String name;

    private Integer age;

    private String email;

}

2.通过全局配置解决问题

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

@TableId

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

通过@TableId解决问题

问题:

如果将数据库表t_user,中的主键id字段改为uid,实体类中的主键为uid,执行出错

原因：

MyBatis-Plus 默认将 id 作为主键字段。如果数据库中的主键字段名是 uid，需要显式地告诉框架主键的字段名。

解决办法:

在实体类中uid属性上通过@TableId将其标识为主键

//lombok注解
@Data
@ToString
@NoArgsConstructor
@AllArgsConstructor
//@TableName("t_user")
public class User {
    
	@TableId
    private Long uid;

    private String name;

    private Integer age;

    private String email;

}

通过@TableId的value属性解决问题

问题:

如果将数据库表t_user,中的主键id字段改为uid,实体类中的主键为id,执行出错

原因：

MyBatis-Plus 默认将 id 作为主键字段。如果数据库中的主键字段名是 uid，需要显式地告诉框架主键的字段名。

解决办法:

在实体类中id属性上通过@TableId将其标识为主键,并通过@TableId注解的value属性,指定表中主键字段@TableId("uid")或@TableId(value="uid")

//lombok注解
@Data
@ToString
@NoArgsConstructor
@AllArgsConstructor
//@TableName("t_user")
public class User {
    
	@TableId("uid")
    private Long id;

    private String name;

    private Integer age;

    private String email;

}

@TableId的type属性

MyBatis-Plus 提供了多种主键生成策略，可以通过 @TableId 注解的 type 属性指定。

默认使用雪花算法的生成策略

常用的主键生成策略:

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

将主键生成方式改为自动递增

第一步:数据库设置主键为自动递增

第二步:设置@TableId的type属性为auto或者配置全局主键策略

//lombok注解
@Data
@ToString
@NoArgsConstructor
@AllArgsConstructor
//@TableName("t_user")
public class User {
    
	@TableId("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_
      id-type: auto

@TableField

经过以上的测试，我们可以发现， MyBatis-Plus在执行SQL语句时，要保证实体类中的属性名和表中的字段名一致

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

问题1:

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

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

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

相当于在MyBatis中配置

问题2:

若实体类中的属性和表中的字段不满足问题1

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

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

@Data
@ToString
@NoArgsConstructor
@AllArgsConstructor
//@TableName("t_user")
public class User {

    //@TableId(type = IdType.AUTO)
    @TableId
    private Long uid;

    @TableField("username")
    private String name;

    private Integer age;

    private String email;
}

@TableLogic

逻辑删除:

物理删除：真实删除，将对应数据从数据库中删除，之后查询不到此条被删除的数据
逻辑删除：假删除，将对应数据中代表是否被删除字段的状态修改为“被删除状态”，之后在数据库

中仍旧能看到此条数据记录
使用场景：可以进行数据恢复

实现逻辑删除:

1.在数据库中创建逻辑删除状态列,并设置默认值为0

2.在实体类中添加逻辑删除属性

@Data
@ToString
@NoArgsConstructor
@AllArgsConstructor
//@TableName("t_user")
public class User {

    //@TableId(type = IdType.AUTO)
    @TableId
    private Long uid;

    @TableField("username")
    private String name;

    private Integer age;

    private String email;

    //逻辑删除属性
    @TableLogic
    private Integer isDeleted;
}