基於雪花演算法的 PHP ID 生成器

godruoyi發表於2019-08-14

基於雪花演算法的 PHP ID 生成器

Snowflake 是 Twitter 內部的一個 ID 生演算法,可以通過一些簡單的規則保證在大規模分散式情況下生成唯一的 ID 號碼。

其組成為:

  • 第一個 bit 為未使用的符號位。
  • 第二部分由 41 位的時間戳(毫秒)構成,他的取值是當前時間相對於某一時間的偏移量。
  • 第三部分和第四部分的 5 個 bit 位表示資料中心和機器ID,其能表示的最大值為 2^5 -1 = 31;
  • 最後部分由 12 個 bit 組成,其表示每個工作節點每毫秒生成的序列號 ID,同一毫秒內最多可生成 2^12 -1 即 4095 個 ID。

需要注意的是:

  • 在分散式環境中,5 個 bit 位的 datacenter 和 worker 表示最多能部署 31 個資料中心,每個資料中心最多可部署 31 臺節點。
  • 41 位的二進位制長度最多能表示 2^41 -1 毫秒即 69 年,所以雪花演算法最多能正常使用 69 年,為了能最大限度的使用該演算法,你應該為其指定一個開始時間。

由上可知,雪花演算法生成的 ID 並不能保證唯一,如當兩個不同請求同一時刻進入相同的資料中心的相同節點時,而此時該節點生成的 sequence 又是相同時,就會導致生成的 ID 重複。

所以要想使用雪花演算法生成唯一的 ID,就需要保證同一節點同一毫秒內生成的序列號是唯一的。基於此,我們在 SDK 中整合了多種序列號提供者:

  • RandomSequenceResolver(隨機生成)
  • RedisSequenceResolver (基於 redis psetex 和 incrby 生成)
  • LaravelSequenceResolver(基於 redis psetex 和 incrby 生成)
  • SwooleSequenceResolver(基於 swoole_lock 鎖)

不同的提供者只需要保證同一毫秒生成的序列號不同,就能得到唯一的 ID,最後附上 專案部落格 地址,歡迎大家圍觀。

要求

  1. PHP >= 7.0
  2. Composer

安裝

$ composer require godruoyi/php-snowflake -vvv

使用

  1. 簡單使用.
$snowflake = new \Godruoyi\Snowflake\Snowflake;

$snowflake->id();
// 1537200202186752
  1. 指定資料中心ID及機器ID.
$snowflake = new \Godruoyi\Snowflake\Snowflake($datacenterId, $workerId);

$snowflake->id();
  1. 指定開始時間.
$snowflake = new \Godruoyi\Snowflake\Snowflake;
$snowflake->setStartTimeStamp(strtotime('2019-09-09')*1000);

$snowflake->id();

高階

  1. 在 Laravel 中使用

因為 SDK 相對簡單,我們並沒有提供 Laravel 的擴充套件包,你可通過下面的方式快速整合到 Laravel 中。

// App\Providers\AppServiceProvider

use Godruoyi\Snowflake\Snowflake;
use Godruoyi\Snowflake\LaravelSequenceResolver;

class AppServiceProvider extends ServiceProvider
{
    /**
     * Register any application services.
     *
     * @return void
     */
    public function register()
    {
        $this->app->singleton('snowflake', function () {
            return (new Snowflake())
                ->setStartTimeStamp(strtotime('2019-08-08')*1000)
                ->setSequenceResolver(new LaravelSequenceResolver(
                    $this->app->get('cache')->store()
                ));
        });
    }
}
  1. 自定義序列號解決器

你可以通過實現 Godruoyi\Snowflake\SequenceResolver 介面來自定義序列號解決器。

class YourSequence implements SequenceResolver
{
    /**
     *  {@inheritdoc}
     */
    public function sequence(int $currentTime)
    {
          // Just test.
        return mt_rand(0, 1);
    }
}

// usage

$snowflake->setSequenceResolver(new YourSequence);
$snowflake->id();

你也可以直接使用閉包:

$snowflake = new \Godruoyi\Snowflake\Snowflake;
$snowflake->setSequenceResolver(function ($currentTime) {
    static $lastTime;
    static $sequence;

    if ($lastTime == $currentTime) {
        ++$sequence;
    }

    $lastTime = $currentTime;

    return $sequence;
})->id();

如果您在使用過程中遇到任何問題,歡迎提交 「PR」。

二楞徐的閒談雜魚

相關文章