常见分布式ID

• 美团Leaf：https://github.com/Meituan-Dianping/Leaf/

• 推特snowflake：https://github.com/twitter-archive/snowflake

• Redis

• 百度Uid-generator：https://github.com/baidu/uid-generator

snowflake简介

snowflake是Twitter开源的分布式ID生成算法，结果是一个long型的ID。

其核心思想是：使用41bit作为毫秒数（当前时间截 - 开始时间截），10bit作为机器的ID（5个bit是数据中心，5个bit的机器ID），12bit作为毫秒内的流水号（意味着每个节点在每毫秒可以产生 4096 个 ID），最后还有一个符号位，永远是0。

这个算法单机每秒内理论上最多可以生成1000*(2^12)，也就是409.6万个ID

数据结构

001.png

举例

PHP 实现

代码在yii框架中使用，配置如下

    'zookeeper'=>[
        'uri'=>'192.168.3.111:2181,192.168.3.112:2181,192.168.3.113:2181',
    ],
    'snow'=>[
        'rootPath'=>'/lock_snow',
        'keyPrefix'=>'/lock_',
        'info'=>'snow_lock'
    ]

如果需要在其他框架运行，请替换相应配置信息

<?php
namespace common\utils;

use common\utils\zookeeper\ZkUtil;
use yii\db\Exception;

class Snowflake
{
    const EPOCH = 1420041600000;    // 起始时间戳，毫秒

    const SEQUENCE_BITS = 12;   //序号部分12位
    const SEQUENCE_MAX = -1 ^ (-1 << self::SEQUENCE_BITS);  // 序号最大值

    const WORKER_BITS = 5; // 机器id部分5位
    const WORKER_MAX = -1 ^ (-1 << self::WORKER_BITS);  // 机器id最大数值

    const DATACENTER_BITS = 5;// 数据中心部分5位
    const DATACENTER_MAX = -1 ^ (-1 << self::DATACENTER_BITS);// 数据中心id最大值

    const TIME_SHIFT = self::WORKER_BITS + self::DATACENTER_BITS + self::SEQUENCE_BITS; // 时间戳部分左偏移量
    const DATACENTER_SHIFT = self::SEQUENCE_BITS + self::WORKER_BITS;
    const WORKER_SHIFT = self::SEQUENCE_BITS;   // 节点部分左偏移量

    protected $timestamp;   // 上次ID生成时间戳
    protected $workerId;    // 节点ID
    protected $dataCenterId;// 数据中心id
    protected $sequence;    // 序号

    public function __construct($workerId, $dataCenterId)
    {
        if ($workerId < 0 || $workerId > self::WORKER_MAX) {
            throw new Exception('节点ID超出范围');
        }
        if($dataCenterId<0||$dataCenterId>self::DATACENTER_MAX){
            throw new Exception("数据中心id超出范围");
        }
        $this->timestamp = 0;
        $this->workerId = $workerId;
        $this->dataCenterId = $dataCenterId;
    }

    public function getId()
    {
        $id = null;
        $params = \Yii::$app->params;//如果在其他框架运行，请替换
        $conf['client_uri'] = $params['zookeeper']['uri'];;
        $root = $params['snow']['rootPath'];
        $lockKey = $params['snow']['keyPrefix'] . $this->workerId;
        // 开始获取锁
        ZkUtil::getInstance($conf, $root);
        if (!ZkUtil::tryClock($lockKey, $params['snow']['info'])) {
            throw new \Exception('获取锁失败');
        }
        try {
            $now = $this->getMicroTime();
            if ($this->timestamp == $now) {
                $this->sequence++;
                if ($this->sequence > self::SEQUENCE_MAX) {
                    // 当前毫秒内生成的序号已经超出最大范围，等待下一毫秒重新生成
                    while ($now <= $this->timestamp) {
                        $now = $this->getMicroTime();
                    }
                }
            } else {
                $this->sequence = 0;
            }
            $this->timestamp = $now; // 更新ID生时间戳
            // 方法一、使用字符串拼接
//            $bin= decbin($now-self::EPOCH);
//            $bin = '0'.$bin;
//            $dataid=sprintf("%05s",decbin($this->dataCenterId));
//            $workid=sprintf("%05s",decbin($this->workerId));
//            $sequence = sprintf("%012s",decbin($this->sequence));
//            $id=$bin.$dataid.$workid.$sequence;
//            echo bindec($id);
            // 方法二、使用位运算
            $id = (($now - self::EPOCH) << self::TIME_SHIFT) |($this->dataCenterId<<self::DATACENTER_SHIFT)| ($this->workerId << self::WORKER_SHIFT) | $this->sequence;
        } catch (\Exception $e) {
            echo $e->getMessage() . PHP_EOL;
        } finally {
            ZkUtil::releaseLock();
            return $id;
        }
    }

