💎迄今为止最全面的分布式主键ID生成器。 💎优化的雪花算法(SnowFlake)——雪花漂移算法

Overview

雪花算法里最好用的主键ID生成工具

技术支持

开源地址1:https://github.com/yitter/IdGenerator

开源地址2:https://gitee.com/yitter/IdGenerator

QQ群:646049993

💎 算法介绍

这是优化的雪花算法(雪花漂移),它生成的ID更短、速度更快。

支持 k8s 等容器环境自动扩容(自动注册 WorkerId),可在单机或分布式环境生成数字型唯一ID。

原生支持 C#/Java/Go/Rust/C/SQL 等语言,并提供 PHP 扩展及 Python、Node.js 多线程安全调用动态库(FFI)。

兼容所有雪花算法(号段模式或经典模式,大厂或小厂),将来你可做任意的升级切换。(一般无须升级,但理论上支持)

这是计算机历史上最全面的雪花ID生成工具,期待你来超越 😀

需求来源

💧 作为架构设计的你,想要解决数据库主键唯一的问题,特别是在分布式系统多数据库中。

💧 你希望数据表主键用最少的存储空间,索引速度更快,Select、Insert 和 Update 更迅速。

💧 你要考虑在分库分表(合库合表)时,主键值可直接使用,并能反映业务时序。

💧 如果这样的主键值太长,超过前端 js Number 类型最大值,须把 Long 型转换为 String 型,你会觉得有点沮丧。

💧 尽管 Guid 能自增,但占用空间大,索引速度慢,你不想用它。

💧 应用实例可能超过50个,每个并发请求可达10W/s。

💧 要在容器环境部署应用,支持水平复制、自动扩容。

💧 不想依赖 redis 的自增操作获得连续的主键ID,因为连续的ID存在业务数据安全风险。

💧 你希望系统运行 100 年以上。

传统算法问题

生成的ID太长。

瞬时并发量不够。

不能解决时间回拨问题。

不支持后补生成前序ID。

可能依赖外部存储系统。

新算法特点

整形数字,随时间单调递增(不一定连续),长度更短,用50年都不会超过 js Number类型最大值。(默认配置)

速度更快,是传统雪花算法的2-5倍,0.1秒可生成50万个(基于8代低压i7)。

支持时间回拨处理。比如服务器时间回拨1秒,本算法能自动适应生成临界时间的唯一ID。

支持手工插入新ID。当业务需要在历史时间生成新ID时,用本算法的预留位能生成5000个每秒。

不依赖任何外部缓存和数据库。(k8s环境下自动注册 WorkerId 的动态库依赖 redis)

基础功能,开箱即用,无需配置文件、数据库连接等。

性能数据

(参数:10位自增序列,1000次漂移最大值)

连续请求量 5K 5W 50W
传统雪花算法 0.0045s 0.053s 0.556s
雪花漂移算法 0.0015s 0.012s 0.113s

💍 极致性能:500W/s~3000W/s。(所有测试数据均基于8代低压i7计算)

如何处理时间回拨

🔶 当发生系统时间回拨时,算法采用过去时序的预留序数生成新的ID。

🔶 回拨生成的ID序号,默认靠前,也可以调整为靠后。

🔶 允许时间回拨至本算法预设基数(参数可调)。

💎 ID组成说明

  • 本算法生成的ID由3部分组成(沿用雪花算法定义):
  • +-------------------------+--------------+----------+
  • | 1.相对基础时间的时间差 | 2.WorkerId | 3.序列数 |
  • +-------------------------+--------------+----------+
  • 第1部分,时间差,是生成ID时的系统时间减去 BaseTime 的总时间差(毫秒单位)。
  • 第2部分,WorkerId,是区分不同机器或不同应用的唯一ID,最大值由 WorkerIdBitLength(默认6)限定。
  • 第3部分,序列数,是每毫秒下的序列数,由参数中的 SeqBitLength(默认6)限定。

ID示例

🟣 本算法生成的 ID ,是整数(占用空间最多8字节),以下是基于默认配置生成的ID:

129053495681099        (运行1年)
387750301904971        (运行3年)
646093214093387        (运行5年)
1292658282840139       (运行10年)
9007199254740992       (js Number 最大值)
165399880288699493     (普通雪花算法生成的ID)

