From d83269347ef032f38f370bc0d8f9d0b4e2ddba7b Mon Sep 17 00:00:00 2001 From: yitter Date: Sun, 4 Sep 2022 09:52:51 +0800 Subject: [PATCH] auto commit --- C#.NET/README.md | 16 +++++++++------- C/README.md | 15 +++++++++------ Go/README.md | 15 +++++++++------ Java/README.md | 19 ++++++++++--------- Rust/README.md | 15 +++++++++------ 5 files changed, 46 insertions(+), 34 deletions(-) diff --git a/C#.NET/README.md b/C#.NET/README.md index 9836f72..371f150 100644 --- a/C#.NET/README.md +++ b/C#.NET/README.md @@ -13,22 +13,24 @@ 第1步，**全局** 初始化（应用程序启动时执行一次）： ``` -// 创建 IdGeneratorOptions 对象，请在构造函数中输入 WorkerId： +// 创建 IdGeneratorOptions 对象，可在构造函数中输入 WorkerId： var options = new IdGeneratorOptions(Your_Worker_Id); -// options.WorkerIdBitLength = 10; // WorkerIdBitLength 默认值6，支持的 WorkerId 最大值为2^6-1，若 WorkerId 超过64，可设置更大的 WorkerIdBitLength -// ...... 其它参数设置参考 IdGeneratorOptions 定义，一般来说，只要再设置 WorkerIdBitLength （决定 WorkerId 的最大值）。 +// options.WorkerIdBitLength = 10; // 默认值6，限定 WorkerId 最大值为2^6-1，即默认最多支持64个节点。 +// options.SeqBitLength = 6; // 默认值6，限制每毫秒生成的ID个数。若生成速度超过5万个/秒，建议加大 SeqBitLength 到 10。 +// options.BaseTime = Your_Base_Time; // 如果要兼容老系统的雪花算法，此处应设置为老系统的BaseTime。 +// ...... 其它参数参考 IdGeneratorOptions 定义。 -// 保存参数（必须的操作，否则以上设置都不能生效）： +// 保存参数（务必调用，否则参数设置不生效）： YitIdHelper.SetIdGenerator(options); -// 以上初始化过程只需全局一次，且必须在第2步之前设置。 + +// 以上过程只需全局一次，且应在生成ID之前完成。 ``` 第2步，生成ID： ``` -// 初始化以后，即可在任何需要生成ID的地方，调用以下方法： +// 初始化后，在任何需要生成ID的地方，调用以下方法： var newId = YitIdHelper.NextId(); ``` -如果基于DI框架集成，可以参考 YitIdHelper 去管理 IdGenerator 对象，必须使用**单例**模式。 diff --git a/C/README.md b/C/README.md index 0ccbbc3..0d64373 100644 --- a/C/README.md +++ b/C/README.md @@ -11,19 +11,22 @@ 第1步，**全局** 初始化（应用程序启动时执行一次）： ``` -// 创建 IdGeneratorOptions 对象，请在构造函数中输入 WorkerId： +// 创建 IdGeneratorOptions 对象，可在构造函数中输入 WorkerId： IdGeneratorOptions options = BuildIdGenOptions(Your_Worker_Id); -// options.WorkerIdBitLength = 10; // WorkerIdBitLength 默认值6，支持的 WorkerId 最大值为2^6-1，若 WorkerId 超过64，可设置更大的 WorkerIdBitLength -// ...... 其它参数设置参考 IdGeneratorOptions 定义，一般来说，只要再设置 WorkerIdBitLength （决定 WorkerId 的最大值）。 +// options.WorkerIdBitLength = 10; // 默认值6，限定 WorkerId 最大值为2^6-1，即默认最多支持64个节点。 +// options.SeqBitLength = 6; // 默认值6，限制每毫秒生成的ID个数。若生成速度超过5万个/秒，建议加大 SeqBitLength 到 10。 +// options.BaseTime = Your_Base_Time; // 如果要兼容老系统的雪花算法，此处应设置为老系统的BaseTime。 +// ...... 其它参数参考 IdGeneratorOptions 定义。 -// 保存参数（必须的操作，否则以上设置都不能生效）： +// 保存参数（务必调用，否则参数设置不生效）： SetIdGenerator(options); -// 以上初始化过程只需全局一次，且必须在第2步之前设置。 + +// 以上过程只需全局一次，且应在生成ID之前完成。 ``` 第2步，生成ID： ``` -// 初始化以后，即可在任何需要生成ID的地方，调用以下方法： +// 初始化后，在任何需要生成ID的地方，调用以下方法： long newId = NextId(); ``` diff --git a/Go/README.md b/Go/README.md index ae8f2e6..5fd72c0 100644 --- a/Go/README.md +++ b/Go/README.md @@ -13,19 +13,22 @@ go get -u -v github.com/yitter/idgenerator-go 第1步，**全局** 初始化（应用程序启动时执行一次）： ``` -// 创建 IdGeneratorOptions 对象，请在构造函数中输入 WorkerId： +// 创建 IdGeneratorOptions 对象，可在构造函数中输入 WorkerId： var options = idgen.NewIdGeneratorOptions(Your_Worker_Id) -// options.WorkerIdBitLength = 10 // WorkerIdBitLength 默认值6，支持的 WorkerId 最大值为2^6-1，若 WorkerId 超过64，可设置更大的 WorkerIdBitLength -// ...... 其它参数设置参考 IdGeneratorOptions 定义，一般来说，只要再设置 WorkerIdBitLength （决定 WorkerId 的最大值）。 +// options.WorkerIdBitLength = 10; // 默认值6，限定 WorkerId 最大值为2^6-1，即默认最多支持64个节点。 +// options.SeqBitLength = 6; // 默认值6，限制每毫秒生成的ID个数。若生成速度超过5万个/秒，建议加大 SeqBitLength 到 10。 +// options.BaseTime = Your_Base_Time; // 如果要兼容老系统的雪花算法，此处应设置为老系统的BaseTime。 +// ...... 其它参数参考 IdGeneratorOptions 定义。 -// 保存参数（必须的操作，否则以上设置都不能生效）： +// 保存参数（务必调用，否则参数设置不生效）： idgen.SetIdGenerator(options) -// 以上初始化过程只需全局一次，且必须在第2步之前设置。 + +// 以上过程只需全局一次，且应在生成ID之前完成。 ``` 第2步，生成ID： ``` -// 初始化以后，即可在任何需要生成ID的地方，调用以下方法： +// 初始化后，在任何需要生成ID的地方，调用以下方法： var newId = idgen.NextId() ``` diff --git a/Java/README.md b/Java/README.md index f2929a3..be5c536 100644 --- a/Java/README.md +++ b/Java/README.md @@ -17,22 +17,23 @@ JDK 1.8+ 第1步，**全局** 初始化（应用程序启动时执行一次）： ``` -// 创建 IdGeneratorOptions 对象，请在构造函数中输入 WorkerId： +// 创建 IdGeneratorOptions 对象，可在构造函数中输入 WorkerId： IdGeneratorOptions options = new IdGeneratorOptions(Your_Worker_Id); -// options.WorkerIdBitLength = 10; // WorkerIdBitLength 默认值6，支持的 WorkerId 最大值为2^6-1，若 WorkerId 超过64，可设置更大的 WorkerIdBitLength -// ...... 其它参数设置参考 IdGeneratorOptions 定义，一般来说，只要再设置 WorkerIdBitLength （决定 WorkerId 的最大值）。 +// options.WorkerIdBitLength = 10; // 默认值6，限定 WorkerId 最大值为2^6-1，即默认最多支持64个节点。 +// options.SeqBitLength = 6; // 默认值6，限制每毫秒生成的ID个数。若生成速度超过5万个/秒，建议加大 SeqBitLength 到 10。 +// options.BaseTime = Your_Base_Time; // 如果要兼容老系统的雪花算法，此处应设置为老系统的BaseTime。 +// ...... 其它参数参考 IdGeneratorOptions 定义。 -// 保存参数（必须的操作，否则以上设置都不能生效）： -YitIdHelper.setIdGenerator(options); -// 以上初始化过程只需全局一次，且必须在第2步之前设置。 +// 保存参数（务必调用，否则参数设置不生效）： +YitIdHelper.SetIdGenerator(options); + +// 以上过程只需全局一次，且应在生成ID之前完成。 ``` 第2步，生成ID： ``` -// 初始化以后，即可在任何需要生成ID的地方，调用以下方法： +// 初始化后，在任何需要生成ID的地方，调用以下方法： long newId = YitIdHelper.nextId(); ``` -如果基于DI框架集成，可以参考 YitIdHelper 去管理 IdGenerator 对象，须使用 **单例** 模式。 - diff --git a/Rust/README.md b/Rust/README.md index f64f675..0f987e7 100644 --- a/Rust/README.md +++ b/Rust/README.md @@ -4,19 +4,22 @@ 第1步，**全局** 初始化（应用程序启动时执行一次）： ``` -// 创建 IdGeneratorOptions 对象，请在构造函数中输入 WorkerId： +// 创建 IdGeneratorOptions 对象，可在构造函数中输入 WorkerId： let mut options = IdGeneratorOptions::New(Your_Worker_Id); -// options.WorkerIdBitLength = 10; // WorkerIdBitLength 默认值6，支持的 WorkerId 最大值为2^6-1，若 WorkerId 超过64，可设置更大的 WorkerIdBitLength -// ...... 其它参数设置参考 IdGeneratorOptions 定义，一般来说，只要再设置 WorkerIdBitLength （决定 WorkerId 的最大值）。 +// options.WorkerIdBitLength = 10; // 默认值6，限定 WorkerId 最大值为2^6-1，即默认最多支持64个节点。 +// options.SeqBitLength = 6; // 默认值6，限制每毫秒生成的ID个数。若生成速度超过5万个/秒，建议加大 SeqBitLength 到 10。 +// options.BaseTime = Your_Base_Time; // 如果要兼容老系统的雪花算法，此处应设置为老系统的BaseTime。 +// ...... 其它参数参考 IdGeneratorOptions 定义。 -// 保存参数（必须的操作，否则以上设置都不能生效）： +// 保存参数（务必调用，否则参数设置不生效）： YitIdHelper::SetIdGenerator(options); -// 以上初始化过程只需全局一次，且必须在第2步之前设置。 + +// 以上过程只需全局一次，且应在生成ID之前完成。 ``` 第2步，生成ID： ``` -// 初始化以后，即可在任何需要生成ID的地方，调用以下方法： +// 初始化后，在任何需要生成ID的地方，调用以下方法： long newId = YitIdHelper::NextId(); ```