    private function getMicroTime()
    {
        $tArr = explode(" ", microtime());
        return (float) sprintf('%.0f',(floatval($tArr[1])+floatval($tArr[0]))*1000);
    }
}

ZkUtil：php编写的zookeeper分布式锁工具类

<?php

namespace common\utils\zookeeper;


class ZkUtil
{
    const debug = false;
    private static $_zk = null; // zk client
    private static $_node = null; // 当前节点信息
    private static $_isNotifyed = null;
    private static $_root; // 根目录
    private static $_acl = [ // 授权
        [
            'perms' => \Zookeeper::PERM_ALL,
            'scheme' => 'world',
            'id' => 'anyone',
        ]
    ];

    /**
     * 初始化链接
     * @param $conf
     * @param $root
     * @return \Zookeeper|null
     * @throws \Exception
     */
    public static function getInstance($conf, $root): ?\Zookeeper
    {
        if (self::$_zk !== null) return self::$_zk;
        $client = new \Zookeeper($conf['client_uri']);
        if (!$client) {
            throw new \Exception('connect zookeeper error');
        }

        self::$_root = $root;
        return self::$_zk = $client;
    }

    /**
     * 获取锁
     * @param $key
     * @param $value
     * @return false
     */
    public static function tryClock($key, $value): bool
    {
        try {
            self::createRoot($value);//构建根节点
            self::createSub(self::$_root . $key, $value);//构建子节点
            return self::getLock();//获取锁
        } catch (\Exception $e) {
            return false;
        }
    }

    /**
     * 释放锁
     * @return bool
     */
    public static function releaseLock(): bool
    {
        if (self::$_zk->delete(self::$_node)) {
            return true;
        } else {
            return false;
        }
    }

    /**
     * 创建根节点
     * @param $value
     * @return bool
     * @throws \Exception
     */
    public static function createRoot($value): bool
    {
        // 判读根节点是否存在
        if (!self::$_zk->exists(self::$_root)) {
            // 创建根节点 创建成功返回节点名
            $result = self::$_zk->create(self::$_root, $value, self::$_acl);
            if (!$result) {
                throw new \Exception('create ' . self::$_root . '  fail');
            }
        }
        return true;
    }

    /**
     * 创建子节点
     * @param $path
     * @param $value
     * @return bool
     * @throws \Exception
     */
    public static function createSub($path, $value): bool
    {
        self::$_node = self::$_zk->create($path, $value, self::$_acl, \Zookeeper::EPHEMERAL | \Zookeeper::SEQUENCE);
        if (!self::$_node) {
            throw new \Exception('create -s -e ' . $path . ' fail');
        }
        if (self::debug){
            echo 'create - node：' . self::$_node . PHP_EOL;
        }
        return true;
    }

    /**
     * 获取锁
     * @return bool
     */
    public function getLock()
    {
        $beforeNode = self::checkNodeBefore();
        // 如果得到锁返回
        if ($beforeNode === true) {
            return true;
        } else {
            self::$_isNotifyed = false;// 初始化状态
            $result = self::$_zk->get($beforeNode, [ZkUtil::class, 'watcher']);

            while (!$result) {
                $res = self::checkNodeBefore();
                if ($res === true) {
                    return true;
                } else {
                    $result = self::$_zk->get($res, [ZkUtil::class, 'watcher']);
                }
            }
            while (!self::$_isNotifyed) {
                if(self::debug){
                    echo '.';
                }
                usleep(500000);//500ms
            }
            return true;
        }
    }

