MyBatis-Plus主键ID生成策略

2022-01-24 15:31:07 阅读：211 来源： 互联网

标签：String courseId private ID course Plus MyBatis 主键

原文地址：https://www.jianshu.com/p/a59ea9bc8132

MyBatis-Plus默认实现5种主键生成策略，分别是：

AUTO，配合数据库设置自增主键，可以实现主键的自动增长，类型为nmber；
INPUT，由用户输入；
NONE，不设置，等同于INPUT；
ASSIGN_ID，只有当用户未输入时，采用雪花算法生成一个适用于分布式环境的全局唯一主键，类型可以是String和number；
ASSIGN_UUID，只有当用户未输入时，生成一个String类型的主键，但不保证全局唯一；

1.1 自增主键

我们新建一个表zx_course，建表语句如下：

CREATE TABLE `zx_course` (
  `course_id` bigint(20) NOT NULL AUTO_INCREMENT,
  `course_name` varchar(100) NOT NULL,
  PRIMARY KEY (`course_id`)
) ENGINE=InnoDB AUTO_INCREMENT=5 DEFAULT CHARSET=utf8mb4

其中主键必须设置自增，否则如下程序插入数据时就会报错。

然后创建实体类，并标注主键的生成策略为AUTO：

@Data
@TableName("zx_course")
public class Course {
    @TableId(type = IdType.AUTO)
    private Long courseId;
    private String courseName;
}

基本配置就完成了，其余controller和mapper代码如下：

@RestController
public class CourseController {
    @Autowired
    private CourseMapper courseMapper;

    // 新增操作
    @PostMapping("/addCourse")
    public Integer addCourse(@RequestBody Course course){
        return courseMapper.insert(course);
    }
}

public interface CourseMapper extends BaseMapper<Course> {
}

这样就可以正常启动项目了。我们发起请求，不断/addCourse，请求参数中不指定courseId，只指定courseName，会发现插入数据库的数据主键是从1开始自增的。

如果此时我们指定courseId，是不会生效的。

1.2 用户输入

用户输入只要更改实体类的主键配置如下，数据库表主键的自增是否删除都不影响。

@TableId(type = IdType.INPUT)
private Long courseId;

此时我们调用/addCourse，请求参数中同时带上courseId和courseName，就能插入我们自己输入的主键了。

如果此时请求没有带上courseId，那么自增特性自动生效。

1.3 未指定

同INPUT的效果。

1.4 雪花算法生成ID

@TableId(type = IdType.ASSIGN_ID)
private Long courseId;

以上设置只有在用户没有输入courseId时，才会采用雪花算法生成一个主键，如果用户有输入，还是以用户输入的为准。当实体类中主键声明的是Long数值或者String类型时（不可以是Integer，否则报错），就会生成19位纯数字的主键；

1.5 UUID

@TableId(type = IdType.ASSIGN_UUID)
private String courseId;

以上设置只有在用户没有输入courseId时，才会生成一个32位的数字+字母组合的主键值，要求实体类中的类型必须是String，而且数据库对应的字段为varchar(32)；

1.6 Sequence

对于INPUT类型，一种情况是程序里面自己指定主键，还有一种是利用MyBatis-Plus自带的如下主键生成器生成：

DB2KeyGenerator
H2KeyGenerator
KingbaseKeyGenerator
OracleKeyGenerator
PostgreKeyGenerator

这些KeyGenerator都是实现IKeyGenerator接口，如果不能满足你，可以自己新建一个KeyGenerator，然后实现IKeyGenerator即可。

如何使用这些KeyGenerator呢？很简单，两个步骤即可。

在配置类中加上想要使用哪个KeyGenerator：

@Bean
public IKeyGenerator keyGenerator() {
    // 选择你要使用的KeyGenerator
    return new OracleKeyGenerator();
}

然后在实体类上声明@KeySequence，指定使用的Sequence名称，并指定主键类型为INPUT。

@Data
@TableName("zx_course")
@KeySequence(value = "my_oracle_sequence")
public class Course {
    @TableId(type = IdType.INPUT)
    private String courseId;
    private String courseName;
}

以上要求数据库中已经存在my_oracle_sequence这个序列，在使用时，会调用SELECT my_oracle_sequence.NEXTVAL FROM DUAL来获取一个序列填充到主键中。而且如果你是MySQL，就没有默认支持的KeyGenerator可以使用。

因此个人感觉不是很好用，还是UUID和雪花算法比较简单实用。

1.7 自定义ID生成器

在前面我们已经介绍了ASSIGN_ID，其默认是采用雪花算法实现的，我们可以自定义一个ID生成器。

@TableId(type = IdType.ASSIGN_ID)
private String courseId;

@Slf4j
@Component
public class CustomIdGenerator implements IdentifierGenerator {

    private final AtomicLong al = new AtomicLong(1);

    @Override
    public Long nextId(Object entity) {
        //可以将当前传入的class全类名来作为bizKey,或者提取参数来生成bizKey进行分布式Id调用生成.
        String bizKey = entity.getClass().getName();
        log.info("bizKey:{}", bizKey);
        MetaObject metaObject = SystemMetaObject.forObject(entity);
        String name = (String) metaObject.getValue("courseName");
        final long id = al.getAndAdd(1);
        log.info("为{}生成主键值->:{}", name, id);
        return id + 10000;
    }

}

如上配置内容就是覆盖默认的雪花算法，自己实现一个ID生成逻辑，满足特殊的ID生成业务场景。

2人点赞 ORM框架

作者：文景大大
链接：https://www.jianshu.com/p/a59ea9bc8132
来源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。

标签：String,courseId,private,ID,course,Plus,MyBatis,主键
来源： https://www.cnblogs.com/eyesfree/p/15839596.html

本站声明： 1. iCode9 技术分享网（下文简称本站）提供的所有内容，仅供技术学习、探讨和分享；
2. 关于本站的所有留言、评论、转载及引用，纯属内容发起人的个人观点，与本站观点和立场无关；
3. 关于本站的所有言论和文字，纯属内容发起人的个人观点，与本站观点和立场无关；
4. 本站文章均是网友提供，不完全保证技术分享内容的完整性、准确性、时效性、风险性和版权归属；如您发现该文章侵犯了您的权益，可联系我们第一时间进行删除；
5. 本站为非盈利性的个人网站，所有内容不会用来进行牟利，也不会利用任何形式的广告来间接获益，纯粹是为了广大技术爱好者提供技术内容和技术思想的分享性交流网站。

ICode9