MybatisPlus：常用注解

后端 MybatisPlus
发布时间 :
字数:2.2k 阅读 :
  1. @TableName
  2. @TableId
    1. 问题引入
    2. 使用 @TableId 标注主键
    3. @TableId的value属性
    4. TableId的type属性
  3. @TableField
  4. @TableLogic 逻辑删除
    1. 实现逻辑删除
    2. 配置

@TableName

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

若实体类类型的类名和要操作的表的表名不一致，表名为t_user，实体类为user，那么就会报如下错误

JDBC Connection [HikariProxyConnection@668152723 wrapping com.mysql.cj.jdbc.ConnectionImpl@1f6917fb] will not be managed by Spring
==>  Preparing: SELECT id,name,age,email FROM user
==> Parameters: 
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@ad3324b]

org.springframework.jdbc.BadSqlGrammarException: 
### Error querying database.  Cause: java.sql.SQLSyntaxErrorException: Table 'mybatis_plus.user' doesn't exist
### The error may exist in com/lin/mymybatisplusdemo/mapper/UserMapper.java (best guess)
### The error may involve defaultParameterMap
### The error occurred while setting parameters
### SQL: SELECT  id,name,age,email  FROM user
### Cause: java.sql.SQLSyntaxErrorException: Table 'mybatis_plus.user' doesn't exist
; bad SQL grammar []; nested exception is java.sql.SQLSyntaxErrorException: Table 'mybatis_plus.user' doesn't exist

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

@NoArgsConstructor
@AllArgsConstructor
@Data //lombok注解
@TableName("t_user")
public class User {
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

上面这个问题，还可以通过全局配置解决

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

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

@TableId

问题引入

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

如果把表的主键改为uid，实体的主键也改为uid，那么MyBatis-Plus会自动识别uid为主键列吗？

JDBC Connection [HikariProxyConnection@526981115 wrapping com.mysql.cj.jdbc.ConnectionImpl@41eb94bc] will not be managed by Spring
==>  Preparing: INSERT INTO t_user ( name, age, email ) VALUES ( ?, ?, ? )
==> Parameters: 张三(String), 23(Integer), zhangsan@atguigu.com(String)
Closing non transactional SqlSession [org.apache.ibatis.session.defaults.DefaultSqlSession@706eab5d]

org.springframework.dao.DataIntegrityViolationException: 
### Error updating database.  Cause: java.sql.SQLException: Field 'uid' doesn't have a default value
### The error may exist in com/lin/mymybatisplusdemo/mapper/UserMapper.java (best guess)
### The error may involve com.lin.mymybatisplusdemo.mapper.UserMapper.insert-Inline
### The error occurred while setting parameters
### SQL: INSERT INTO t_user  ( name, age, email )  VALUES  ( ?, ?, ? )
### Cause: java.sql.SQLException: Field 'uid' doesn't have a default value
; Field 'uid' doesn't have a default value; nested exception is java.sql.SQLException: Field 'uid' doesn't have a default value

程序抛出异常，Field 'uid' doesn't have a default value，说明MyBatis-Plus没有将uid作为主键赋值

使用 @TableId 标注主键

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

    @TableId // 标注主键
    private Long uid;
    private String name;
    private Integer age;
    private String email;
}

@TableId的value属性

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

org.springframework.jdbc.BadSqlGrammarException: 
### Error updating database.  Cause: java.sql.SQLSyntaxErrorException: Unknown column 'id' in 'field list'
### The error may exist in com/lin/mymybatisplusdemo/mapper/UserMapper.java (best guess)
### The error may involve com.lin.mymybatisplusdemo.mapper.UserMapper.insert-Inline
### The error occurred while setting parameters
### SQL: INSERT INTO t_user  ( id, name, age, email )  VALUES  ( ?, ?, ?, ? )
### Cause: java.sql.SQLSyntaxErrorException: Unknown column 'id' in 'field list'
; bad SQL grammar []; nested exception is java.sql.SQLSyntaxErrorException: Unknown column 'id' in 'field list'

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

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

    @TableId (value = "uid")// 标注主键
    private Long id;
    private String name;
    private Integer age;
    private String email;
}

TableId的type属性

type属性用来定义主键策略，主键策略有：

/**
 * 生成ID类型枚举类
 *
 * @author hubin
 * @since 2015-11-10
 */
@Getter
public enum IdType {
    /**
     * 数据库ID自增
     * <p>该类型请确保数据库设置了 ID自增 否则无效</p>
     */
    AUTO(0),
    /**
     * 该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT)
     */
    NONE(1),
    /**
     * 用户输入ID
     * <p>该类型可以通过自己注册自动填充插件进行填充</p>
     */
    INPUT(2),

