doc : 【id生成器】： 分布式ID-雪花算法实现

src/main/java/com/kx/config/KxUtilsConfigurationProperties.java

@@ -20,6 +20,26 @@ public class KxUtilsConfigurationProperties {
          * 默认id生成器算法
          */
         String defaultIdGenerator = "uuid";
+
+        SnowFlowerConfig snowFlower = new SnowFlowerConfig();
+
     }
 
+    /**
+     * 雪花算法配置
+     */
+    @Data
+    public static class SnowFlowerConfig {
+        /**
+         * data center id
+         */
+        long dataCenterId = 1L;
+
+        /**
+         * worker id
+         */
+        long workerId = 1L;
+    }
+
+
 }

src/main/java/com/kx/utils/id/impl/SnowFlowerIdGenerator.java

+package com.kx.utils.id.impl;
+
+import com.kx.config.KxUtilsConfigurationProperties;
+import com.kx.utils.id.IdGenerator;
+import org.springframework.beans.factory.annotation.Autowired;
+import org.springframework.stereotype.Component;
+
+import javax.annotation.PostConstruct;
+
+/**
+ * 雪花算法
+ *
+ * @author kongxiang
+ */
+@Component
+public class SnowFlowerIdGenerator implements IdGenerator {
+    @Autowired
+    private KxUtilsConfigurationProperties kxUtilsConfigurationProperties;
+
+    private long dataCenterId;
+    private long workerId;
+
+    private volatile long sequence;
+    /**
+     * 上次时间戳，初始值为负数
+     */
+    private long lastTimestamp = -1L;
+
+
+    /**
+     * 初始时间戳
+     */
+    private final long twepoch = 1288834974657L;
+
+    /**
+     * 长度为5位
+     */
+    private final long workerIdBits = 5L;
+    private final long datacenterIdBits = 5L;
+    /**
+     * 最大值
+     */
+    private final long maxWorkerId = -1L ^ (-1L << workerIdBits);
+    private final long maxDatacenterId = -1L ^ (-1L << datacenterIdBits);
+    /**
+     * 序列号id长度
+     */
+    private final long sequenceBits = 12L;
+    /**
+     * 序列号最大值
+     */
+    private final long sequenceMask = -1L ^ (-1L << sequenceBits);
+
+    /**
+     * 工作id需要左移的位数，12位
+     */
+    private final long workerIdShift = sequenceBits;
+    /**
+     * 数据id需要左移位数 12+5=17位
+     */
+    private final long datacenterIdShift = sequenceBits + workerIdBits;
+    /**
+     * 时间戳需要左移位数 12+5+5=22位
+     */
+    private final long timestampLeftShift = sequenceBits + workerIdBits + datacenterIdBits;
+
+
+    /**
+     * 初始化雪花算法 dataCenterId & WorkId
+     */
+    @PostConstruct
+    public void init() {
+        KxUtilsConfigurationProperties.SnowFlowerConfig snowFlowerConfig = kxUtilsConfigurationProperties.getId().getSnowFlower();
+        this.dataCenterId = snowFlowerConfig.getDataCenterId();
+        this.workerId = snowFlowerConfig.getWorkerId();
+        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));
+        }
+        System.out.printf("worker starting. timestamp left shift %d, datacenter id bits %d, worker id bits %d, sequence bits %d, workerid %d",
+                timestampLeftShift, datacenterIdBits, workerIdBits, sequenceBits, workerId);
+    }
+
+    @Override
+    public String generate() {
+        return String.valueOf(nextId());
+    }
+
+    @Override
+    public String getAlgorithm() {
+        return "snowflower";
+    }
+
+    /**
+     * 使用一个 64 bit 的 long 型的数字作为全局唯一 id。在分布式系统中的应用十分广泛，且ID 引入了时间戳，基本上保持自增的。
+     * <p>
+     * 这 64 个 bit 中，其中 1 个 bit 是不用的（我们生成的 id 都是正数，所以第一个 bit 统一都是 0），
+     * 然后用其中的 41 bit 作为毫秒数，用 10 bit 作为工作机器 id，12 bit 作为序列号。
+     * <p>
+     * 64 bit 的 long 型数字：
+     * <p>
+     * 第一个部分，是 1 个 bit：0，这个是无意义的。
+     * <p>
+     * 第二个部分是 41 个 bit：表示的是时间戳。
+     * <p>
+     * 第三个部分是 5 个 bit：表示的是机房 id，10001。
+     * <p>
+     * 第四个部分是 5 个 bit：表示的是机器 id，1 1001。
+     * <p>
+     * 第五个部分是 12 个 bit：表示的序号，就是某个机房某台机器上这一毫秒内同时生成的 id 的序号，0000 00000000。
+     *
+     * @return
+     */
+    private synchronized long nextId() {
+        long timestamp = timeGen();
+        //获取当前时间戳如果小于上次时间戳，则表示时间戳获取出现异常
+        if (timestamp < lastTimestamp) {
+            System.err.printf("clock is moving backwards.  Rejecting requests until %d.", lastTimestamp);
+            throw new RuntimeException(String.format("Clock moved backwards.  Refusing to generate id for %d milliseconds",
+                    lastTimestamp - timestamp));
+        }
+
+        //获取当前时间戳如果等于上次时间戳（同一毫秒内），则在序列号加一；否则序列号赋值为0，从0开始。
+        if (lastTimestamp == timestamp) {
+            sequence = (sequence + 1) & sequenceMask;
+            if (sequence == 0) {
+                timestamp = tilNextMillis(lastTimestamp);
+            }
+        } else {
+            sequence = 0;
+        }
+
+        //将上次时间戳值刷新
+        lastTimestamp = timestamp;
+
+        /**
+         * 返回结果：
+         * (timestamp - twepoch) << timestampLeftShift) 表示将时间戳减去初始时间戳，再左移相应位数
+         * (datacenterId << datacenterIdShift) 表示将数据id左移相应位数
+         * (workerId << workerIdShift) 表示将工作id左移相应位数
+         * | 是按位或运算符，例如：x | y，只有当x，y都为0的时候结果才为0，其它情况结果都为1。
+         * 因为个部分只有相应位上的值有意义，其它位上都是0，所以将各部分的值进行 | 运算就能得到最终拼接好的id
+         */
+        return ((timestamp - twepoch) << timestampLeftShift) |
+                (dataCenterId << datacenterIdShift) |
+                (workerId << workerIdShift) |
+                sequence;
+    }
+
+
+    /**
+     * 获取系统时间戳
+     *
+     * @return
+     */
+    private long timeGen() {
+        return System.currentTimeMillis();
+    }
+
+    //获取时间戳，并与上次时间戳比较
+    private long tilNextMillis(long lastTimestamp) {
+        long timestamp = timeGen();
+        while (timestamp <= lastTimestamp) {
+            timestamp = timeGen();
+        }
+        return timestamp;
+    }
+
+}