    public static function watcher($type, $state, $key)
    {
        if(self::debug){
            echo PHP_EOL . $key . ' notifyed ... ' . PHP_EOL;
        }
        self::$_isNotifyed = true;
        self::getLock();
    }

    /**
     * 检查当前节点是否可以得到锁，如果不可以获取它的上一个节点
     * @return bool
     */
    public function checkNodeBefore()
    {
        // 获取所有子节点
        $nodes = self::$_zk->getChildren(self::$_root);
        // 对节点进行排序
        sort($nodes);
        $root = self::$_root;
        // 节点全路径拼接
        array_walk($nodes, function (&$val) use ($root) {
            $val = $root . '/' . $val;
        });
        // 判断是否在首位
        if ($nodes[0] == self::$_node) {
            if(self::debug){
                echo 'get lock node ' . self::$_node . '------' . PHP_EOL;
            }
            return true;
        } else {
            // 找到当前节点的上一个节点
            $index = array_search(self::$_node, $nodes);
            $before = $nodes[$index - 1];
            if(self::debug){
                echo 'before node ' . $before . '.....' . PHP_EOL;
            }
            return $before;
        }
    }
}

//function zkLock($resourceId)
//{
//    $conf['client_uri'] = '192.168.3.111:2181,192.168.3.112:2181,192.168.3.113:2181';
//    $root = '/lock_' . $resourceId;
//    $lockKey = '/lock_';
//    $value = 'server_info_1';
//    $client = ZkUtil::getInstance($conf, $root);
//    $re = ZkUtil::tryClock($lockKey, $value);
//    if ($re) {
//        echo 'get lock success' . PHP_EOL;
//    } else {
//        echo 'get lock fail' . PHP_EOL;
//        return false;
//    }
//    try {
//        action();
//    } catch (\Exception $e) {
//        echo $e->getMessage() . PHP_EOL;
//    } finally {
//        $re = ZkUtil::releaseLock();
//        if ($re) {
//            echo 'release lock success' . PHP_EOL;
//        } else {
//            echo 'release lock fail' . PHP_EOL;
//        }
//        return;
//    }
//}
//
//function action()
//{
//    $n = rand(1, 20);
//    switch ($n) {
//        case 1:
//            sleep(15);//模拟超时
//            break;
//        case 2:
//            throw new \Exception('system throw message...');//模拟中断
//            break;
//        case 3:
//            die('system crashed...');//模拟程序崩溃
//            break;
//        default:
//            sleep(10);//正常处理
//            break;
//    }
//}
//
//zkLock(0);

java实现

/**
 * Twitter_Snowflake<br>
 * SnowFlake的结构如下(每部分用-分开):<br>
 * 0 - 0000000000 0000000000 0000000000 0000000000 0 - 00000 - 00000 - 000000000000 <br>
 * 1位标识，由于long基本类型在Java中是带符号的，最高位是符号位，正数是0，负数是1，所以id一般是正数，最高位是0<br>
 * 41位时间截(毫秒级)，注意，41位时间截不是存储当前时间的时间截，而是存储时间截的差值（当前时间截 - 开始时间截)
 * 得到的值），这里的的开始时间截，一般是我们的id生成器开始使用的时间，由我们程序来指定的（如下下面程序IdWorker类的startTime属性）。41位的时间截，可以使用69年，年T = (1L << 41) / (1000L * 60 * 60 * 24 * 365) = 69<br>
 * 10位的数据机器位，可以部署在1024个节点，包括5位datacenterId和5位workerId<br>
 * 12位序列，毫秒内的计数，12位的计数顺序号支持每个节点每毫秒(同一机器，同一时间截)产生4096个ID序号<br>
 * 加起来刚好64位，为一个Long型。<br>
 * SnowFlake的优点是，整体上按照时间自增排序，并且整个分布式系统内不会产生ID碰撞(由数据中心ID和机器ID作区分)，并且效率较高，经测试，SnowFlake每秒能够产生26万ID左右。
 */
public class SnowflakeIdWorker {

    // ==============================Fields===========================================
    /** 开始时间截 (2015-01-01) */
    private final long twepoch = 1420041600000L;

    /** 机器id所占的位数 */
    private final long workerIdBits = 5L;

