mybatis-plus 如何使用雪花算法ID生成策略

目录

• mybatis-plus 可以通过@TableId注解指定主键生成策略
• 看一下源码大概找一下雪花算法的实现方式
• 自定义ID生成器实现
• Mybatis-plus 中生成雪花算法id的工具类

mybatis-plus 可以通过@TableId注解指定主键生成策略

@TableId(value="id",type=IdType.ASSIGN_ID)

值	描述
AUTO	数据库ID自增
NONE	无状态,该类型为未设置主键类型(注解里等于跟随全局,全局里约等于 INPUT)
INPUT	insert前自行set主键值
ASSIGN_ID	分配ID(主键类型为Number(Long和Integer)或String)(since 3.3.0),使用接口IdentifierGenerator的方法nextId(默认实现类为DefaultIdentifierGenerator雪花算法)
ASSIGN_UUID	分配UUID,主键类型为String(since 3.3.0),使用接口IdentifierGenerator的方法nextUUID(默认default方法)
ID_WORKER	分布式全局唯一ID 长整型类型(please use ASSIGN_ID)
UUID	32位UUID字符串(please use ASSIGN_UUID)
ID_WORKER_STR	分布式全局唯一ID 字符串类型(please use ASSIGN_ID)

上面的注解设置了值，对应在MybatisDefaultParameterHandler中有判断这个类型和设置ID的处理，判断idType.getKey() == IdType.ASSIGN_ID.getKey()时，使用identifierGenerator.nextId(entity)创建了一个雪花算法ID。

    protected static void populateKeys(TableInfo tableInfo, MetaObject metaObject, Object entity) {
        IdType idType = tableInfo.getIdType();
        String keyProperty = tableInfo.getKeyProperty();
        if (StringUtils.isNotBlank(keyProperty) && null != idType && idType.getKey() >= 3) {
            IdentifierGenerator identifierGenerator = GlobalConfigUtils.getGlobalConfig(tableInfo.getConfiguration()).getIdentifierGenerator();
            Object idValue = metaObject.getValue(keyProperty);
            if (StringUtils.checkValNull(idValue)) {
                if (idType.getKey() == IdType.ASSIGN_ID.getKey()) {
                    if (Number.class.isAssignableFrom(tableInfo.getKeyType())) {
                        metaObject.setValue(keyProperty, identifierGenerator.nextId(entity));
                    } else {
                        metaObject.setValue(keyProperty, identifierGenerator.nextId(entity).toString());
                    }
                } else if (idType.getKey() == IdType.ASSIGN_UUID.getKey()) {
                    metaObject.setValue(keyProperty, identifierGenerator.nextUUID(entity));
                }
            }
        } 
    }

3.X版本后默认就是使用 IdType.ASSIGN_ID，即雪花算法，如果需要使用主键自增，则需要修改IdType.AUTO

看一下源码大概找一下雪花算法的实现方式

首先来看主键生成策略的接口是IdentifierGenerator。mp中默认有一个实现类就是DefaultIdentifierGenerator，这个就是雪花算法的实现类。这个类中使用的Sequence就是雪花算法的实现类了。

如果想自己创建雪花算法手动创建ID怎么办

com.baomidou.mybatisplus.core.toolkit包下有一个IdWork的类，这个类就是使用上面的DefaultIdentifierGenerator来获取雪花算法ID，我们可以直接使用IdWork同名方法getId或者getIdStr来手动获取一个雪花算法ID。

Long id=IdWorker.getIdStr()

自定义ID生成器实现

第一种，使用spring扫描注解创建bean使用

@Component
public class CustomIdGenerator implements IdentifierGenerator {
    @Override
    public Long nextId(Object entity) {
       //可以将当前传入的class全类名来作为bizKey,或者提取参数来生成bizKey进行分布式Id调用生成.
       String bizKey = entity.getClass().getName();
        //根据bizKey调用分布式ID生成
        long id = ....;
       //返回生成的id值即可.
        return id;
    }
}

第二种，直接把写好的CustomIdGenerator实现类配置为一个bean

@Bean
public IdentifierGenerator idGenerator() {
    return new CustomIdGenerator();
}

Mybatis-plus 中生成雪花算法id的工具类

public static void main(String[] args) {
    // 返回值  1385106677482582018
    System.out.println(IdWorker.getId());
    // 返回值 "1385106677482582019"
    System.out.println(IdWorker.getIdStr());
}

以上为个人经验，希望能给大家一个参考，也希望大家多多支持脚本之家。