    /* 以下3种类型、只有当插入对象ID 为空，才自动填充。 */
    /**
     * 分配ID (主键类型为number或string）, 
     * 默认实现类 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(雪花算法)
     *
     * @since 3.3.0
     */
    ASSIGN_ID(3),// 基于雪花算法的策略生成数据id
    /**
     * 分配UUID (主键类型为 string)
     * 默认实现类 {@link com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator}(UUID.replace("-",""))
     */
    ASSIGN_UUID(4);

    private final int key;

    IdType(int key) {
        this.key = key;
    }
}

假设设置为自增主键：

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

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

但是，会有这么一个报错：

org.springframework.dao.DataIntegrityViolationException: 
### Error updating database.  Cause: java.sql.SQLException: Field 'uid' doesn't have a default value
### The error may exist in com/lin/mymybatisplusdemo/mapper/UserMapper.java (best guess)
### The error may involve com.lin.mymybatisplusdemo.mapper.UserMapper.insert-Inline
### The error occurred while setting parameters
### SQL: INSERT INTO t_user  ( name, age, email )  VALUES  ( ?, ?, ? )
### Cause: java.sql.SQLException: Field 'uid' doesn't have a default value
; Field 'uid' doesn't have a default value; nested exception is java.sql.SQLException: Field 'uid' doesn't have a default value

只是因为，在数据库表中，user表没有设置主键自增。导致uid没有值。

配置全局主键策略

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

@TableField

如果实体类中的属性名和字段名不一致的情况

  • 情况1：若实体类中的属性使用的是驼峰命名风格，而表中的字段使用的是下划线命名风格，例如实体类属性userName，表中字段user_name
    • 此时MyBatis-Plus会自动将下划线命名风格转化为驼峰命名风格
  • 情况2：若实体类中的属性和表中的字段不满足情况1，例如实体类属性name，表中字段username
    • 此时需要在实体类属性上使用@TableField("username")设置属性所对应的字段名
@NoArgsConstructor
@AllArgsConstructor
@Data //lombok注解
@TableName("t_user")
public class User {

    @TableId (value = "uid",type = IdType.AUTO)// 标注主键
    private Long id;

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

@TableLogic 逻辑删除

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

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

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

实现逻辑删除

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

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

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

    @TableId (value = "uid",type = IdType.AUTO)// 标注主键
    private Long id;

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

    @TableLogic
    private Integer isDeleted;
}

  • step3：执行删除

        @Test
    public void testDeleteBatchIds(){
        //通过多个id批量删除
        //DELETE FROM user WHERE id IN ( ? , ? , ? )
        List<Long> idList = Arrays.asList(1L, 2L, 3L);
        int result = userMapper.deleteBatchIds(idList);
        System.out.println("受影响行数："+result);
    }

    实现上执行的是修改：

    Preparing: UPDATE t_user SET is_deleted=1 WHERE uid IN ( ? , ? , ? ) AND is_deleted=0

  • step4：执行查询

        @Test
    public void testSelectList2(){
        //selectList()根据MP内置的条件构造器查询一个list集合，null表示没有条件，即查询所有
        userMapper.selectList(null).forEach(System.out::println);
    }

    执行的SQL：

    Preparing: SELECT uid AS id,name,age,email,is_deleted FROM t_user WHERE is_deleted=0

配置

@TableLogic有两个属性：①value = “未删除的值，默认值为0” ；② delval = “删除后的值，默认值为1” 

    @TableLogic(value = "10",delval = "20")
    private Integer isDeleted;

如果像上面这么修改，那么执行的SQL，如下：

Preparing: UPDATE t_user SET is_deleted=20 WHERE uid IN ( ? , ? , ? ) AND is_deleted=10

Preparing: SELECT uid AS id,name,age,email,is_deleted FROM t_user WHERE is_deleted=10

也可以通过yaml进行全局配置

mybatis-plus:
  configuration:
    # 配置MyBatis日志
    log-impl: org.apache.ibatis.logging.stdout.StdOutImpl # 默认的实现类
  global-config:
    db-config:
      # 配置MyBatis-Plus操作表的默认前缀
      table-prefix: t_
      # 配置MyBatis-Plus的主键策略
      id-type: auto
      logic-delete-field: isDeleted # 全局逻辑删除字段名
      logic-delete-value: 5 # 逻辑已删除值，默认1
      logic-not-delete-value: 6 # 逻辑未删除值，默认0

执行的SQL，如下：

Preparing: UPDATE t_user SET is_deleted=5 WHERE uid IN ( ? , ? , ? ) AND is_deleted=6

Preparing: SELECT uid AS id,name,age,email,is_deleted FROM t_user WHERE is_deleted=6
转载请注明来源，欢迎对文章中的引用来源进行考证，欢迎指出任何有错误或不够清晰的表达。可以在下面评论区评论，也可以邮件至 1909773034@qq.com

赏

©2017 XieShaoLin

Built with Hexo and 3-hexo theme

×

喜欢就点赞,疼爱就打赏