1
0
mirror of synced 2025-12-08 06:08:13 +08:00
Files
SnowFlake-IdGenerator/README.md
2023-12-13 11:01:23 +08:00

306 lines
16 KiB
Markdown
Raw Permalink Blame History

This file contains invisible Unicode characters
This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
# 雪花算法中非常好用的数字ID生成器
## 💎 最佳实践(置顶)
针对大家在使用中经常出现的性能疑问我给出以下3组最佳实践
❄ 如果ID生成需求不超过5W个/s不用修改任何配置参数
❄ 如果超过5W个/s低于50W个/s推荐修改SeqBitLength=10
❄ 如果超过50W个/s接近500W个/s推荐修改SeqBitLength=12
总之,增加 SeqBitLength 会让性能更高,但生成的 ID 会更长。
## 💎 算法介绍
❄ 这是优化的雪花算法雪花漂移它生成的ID更短、速度更快。
❄ 支持 k8s 等容器环境自动扩容(自动注册 WorkerId可在单机或分布式环境生成数字型唯一ID。
❄ 原生支持 C#/Java/Go/C/Rust/Python/Node.js/PHP(C扩展)/SQL/ 等语言并提供多线程安全调用动态库FFI
❄ 兼容所有雪花算法(号段模式或经典模式,大厂或小厂),将来你可做任意的升级切换。
❄ 这是计算机历史上最全面的雪花ID生成工具。【截至2022年8月】
#### 需求来源
💧 作为架构设计的你,想要解决数据库主键唯一的问题,特别是在分布式系统多数据库中。
💧 你希望数据表主键用最少的存储空间索引速度更快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年长度15)
387750301904971 (运行3年长度15)
646093214093387 (运行5年长度15)
1292658282840139 (运行10年长度16)
9007199254740992 (运行70年达到 js Number 最大值长度16)
165399880288699493 (运行1000年等同普通雪花算法运行1年长度18)
```
🟣 本算法生成的 ID 值,是 js Number 最大值的 1%-10%,是普通雪花算法值的千分之一,而生成速度却超过普通雪花算法。
🟣 js Number 类型最大数值9007199254740992本算法在保持并发性能5W+/0.01s和最大64个 WorkerId6bit的同时能用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**,机器码,**最重要参数**,无默认值,必须 **全局唯一**(或相同 DataCenterId 内唯一),必须 **程序设定**缺省条件WorkerIdBitLength取默认值时最大值63理论最大值 2^WorkerIdBitLength-1不同实现语言可能会限定在 65535 或 32767原理同 WorkerIdBitLength 规则)。不同机器或不同应用实例 **不能相同**你可通过应用程序配置该值也可通过调用外部服务获取值。针对自动注册WorkerId需求本算法提供默认实现通过 redis 自动注册 WorkerId 的动态库详见“Tools\AutoRegisterWorkerId”。
**特别提示**:如果一台服务器部署多个独立服务,需要为每个服务指定不同的 WorkerId。
***SeqBitLength***,序列数位长,**默认值6**,取值范围 [3, 21]建议不小于4决定每毫秒基础生成的ID个数。如果每秒请求数不超过5W保持默认值6即可如果超过5W不超过50W建议赋值10或更大以此类推。规则要求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的时间戳。基础时间一般无需设置如果觉得默认值太老你可以重新设置不过要注意这个值以后最好不变。
第二版计划增加参数:
***DataCenterId***数据中心ID机房ID默认0请确保全局唯一。
***DataCenterIdBitLength***数据中心ID长度默认0
***TimestampType***时间戳类型0-毫秒1-秒默认0。
#### 常规集成
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 **只能更旧**距现在更远让生成的ID值较历史最大值更大确保没有时间重叠区不产生重复ID。[**不推荐** 在系统运行之后调整 BaseTime]
🔴 2.任何时候增加 WorkerIdBitLength 或 SeqBitLength都是允许的但应慎用 “减小”操作,因为这可能导致在未来某天生成的 ID 与旧配置时相同。[允许在系统运行之后 **增加** 任何一个 xxxBitLength 值]
🔴 3.如果必须减小 WorkerIdBitLength 或 SeqBitLength 其中的一项,一定要满足条件:新的两个 xxxBitLength 之和要大于旧值之和。[**不推荐** 在运行之后缩小任何一个 BitLength 值]
🔴 4.上述3条规则并未在本算法内做逻辑控制使用者应在确认新配置符合要求后再实施配置变更。
## 自动注册WorkerId
🔍 唯一ID生成器依赖WorkerId当业务服务需要水平无差别复制自动扩容这就要求能自动注册全局唯一WorkerId然后才能生产唯一ID。
🔍 本算法提供开源动态库go语言实现能在容器 k8s 等容器环境下,通过 redis 自动注册 WorkerId。
🔍 通过redis注册WorkerId并非唯一方法。你还可以开发中心化的配置服务各端点服务启动时通过中心服务获取唯一 WorkerId。
🔍 当然如果你的服务无需自动扩容那就不必自动注册WorkerId而是为它们分别设置全局唯一值。
🔍 方法还有很多例如开发中心化的ID生成服务由它为各端点服务单个或批量生成可用ID。
#### 自动注册流程图
图片链接https://github.com/yitter/IdGenerator/blob/master/Tools/AutoRegisterWorkerId/regprocess.jpg
源码路径:/Go/source/regworkerid/reghelper.go
#### 动态库下载
下载链接https://github.com/yitter/IdGenerator/releases/download/v1.3.3/workeridgo_lib_v1.3.3.zip
#### 动态库接口定义
```
// 注册一个 WorkerId会先注销所有本机已注册的记录
// address: Redis连接地址单机模式示例127.0.0.1:6379哨兵/集群模式示例127.0.0.1:26380,127.0.0.1:26381,127.0.0.1:26382
// password: Redis连接密码
// db: Redis指定存储库示例1
// sentinelMasterName: Redis 哨兵模式下的服务名称示例mymaster非哨兵模式传入空字符串即可
// minWorkerId: WorkerId 最小值示例30
// maxWorkerId: WorkerId 最大值示例63
// lifeTimeSeconds: WorkerId缓存时长3的倍数推荐值15
extern GoInt32 RegisterOne(char* server, char* password, GoInt32 db, char* sentinelMasterName, GoInt32 minWorkerId, GoInt32 maxWorkerId, GoInt32 lifeTimeSeconds);
// 注销本机已注册的 WorkerId
extern void UnRegister();
```
## 已实现的语言
| 语言 | github |
| ---- | ---- |
| 🌲 C# | [查看示例][1] |
| 🌲 Java | [查看示例][2] |
| 🌲 Go| [查看示例][3] |
| 🌲 Rust | [查看示例][4] |
| 🌲 Python | [查看示例][10] |
| 🌲 C | [查看示例][5] |
| 🌲 C (PHP扩展) | [查看示例][7] |
| 🌲 Delphi (Pascal) | [查看示例][6] |
| 🌲 JavaScript | [查看示例][8] |
| 🌲 TypeScript | [查看示例][9] |
| 🌲 V | [查看示例][6] |
| 🌲 D | [查看示例][72] |
## 技术支持
开源地址https://github.com/yitter/IdGenerator
QQ群646049993
[comment]: <> ( ## 为什么用雪花ID)
[comment]: <> ( ❄ 因为大厂也在用,推特、百度、美团、滴滴等等。)
[comment]: <> ( ❄ 雪花ID是走向分布式架构的垫脚石如果只会Guid和数据库自增怎敢说会分布式系统架构。)
[comment]: <> ( ❄ 雪花ID适合小项目、大项目、超级大项目。)
[comment]: <> ( ## 为什么不用大厂的?)
[comment]: <> ( ❄ 首先大厂们不但自己用雪花ID而且还开源[百度][81] | [美团][82] | [滴滴][83] | [Sony][84] | [雪花ID鼻祖-推特][80]。)
[comment]: <> ( ❄ 然而,大厂的雪花算法分为“经典算法”和“号段算法”两种,其中“号段算法”依赖网络或外部存储系统,不适合“非大厂”,且存在无法反应业务时序的缺点。)
[comment]: <> ( ❄ 至于其“经典算法”在“ID长度和生成性能”方面未做过优化而这正式本算法——雪花漂移算法的核心所在。)
[1]: https://github.com/yitter/idgenerator/tree/master/C%23.NET
[2]: https://github.com/yitter/idgenerator/tree/master/Java
[3]: https://github.com/yitter/idgenerator/tree/master/Go
[4]: https://github.com/yitter/idgenerator/tree/master/Rust
[5]: https://github.com/yitter/idgenerator/tree/master/C
[6]: https://github.com/yitter/idgenerator/tree/master/Delphi
[7]: https://github.com/yitter/idgenerator/tree/master/PHP
[8]: https://github.com/yitter/IdGenerator/tree/master/JavaScript
[9]: https://github.com/yitter/IdGenerator/tree/master/TypeScript
[10]: https://github.com/yitter/IdGenerator/tree/master/Python
[11]: https://github.com/yitter/idgenerator/tree/master/C%23.NET
[21]: https://github.com/yitter/idgenerator/tree/master/Java
[31]: https://github.com/yitter/idgenerator/tree/master/Go
[41]: https://github.com/yitter/idgenerator/tree/master/Rust
[51]: https://github.com/yitter/idgenerator/tree/master/C
[61]: https://github.com/yitter/idgenerator/tree/master/Delphi
[71]: https://github.com/yitter/idgenerator/tree/master/PHP
[72]: https://github.com/yitter/idgenerator/tree/master/zzz-OtherLanguages/D
[73]: https://github.com/yitter/idgenerator/tree/master/zzz-OtherLanguages/D
[80]: https://github.com/twitter-archive/snowflake
[81]: https://github.com/baidu/uid-generator
[82]: https://github.com/Meituan-Dianping/Leaf
[83]: https://github.com/didi/tinyid
[84]: https://github.com/sony/sonyflake