    /** 数据标识id所占的位数 */
    private final long datacenterIdBits = 5L;

    /** 支持的最大机器id，结果是31 (这个移位算法可以很快的计算出几位二进制数所能表示的最大十进制数) */
    private final long maxWorkerId = -1L ^ (-1L << workerIdBits);

    /** 支持的最大数据标识id，结果是31 */
    private final long maxDatacenterId = -1L ^ (-1L << datacenterIdBits);

    /** 序列在id中占的位数 */
    private final long sequenceBits = 12L;

    /** 机器ID向左移12位 */
    private final long workerIdShift = sequenceBits;

    /** 数据标识id向左移17位(12+5) */
    private final long datacenterIdShift = sequenceBits + workerIdBits;

    /** 时间截向左移22位(5+5+12) */
    private final long timestampLeftShift = sequenceBits + workerIdBits + datacenterIdBits;

    /** 生成序列的掩码，这里为4095 (0b111111111111=0xfff=4095) */
    private final long sequenceMask = -1L ^ (-1L << sequenceBits);

    /** 工作机器ID(0~31) */
    private long workerId;

    /** 数据中心ID(0~31) */
    private long datacenterId;

    /** 毫秒内序列(0~4095) */
    private long sequence = 0L;

    /** 上次生成ID的时间截 */
    private long lastTimestamp = -1L;

    //==============================Constructors=====================================
    /**
     * 构造函数
     * @param workerId 工作ID (0~31)
     * @param datacenterId 数据中心ID (0~31)
     */
    public SnowflakeIdWorker(long workerId, long datacenterId) {
        if (workerId > maxWorkerId || workerId < 0) {
            throw new IllegalArgumentException(String.format("worker Id can't be greater than %d or less than 0", maxWorkerId));
        }
        if (datacenterId > maxDatacenterId || datacenterId < 0) {
            throw new IllegalArgumentException(String.format("datacenter Id can't be greater than %d or less than 0", maxDatacenterId));
        }
        this.workerId = workerId;
        this.datacenterId = datacenterId;
    }

    // ==============================Methods==========================================
    /**
     * 获得下一个ID (该方法是线程安全的)
     * @return SnowflakeId
     */
    public synchronized long nextId() {
        long timestamp = timeGen();

        //如果当前时间小于上一次ID生成的时间戳，说明系统时钟回退过这个时候应当抛出异常
        if (timestamp < lastTimestamp) {
            throw new RuntimeException(
                    String.format("Clock moved backwards.  Refusing to generate id for %d milliseconds", lastTimestamp - timestamp));
        }

        //如果是同一时间生成的，则进行毫秒内序列
        if (lastTimestamp == timestamp) {
            sequence = (sequence + 1) & sequenceMask;
            //毫秒内序列溢出
            if (sequence == 0) {
                //阻塞到下一个毫秒,获得新的时间戳
                timestamp = tilNextMillis(lastTimestamp);
            }
        }
        //时间戳改变，毫秒内序列重置
        else {
            sequence = 0L;
        }

        //上次生成ID的时间截
        lastTimestamp = timestamp;

        //移位并通过或运算拼到一起组成64位的ID
        return ((timestamp - twepoch) << timestampLeftShift) //
                | (datacenterId << datacenterIdShift) //
                | (workerId << workerIdShift) //
                | sequence;
    }

    /**
     * 阻塞到下一个毫秒，直到获得新的时间戳
     * @param lastTimestamp 上次生成ID的时间截
     * @return 当前时间戳
     */
    protected long tilNextMillis(long lastTimestamp) {
        long timestamp = timeGen();
        while (timestamp <= lastTimestamp) {
            timestamp = timeGen();
        }
        return timestamp;
    }

    /**
     * 返回以毫秒为单位的当前时间
     * @return 当前时间(毫秒)
     */
    protected long timeGen() {
        return System.currentTimeMillis();
    }

    //==============================Test=============================================
    /** 测试 */
    public static void main(String[] args) {
        SnowflakeIdWorker idWorker = new SnowflakeIdWorker(0, 0);
        for (int i = 0; i < 1000; i++) {
            long id = idWorker.nextId();
            System.out.println(Long.toBinaryString(id));
            System.out.println(id);
        }
    }
}