🟣 本算法生成的 ID 值,是 js Number 最大值的 1%-10%,是普通雪花算法值的千分之一,而生成速度却超过普通雪花算法。

🟣 js Number 类型最大数值:9007199254740992,本算法在保持并发性能(5W+/0.01s)和最大64个 WorkerId(6bit)的同时,能用70年才到 js Number Max 值。

长度估算

💍 每增加 1位 WorkerIdBitLength 或 SeqBitLength,生成的ID数字值将会乘以2(基础长度可参考前一节“ID示例”),反之则除以2。

能用多久

能用多久的解释,是指生成的ID数字,何时能增长到超过 long(有符号64位,8字节)最大值。

🔵 在默认配置下,ID可用 71000 年不重复。

🔵 在支持 1024 个工作节点时,ID可用 4480 年不重复。

🔵 在支持 4096 个工作节点时,ID可用 1120 年不重复。

💎 参数设置

WorkerIdBitLength,机器码位长,决定 WorkerId 的最大值,默认值6,取值范围 [1, 19],实际上有些语言采用 无符号 ushort (uint16) 类型接收该参数,所以最大值是16,如果是采用 有符号 short (int16),则最大值为15。

WorkerId,机器码,最重要参数,无默认值,必须 全局唯一,必须 程序设定,缺省条件(WorkerIdBitLength取默认值)时最大值63,理论最大值 2^WorkerIdBitLength-1(不同实现语言可能会限定在 65535 或 32767,原理同 WorkerIdBitLength 规则)。不同机器或不同应用实例 不能相同,你可通过应用程序配置该值,也可通过调用外部服务获取值。针对自动注册WorkerId需求,本算法提供默认实现:通过 redis 自动注册 WorkerId 的动态库,详见“Tools\AutoRegisterWorkerId”。

特别提示:如果一台服务器部署多个独立服务,需要为每个服务指定不同的 WorkerId。

SeqBitLength,序列数位长,默认值6,取值范围 [3, 21](建议不小于4),决定每毫秒基础生成的ID个数。规则要求:WorkerIdBitLength + SeqBitLength 不超过 22。

MinSeqNumber,最小序列数,默认值5,取值范围 [5, MaxSeqNumber],每毫秒的前5个序列数对应编号0-4是保留位,其中1-4是时间回拨相应预留位,0是手工新值预留位。

MaxSeqNumber,最大序列数,设置范围 [MinSeqNumber, 2^SeqBitLength-1],默认值0,真实最大序列数取最大值(2^SeqBitLength-1),不为0时,取其为真实最大序列数,一般无需设置,除非多机共享WorkerId分段生成ID(此时还要正确设置最小序列数)。

BaseTime,基础时间(也称:基点时间、原点时间、纪元时间),有默认值(2020年),是毫秒时间戳(是整数,.NET是DatetTime类型),作用是:用生成ID时的系统时间与基础时间的差值(毫秒数)作为生成ID的时间戳。基础时间一般无需设置,如果觉得默认值太老,你可以重新设置,不过要注意,这个值以后最好不变。

常规集成

1️⃣ 用单例模式调用。外部集成方使用更多的实例并行调用本算法,不会增加ID产出效能,因为本算法采用单线程生成ID。

2️⃣ 指定唯一的 WorkerId。必须由外部系统确保 WorkerId 的全局唯一性,并赋值给本算法入口方法。

3️⃣ 单机多实例部署时使用不同 WorkerId。并非所有实现都支持跨进程的并发唯一,保险起见,在同一主机上部署多应用实例时,请确保各 WorkerId 唯一。

4️⃣ 异常处理。算法会抛出所有 Exception,外部系统应 catch 异常并做好应对处理,以免引发更大的系统崩溃。

5️⃣ 认真理解 IdGeneratorOptions 的定义,这对集成和使用本算法有帮助。

6️⃣ 使用雪花漂移算法。虽然代码里包含了传统雪花算法的定义,并且你可以在入口处指定(Method=2)来启用传统算法,但仍建议你使用雪花漂移算法(Method=1,默认的),毕竟它具有更好的伸缩力和更高的性能。

7️⃣ 不要修改核心算法。本算法内部参数较多,逻辑较为复杂,在你尚未掌握核心逻辑时,请勿尝试修改核心代码且用于生产环境,除非通过大量细致、科学的测试验证。

