OceanBase使用@KeySequence和@TableId使得插入方法回显ID

@KeySequence 和 @TableId 是 MyBatis-Plus 提供的注解，用于处理数据库主键生成策略。以下是对这两个注解的详细解释以及它们如何配合使用：

---

1. 注解说明

@KeySequence

• 作用：指定主键生成的序列（Sequence），通常用于支持序列的数据库（如 Oracle、PostgreSQL）。
• 主要属性：
  • value：指定序列的名称。
  • dbType：指定数据库类型（如 DbType.ORACLE）。

@TableId

• 作用：标识实体类中的主键字段，并定义主键生成策略。
• 主要属性：
  • value：指定数据库表中对应的主键列名。
  • type：指定主键生成策略，常见的值包括：
    • IdType.AUTO：数据库自增（如 MySQL 的 AUTO_INCREMENT）。
    • IdType.INPUT：手动输入主键值。
    • IdType.ASSIGN_ID：MyBatis-Plus 自动分配 ID（默认是雪花算法生成的长整型 ID）。
    • IdType.ASSIGN_UUID：MyBatis-Plus 自动分配 UUID。

---

2. 使用场景

以下是 @KeySequence 和 @TableId 配合使用的典型场景：

场景描述

假设你正在使用 Oracle 数据库，表 POR_DATA_VIEW 的主键 ID 是通过序列 SEQ_POR_DATA_VIEW 生成的。你需要在插入数据时，从序列中获取主键值并赋值给实体对象的 ID 字段。

代码示例

import com.baomidou.mybatisplus.annotation.IdType;
import com.baomidou.mybatisplus.annotation.KeySequence;
import com.baomidou.mybatisplus.annotation.TableId;
import com.baomidou.mybatisplus.annotation.TableName;

@TableName("POR_DATA_VIEW") // 指定数据库表名
@KeySequence(value = "SEQ_POR_DATA_VIEW", dbType = DbType.ORACLE) // 指定序列
public class PorDataView {

    @TableId(value = "ID", type = IdType.INPUT) // 主键字段，手动输入
    private Long id;

    private String name;

    private String description;

    // Getter 和 Setter 方法
    public Long getId() {
        return id;
    }

    public void setId(Long id) {
        this.id = id;
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

---

3. 工作原理

1. 序列生成主键值：

   • 在插入数据之前，MyBatis-Plus 会根据 @KeySequence 中指定的序列名称（如 SEQ_POR_DATA_VIEW）调用数据库的 NEXTVAL 函数获取下一个序列值。
   • 获取到的序列值会被赋值给实体对象的主键字段（即 id）。

2. 手动输入主键值：

   • @TableId(type = IdType.INPUT) 表示主键值需要手动设置。
   • 如果你不显式设置主键值，MyBatis-Plus 不会自动填充主键值。

3. 插入操作：

   • 当你调用 MyBatis-Plus 的 insert 方法时，框架会先检查主键字段是否有值。
   • 如果没有值，框架会尝试从序列中获取主键值并填充到实体对象中，然后执行插入操作。

---

4. 注意事项

1. 数据库支持：

   • @KeySequence 通常用于支持序列的数据库（如 Oracle、PostgreSQL）。如果你使用的是不支持序列的数据库（如 MySQL），则不需要该注解。

2. 主键生成策略：

   • 如果你使用 IdType.INPUT，需要确保在插入数据之前为主键字段赋值。
   • 如果希望 MyBatis-Plus 自动管理主键值，可以考虑使用 IdType.ASSIGN_ID 或 IdType.ASSIGN_UUID。

3. 性能优化：

   • 对于高并发场景，建议避免频繁调用序列，因为序列的 NEXTVAL 操作可能会成为性能瓶颈。

---

5. 示例：插入数据

以下是一个插入数据的示例：

import com.baomidou.mybatisplus.extension.service.impl.ServiceImpl;
import org.springframework.stereotype.Service;

@Service
public class PorDataViewService extends ServiceImpl<PorDataViewMapper, PorDataView> {

    public void addPorDataView() {
        PorDataView porDataView = new PorDataView();
        // 不需要手动设置 ID，MyBatis-Plus 会从序列中获取值
        porDataView.setName("Test Name");
        porDataView.setDescription("Test Description");

        // 插入数据
        save(porDataView);
    }
}

在这个例子中，save 方法会自动从 SEQ_POR_DATA_VIEW 序列中获取主键值，并将其赋值给 porDataView 的 id 字段。

---

6. 总结

• @KeySequence 和 @TableId 的组合非常适合需要使用序列生成主键的场景。
• 确保数据库支持序列，并正确配置序列名称和主键生成策略。
• 根据实际需求选择合适的主键生成策略（如 IdType.INPUT 或其他类型）。

这种设计既优雅又高效，特别适合基于 MyBatis-Plus 的项目开发。