MyBatis-Plus 效能提升秘籍：掌握这些注解，事半功倍！

云端源想
更新于 2024-02-29 15:54
阅读 998

MyBatis-Plus是一个功能强大的MyBatis扩展插件，它提供了许多便捷的注解，让我们在开发过程中能够更加高效地完成数据库操作，本文将带你一一了解这些注解，并通过实例来展示它们的魅力。

## 一、@Tablename注解

这个注解用于指定实体类对应的数据库表名。如果你的表名和实体类名不一致，就需要用到它：

```
@TableName("user_info")
public class UserInfo {
    // 类的属性和方法
}
```

在上述代码中，即使实体类名为UserInfo，但通过@TableName注解，我们知道它对应数据库中的"user_info"表。

## 二、@Tableld注解

每个数据库表都有主键，@TableId注解用于标识实体类中的主键属性。通常与@TableName配合使用，确保主键映射正确。

```
AUTO(0),
NONE(1),
INPUT(2),
ASSIGN_ID(3),
ASSIGN_UUID(4),
/** @deprecated */
@Deprecated
ID_WORKER(3),
/** @deprecated */
@Deprecated
ID_WORKER_STR(3),
/** @deprecated */
@Deprecated
UUID(4);
```

![Description](https://ydcqoss.ydcode.cn/ydyx/bbs/1709105285-Og2k44.png)

* INPUT 如果开发者没有手动赋值，则数据库通过自增的方式给主键赋值，如果开发者手动赋值，则存入该值。
* AUTO 默认就是数据库自增，开发者无需赋值。
* ASSIGN_ID MP 自动赋值，雪花算法。
* ASSIGN_UUID 主键的数据类型必须是 String，自动生成 UUID 进行赋值。

```
// 自己赋值
    //@TableId(type = IdType.INPUT)
    // 默认使用的雪花算法，长度比较长，所以使用Long类型，不用自己赋值
    @TableId
    private Long id;
```

**测试**

```
@Test
    void save(){
        // 由于id加的有注解，这里就不用赋值了
        Student student = new Student();
        student.setName("天明");
        student.setAge(18);
        mapper.insert(student);
}
```

![Description](https://ydcqoss.ydcode.cn/ydyx/bbs/1709105364-4733V2.png)

### 雪花算法

雪花算法是由Twitter公布的分布式主键生成算法，它能够保证不同表的主键的不重复性，以及相同表的主键的有序性。

**核心思想：**

* 长度共64bit（一个long型）。
* 首先是一个符号位，1bit标识，由于long基本类型在Java中是带符号的，最高位是符号位，正数是0，负数是1，所以id一般是正数，最高位是0。
* 41bit时间截(毫秒级)，存储的是时间截的差值（当前时间截 - 开始时间截)，结果约等于69.73年。
* 10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID，可以部署在1024个节点）。
* 12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID）。

![Description](https://ydcqoss.ydcode.cn/ydyx/bbs/1709105413-9Tc48J.png)

**优点：** 整体上按照时间自增排序，并且整个分布式系统内不会产生ID碰撞，并且效率较高。

## 三、@TableField注解

当你的实体类属性名与数据库字段名不一致时，@TableField注解可以帮助你建立二者之间的映射关系。

* 映射非主键字段，value 映射字段名；
* exist 表示是否为数据库字段 false，如果实体类中的成员变量在数据库中没有对应的字段，则可以使用 exist，VO、DTO；
* select 表示是否查询该字段；
* fill 表示是否自动填充，将对象存入数据库的时候，由 MyBatis Plus 自动给某些字段赋值，create_time、update_time。

![Description](https://ydcqoss.ydcode.cn/ydyx/bbs/1709105492-v1c857.png)

### 自动填充

1）给表添加 create_time、update_time 字段。

![Description](https://ydcqoss.ydcode.cn/ydyx/bbs/1709105517-5WkT9C.png)

2）实体类中添加成员变量。

```
package com.md.entity;

import com.baomidou.mybatisplus.annotation.*;
import com.md.enums.StatusEnum;
import lombok.Data;
import java.util.Date;

@Data
@TableName(value = "student")
public class Student {
    @TableId
    private Long id;

// 当该字段名称与数据库名字不一致
    @TableField(value = "name")
    private String name;

// 不查询该字段
    @TableField(select = false)
    private Integer age;

// 当数据库中没有该字段，就忽略
    @TableField(exist = false)
    private String gender;

// 第一次添加填充
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

// 第一次添加的时候填充，但之后每次更新也会进行填充
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

}
```

3）创建自动填充处理器。

注意：不要忘记添加 @Component 注解。

```
package com.md.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.util.Date;

/**
 * @author md
 * @Desc 对实体类中使用的自动填充注解进行编写
 * @date 2020/10/26 17:29
 */
// 加入注解才能生效
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

@Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }

@Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}
```

4）测试

```
@Test
    void save(){
        // 由于id加的有注解，这里就不用赋值了
        Student student = new Student();
        student.setName("韩立");
        student.setAge(11);
        // 时间自动填充
        mapper.insert(student);
}
```

![Description](https://ydcqoss.ydcode.cn/ydyx/bbs/1709105597-Uy3g4d.png)

5）更新

当该字段发生变化的时候时间会自动更新。

```
@Test
    void update(){
        Student student = mapper.selectById(1001);
        student.setName("韩信");
        mapper.updateById(student);
}
```

![Description](https://ydcqoss.ydcode.cn/ydyx/bbs/1709105626-Hjd66C.png)

## 四、@TableLogic注解

在很多应用中，数据并不是真的被删除，而是标记为已删除状态。@TableLogic注解用于标识逻辑删除字段，通常配合逻辑删除功能使用。

### 1、逻辑删除

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

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

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

### 2、实现逻辑删除

**step1：** 数据库中创建逻辑删除状态列。\
![Description](https://ydcqoss.ydcode.cn/ydyx/bbs/1709105789-lze79J.png)

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

```
@TableLogic
@TableField(value = "is_deleted")
private Integer deleted;
```

### 3、测试

**测试删除：** 删除功能被转变为更新功能。

```
-- 实际执行的SQL
update user set is_deleted=1 where id = 1 and is_deleted=0
```

**测试查询：** 被逻辑删除的数据默认不会被查询。

```
-- 实际执行的SQL
select id,name,is_deleted from user where is_deleted=0
```

> 在这里给大家分享一下【云端源想】学习平台，无论你是初学者还是有经验的开发者，这里都有你需要的一切。包含课程视频、知识库、微实战、云实验室、一对一咨询等等，现在功能全部是免费的，[点击这里，立即开始你的学习之旅！](https://www.ydcode.cn/?sourceId=761)

## 五、@Version注解

乐观锁是一种并发控制策略，@Version注解用于标识版本号字段，确保数据的一致性。

### 乐观锁

![Description](https://ydcqoss.ydcode.cn/ydyx/bbs/1709105924-XtIg8L.png)\
标记乐观锁，通过 version 字段来保证数据的安全性，当修改数据的时候，会以 version 作为条件，当条件成立的时候才会修改成功。

version = 2

* 线程1：update … set version = 2 where version = 1
* 线程2：update … set version = 2 where version = 1

1.数据库表添加 version 字段，默认值为 1。

2.实体类添加 version 成员变量，并且添加 @Version。

```
package com.md.entity;

import com.baomidou.mybatisplus.annotation.*;
import com.md.enums.StatusEnum;
import lombok.Data;
import java.util.Date;

@Data
@TableName(value = "student")
public class Student {
    @TableId
    private Long id;
    @TableField(value = "name")
    private String name;
    @TableField(select = false)
    private Integer age;
    @TableField(exist = false)
    private String gender;
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;
    
    @Version
    private Integer version; //版本号
  
}
```

3.注册配置类

在 MybatisPlusConfig 中注册 Bean。

```
package com.md.config;

import com.baomidou.mybatisplus.extension.plugins.OptimisticLockerInterceptor;
import com.baomidou.mybatisplus.extension.plugins.PaginationInterceptor;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

/**
 * @author md
 * @Desc
 * @date 2020/10/26 20:42
 */
@Configuration
public class MyBatisPlusConfig {
    /**
    * 乐观锁
    */
    @Bean
    public OptimisticLockerInterceptor optimisticLockerInterceptor(){
        return new OptimisticLockerInterceptor();
    }
}
```

## 六、@EnumValue注解

mp框架对枚举进行处理的一个注解。

**使用场景：** 创建枚举类，在需要存储数据库的属性上添加@EnumValue注解。

```
public enum SexEnum {

MAN(1, "男"),
 WOMAN(2, "女");

@EnumValue
 private Integer key;
}
```

MyBatis-Plus的注解是开发者的好帮手，它们简化了映射配置，提高了开发效率。希望以上的介绍能帮助新手朋友们快速理解和运用这些常用注解，让你们在MyBatis-Plus的世界里游刃有余！记得实践是最好的学习方式，快去动手试试吧！

一、@Tablename注解

这个注解用于指定实体类对应的数据库表名。如果你的表名和实体类名不一致，就需要用到它：

@TableName("user_info")
public class UserInfo {
    // 类的属性和方法
}

在上述代码中，即使实体类名为UserInfo，但通过@TableName注解，我们知道它对应数据库中的"user_info"表。

二、@Tableld注解

每个数据库表都有主键，@TableId注解用于标识实体类中的主键属性。通常与@TableName配合使用，确保主键映射正确。

AUTO(0),
NONE(1),
INPUT(2),
ASSIGN_ID(3),
ASSIGN_UUID(4),
/** @deprecated */
@Deprecated
ID_WORKER(3),
/** @deprecated */
@Deprecated
ID_WORKER_STR(3),
/** @deprecated */
@Deprecated
UUID(4);

INPUT 如果开发者没有手动赋值，则数据库通过自增的方式给主键赋值，如果开发者手动赋值，则存入该值。
AUTO 默认就是数据库自增，开发者无需赋值。
ASSIGN_ID MP 自动赋值，雪花算法。
ASSIGN_UUID 主键的数据类型必须是 String，自动生成 UUID 进行赋值。

// 自己赋值
    //@TableId(type = IdType.INPUT)
    // 默认使用的雪花算法，长度比较长，所以使用Long类型，不用自己赋值
    @TableId
    private Long id;

测试

@Test
    void save(){
        // 由于id加的有注解，这里就不用赋值了
        Student student = new Student();
        student.setName("天明");
        student.setAge(18);
        mapper.insert(student);
}

雪花算法

雪花算法是由Twitter公布的分布式主键生成算法，它能够保证不同表的主键的不重复性，以及相同表的主键的有序性。

核心思想：

长度共64bit（一个long型）。
首先是一个符号位，1bit标识，由于long基本类型在Java中是带符号的，最高位是符号位，正数是0，负数是1，所以id一般是正数，最高位是0。
41bit时间截(毫秒级)，存储的是时间截的差值（当前时间截 - 开始时间截)，结果约等于69.73年。
10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID，可以部署在1024个节点）。
12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID）。

优点： 整体上按照时间自增排序，并且整个分布式系统内不会产生ID碰撞，并且效率较高。

三、@TableField注解

当你的实体类属性名与数据库字段名不一致时，@TableField注解可以帮助你建立二者之间的映射关系。

映射非主键字段，value 映射字段名；
exist 表示是否为数据库字段 false，如果实体类中的成员变量在数据库中没有对应的字段，则可以使用 exist，VO、DTO；
select 表示是否查询该字段；
fill 表示是否自动填充，将对象存入数据库的时候，由 MyBatis Plus 自动给某些字段赋值，create_time、update_time。

自动填充

1）给表添加 create_time、update_time 字段。

2）实体类中添加成员变量。

package com.md.entity;

import com.baomidou.mybatisplus.annotation.*;
import com.md.enums.StatusEnum;
import lombok.Data;
import java.util.Date;

@Data
@TableName(value = "student")
public class Student {
    @TableId
    private Long id;

    // 当该字段名称与数据库名字不一致
    @TableField(value = "name")
    private String name;

    // 不查询该字段
    @TableField(select = false)
    private Integer age;

    // 当数据库中没有该字段，就忽略
    @TableField(exist = false)
    private String gender;

    // 第一次添加填充
    @TableField(fill = FieldFill.INSERT)
    private Date createTime;

    // 第一次添加的时候填充，但之后每次更新也会进行填充
    @TableField(fill = FieldFill.INSERT_UPDATE)
    private Date updateTime;

}

3）创建自动填充处理器。

注意：不要忘记添加 @Component 注解。

package com.md.handler;

import com.baomidou.mybatisplus.core.handlers.MetaObjectHandler;
import org.apache.ibatis.reflection.MetaObject;
import org.springframework.stereotype.Component;

import java.util.Date;

/**
 * @author md
 * @Desc 对实体类中使用的自动填充注解进行编写
 * @date 2020/10/26 17:29
 */
// 加入注解才能生效
@Component
public class MyMetaObjectHandler implements MetaObjectHandler {

    @Override
    public void insertFill(MetaObject metaObject) {
        this.setFieldValByName("createTime", new Date(), metaObject);
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }

    @Override
    public void updateFill(MetaObject metaObject) {
        this.setFieldValByName("updateTime", new Date(), metaObject);
    }
}

4）测试

@Test
    void save(){
        // 由于id加的有注解，这里就不用赋值了
        Student student = new Student();
        student.setName("韩立");
        student.setAge(11);
        // 时间自动填充
        mapper.insert(student);
}

5）更新

当该字段发生变化的时候时间会自动更新。

@Test
    void update(){
        Student student = mapper.selectById(1001);
        student.setName("韩信");
        mapper.updateById(student);
}

四、@TableLogic注解

在很多应用中，数据并不是真的被删除，而是标记为已删除状态。@TableLogic注解用于标识逻辑删除字段，通常配合逻辑删除功能使用。

1、逻辑删除

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

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

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

2、实现逻辑删除

step1： 数据库中创建逻辑删除状态列。\

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

@TableLogic
@TableField(value = "is_deleted")
private Integer deleted;

3、测试

测试删除： 删除功能被转变为更新功能。

-- 实际执行的SQL
update user set is_deleted=1 where id = 1 and is_deleted=0

测试查询： 被逻辑删除的数据默认不会被查询。

-- 实际执行的SQL
select id,name,is_deleted from user where is_deleted=0

在这里给大家分享一下【云端源想】学习平台，无论你是初学者还是有经验的开发者，这里都有你需要的一切。包含课程视频、知识库、微实战、云实验室、一对一咨询等等，现在功能全部是免费的，点击这里，立即开始你的学习之旅！

五、@Version注解