8️⃣ 应用域内配置策略相同。当系统运行一段时间后,项目需要从程序指定 WorkerId 转到自动注册 WorkerId 时,请确保同一应用域内所有在用实例采用一致的配置策略,这不仅仅针对 WorkerId,也包含其他所有配置参数。

9️⃣ 管理好服务器时间。雪花算法依赖系统时间,不要手工大幅度回调操作系统时间。如果一定要调整,切记:确保服务再次启动时的系统时间大于最后一次关闭时的时间。(注:世界级或网络级的时间同步、回拨,引起的系统时间小幅度变化,对本算法没影响)

配置变更

配置变更指是系统运行一段时间后,再调整运行参数(IdGeneratorOptions 选项值),请注意:

🔴 1.最重要的一条原则是:BaseTime 只能往前(比老值更小、距离现在更远)赋值,原因是往后赋值极大可能产生相同的时间戳。[不推荐在系统运行之后调整 BaseTime]

🔴 2.任何时候增加 WorkerIdBitLength 或 SeqBitLength,都是可以的,但是慎用 “减小”的操作,因为这可能导致在未来某天生成的 ID 与过去老配置时相同。[允许在系统运行之后增加任何一个 BitLength 值]

🔴 3.如果必须减小 WorkerIdBitLength 或 SeqBitLength 其中的一项,一定要满足一个条件:新的两个 BitLength 之和要大于 老的值之和。[不推荐在运行之后缩小任何一个 BitLength 值]

🔴 4.上述3条规则,并未在本算法内做逻辑控制,集成方应根据上述规则做好影响评估,确认无误后,再实施配置变更。

自动注册WorkerId

🔍 唯一ID生成器,依赖WorkerId,当业务服务需要水平无差别复制(自动扩容)时,这就要求能自动注册全局唯一WorkerId,然后才能生产唯一ID。

🔍 本算法提供开源动态库(go语言实现),能在容器 k8s 等容器环境下,通过 redis 自动注册 WorkerId。

🔍 通过redis注册WorkerId,并非唯一方法。你还可以开发中心化的配置服务,各端点服务启动时,通过中心服务获取唯一 WorkerId。

🔍 当然,如果你的服务无需自动扩容,那就不必自动注册WorkerId,而是为它们分别设置全局唯一值。

🔍 更多方法源自你出色的想象力,此处抛砖引玉地举例,如:开发中心化的ID生成服务,由它为各端点服务(单个或批量)生成可用ID。

自动注册流程图

图片链接:https://gitee.com/yitter/idgenerator/blob/master/Tools/AutoRegisterWorkerId/regprocess.jpg

源码路径:/Go/source/regworkerid/reghelper.go

动态库下载

下载链接:https://gitee.com/yitter/idgenerator/attach_files/662372/download/regworkerid_lib_v1.0.zip

动态库接口定义

// 注册一个 WorkerId,会先注销所有本机已注册的记录
// ip: redis 服务器地址
// port: redis 端口
// password: redis 访问密码,可为空字符串“”
// maxWorkerId: 最大 WorkerId
extern GoInt32 RegisterOne(char* ip, GoInt32 port, char* password, GoInt32 maxWorkerId);

// 注销本机已注册的 WorkerId
extern void UnRegister();

// 检查本地WorkerId是否有效(0-有效,其它-无效)
extern GoInt32 Validate(GoInt32 workerId);

已实现的语言

语言 github gitee
🌲 C# 查看示例 查看示例
🌲 Java 查看示例 查看示例
🌲 Go 查看示例 查看示例
🌲 Rust 查看示例 查看示例
🌲 C 查看示例 查看示例
🌲 C (PHP扩展) 查看示例 查看示例
🌲 V 查看示例 查看示例
🌲 D 查看示例 查看示例
Comments
  • 单核跑极限是怎么限制的,我只能跑10w/s

    单核跑极限是怎么限制的,我只能跑10w/s

    step := 200000 fmt.Println("start") t := utils.LocalMilliscond() for i := 0; i < step; i++ { idgen.NextId() } fmt.Printf("check total cost %d ms\n", utils.LocalMilliscond()-t) check total cost 2013 ms

    当step设置成100000的时候,耗时是22ms,但是设置200000的时候,耗时就需要2013ms

    opened by ankye 4
  • 第一次生成的id会有重复的

    第一次生成的id会有重复的

    Parallel.For(0, 10, i =>
      {
    
          long a = YitIdHelper.NextId();
          lock (this)
          {
              File.AppendAllText("e:\\1.txt", a.ToString() + "\r\n");
          }
      });
    

    以上代码第一次生成的ID 中有重复的,但是后续的没有 以下是我将以上代码执行两次的文本,可以看到在第一次中,有大量的重复,但是后续永远也不会出现重复

    294807880151109
    294807880155205
    294807880155205
    294807880155205
    294807880155205
    294807880155205
    294807880155205
    294807880155205
    294807880155205
    294807880155205
    
    294807939739717
    294807939739718
    294807939739719
    294807939739720
    294807939739723
    294807939739722
    294807939739725
    294807939739721
    294807939739724
    294807939739726
    
    opened by Linlccc 3
  • id生成速度有问题

    id生成速度有问题

    这是我写的Java代码,生成50w条id,用时8004毫秒,而生成10w条id,用时是8ms,请问这是什么情况

    IdGeneratorOptions options = new IdGeneratorOptions((short) 1);
    YitIdHelper.setIdGenerator(options);
    long start = System.currentTimeMillis();
    for (int i = 0; i < 500000; i++) {
        YitIdHelper.nextId();
    }
    long end = System.currentTimeMillis();
    System.out.println(end - start); // 8004
    
    opened by wanlinMa-163 3
  • ID 使用ORM 的 default 字段生成,在几十秒内生成的 ID 都一样?

    ID 使用ORM 的 default 字段生成,在几十秒内生成的 ID 都一样?

    model定义:

    class Profile(models.Model): id = fields.BigIntField(pk=True, default=snowflake.next_id(seq_bit_length=7))

    生成代码:

     from snowflake.source import options, generator, idregister
     from settings.constants import RedisConfig
    
    
    def next_id(seq_bit_length=6):
        # 连接redis
        register = idregister.Register(host=RedisConfig().redis_product_list[0], port=RedisConfig().redis_product_list[1],
                                       password=RedisConfig().redis_product_list[2])
        # 获取worker id
        worker_id = register.get_worker_id()
        option = options.IdGeneratorOptions(worker_id=worker_id, seq_bit_length=seq_bit_length)
        # option.base_time = time.time()
        idgen = generator.DefaultIdGenerator()
        idgen.set_id_generator(option)
        uid = idgen.next_id()
        register.stop()
        return uid
    

    重复:

    { "data": {}, "message": "duplicate key value violates unique constraint \"account_verifycode_pkey\"\nDETAIL: Key (id)=(1541283244287430) already exists.", "code": 0 }

    opened by iyuhang 2
  • 自动注册WorkerId疑问?

    自动注册WorkerId疑问?

    按照您提供的自动注册思路,我自己在项目中实现了自动注册WorkerId,数值范围为[1,65535],当应用程序启动时会根据此范围产生一个随机数,写入到redis(采用了lua脚本来写入保证原子性),如果已存在会一直尝试创建新的随机数继续写入直到写入成功,程序关闭清除相关key,如果新启动的应用程序随机到了以前生成的随机数值,那么这个时候会不会产生已经生成过的雪花id呢?感觉我这个疑问很滑稽.. 只要时间没有回拨,应该不会重复吧.

    opened by 867824092 2
  • 50万个id为什么生成特别慢

    50万个id为什么生成特别慢

    var options = new IdGeneratorOptions(1);
    YitIdHelper.SetIdGenerator(options);
    Stopwatch sw = new Stopwatch();
    for (int i = 0; i < 500000; i++)
    {
        //ShardingFactory.NextSnowId(); //0.15秒
        //ShardingFactory.NextObjectId(); //0.2秒
        YitIdHelper.NextId(); //8秒多
    }
    sw.Stop();
    Console.WriteLine(sw.ElapsedMilliseconds);
    

    同样生成50万个id 1、雪花算法只要0.15秒 2、mongodb的objectid只需要0.2秒 3、作者你的id说是比传统雪花算法快2-5倍(可结果居然用了8秒多) C#测试就是这个结果 作者请问你是不是哪里代码出错了,怎么会慢成这样

    opened by znyet 2
  • SqlServer雪花函數生成ID重複

    SqlServer雪花函數生成ID重複

    我特意測試了下建立一个Test表,字段有ID,Val两个字段,根据教程把ID字段默认值设置了([dbo].Fn_NextSnowId) 然后我执行以下脚本发现总有几十个ID出现重复

    declare @i int =10000
    
    while @i>0
    begin
    INSERT INTO [dbo].[Test]([Val])
         VALUES
               ('123')
    set @[email protected]
    end 
    
    opened by bao2314483 2
  • 压测结果

    压测结果

    我压测了一下,慢的有点离谱,不知道是不是代码问题,代码如下:

        public static void main(String[] args) {
            var count = 0;
    
            // mybatis-plus的雪花算法
            final var sequence = new Sequence();
    
            // yitter-idgenerator-spring-boot-starter
    //        final var options = new IdGeneratorOptions();
    //            options.TopOverCostCount = 500;
    //            options.Method = 2;
    //        final var id = new WFGIdGenerator(options);
    
            // yitter-idgenerator
            IdGeneratorOptions options = new IdGeneratorOptions((short)1);
                YitIdHelper.setIdGenerator(options);
    
            final var start = System.currentTimeMillis();
            while (count < 3000000) {
                count++;
    //            id.next();
    //            sequence.nextId();
                YitIdHelper.nextId();
            }
            System.out.println(System.currentTimeMillis() - start);
        }
    

    只有mybatis-plus的雪花算法是最快的,400/s,其他的都要50s

    opened by Jamel-jun 1
  • Go 导入问题

    Go 导入问题

    使用导入

    go get -u -v github.com/yitter/idgenerator-go

    提示

    github.com/yitter/idgenerator-go imports
            github.com/yitter/idgenerator-go/regworkerid: cannot find module providing package github.com/yitter/idgenerator-go/regworkerid
    
    
    opened by anhao 3
  • golang workID type mismatch

    golang workID type mismatch

    RegisterOne return int32

    func RegisterOne(ip string, port int32, password string, maxWorkerId int32) int32 
    

    but IdGeneratorOptions need uint16

    type IdGeneratorOptions struct {
    	Method            uint16 // 雪花计算方法,(1-漂移算法|2-传统算法),默认1
    	BaseTime          int64  // 基础时间(ms单位),不能超过当前系统时间
    	WorkerId          uint16 // 机器码,必须由外部设定,最大值 2^WorkerIdBitLength-1
    	WorkerIdBitLength byte   // 机器码位长,默认值6,取值范围 [1, 15](要求:序列数位长+机器码位长不超过22)
    	SeqBitLength      byte   // 序列数位长,默认值6,取值范围 [3, 21](要求:序列数位长+机器码位长不超过22)
    	MaxSeqNumber      uint32 // 最大序列数(含),设置范围 [MinSeqNumber, 2^SeqBitLength-1],默认值0,表示最大序列数取最大值(2^SeqBitLength-1])
    	MinSeqNumber      uint32 // 最小序列数(含),默认值5,取值范围 [5, MaxSeqNumber],每毫秒的前5个序列数对应编号0-4是保留位,其中1-4是时间回拨相应预留位,0是手工新值预留位
    	TopOverCostCount  uint32 // 最大漂移次数(含),默认2000,推荐范围500-10000(与计算能力有关)
    }
    
    opened by pengdaqian2020 2
  • C++ 兼容性保护 (#28)

    C++ 兼容性保护 (#28)

    https://github.com/yitter/IdGenerator/issues/28 另一个小修改:将 C/source/.gitignore 移上层 C/.gitignore 。因为一般是在与 source/ 目录平行的地方建个 build/ 目录用 cmake/make 构建,需要忽略这个 build/ 目录

    opened by lymslive 0
  • C 库没做 C++ 兼容

    C 库没做 C++ 兼容

    我是个 C++ 开发,老板推荐使用这个雪花算法。 一开始尝试提供的 C 库,一直链接不成功,后来发现是没写 extern "C" 兼容。 标准做法是加上类似如下的宏,使其能同时用于 C 或 C++

    #ifdef __cplusplus
    extern "C" 
    {
    #endif
    
    // C 库函数 声明
    
    #ifdef __cplusplus
    }
    #endif
    

    另外一个小问题,你这个 C 库的函数接口命名太普通,像 NextId()SetOption() 之类的函数名太常见,很可能与实际项目其他全局符号冲突,毕竟这个 id 算法库的目的是要集成到某些较大的项目中的。建议不妨统一加上 yit 前缀。

    opened by lymslive 2
Releases(v1.3.1)
Owner
null