雪花算法工具类

1. 引言

在现代软件系统中, 唯一标识符(ID)的生成是一个直至关重要的任务, 无论是分布式系统中确保数据唯一性, 还是在高并发环境下快速分配唯一的标识, 都需要一种可靠且高效的ID生成方法. 雪花算法就是一种被广泛应用的解决方案, 而雪花算法工具类则为开发者提供便携的方式来实现这一功能.

2. 雪花算法简介

雪花算法是由 Twitter 开源的一种分布式ID生成算法. 它结合时间戳, 机器标识和序列号等信息, 生成一个64位的长整型唯一 ID. 这种算法有一下特点:

1. 唯一性: 生成的ID在分布式环境下具有高度的唯一性, 极大地降低了冲突的可能性.
2. 有序性: ID 是按照时间顺序生成的, 这对于某些需要按照时间排序处理任务非常有用
3. 高性能: 雪花算法能在高并发环境下快速生成唯一 ID, 满足大规模系统的需求.

3. 雪花算法工具类的作用

雪花算法工具类是对雪花算法的封装, 它提供了 简单易用的接口, 让开发者可以轻松地在自己的项目中使用雪花算法生成唯一ID. 以下是雪花算法工具类的一些主要作用:

1. 简化使用: 开发者无需深入了解雪花算法的具体实现细节, 只需要调用工具类的方法即可生成唯一ID
2. 可配置型: 工具类可以根据实际需求进行配置, 例如调整时间戳的位数, 机器标识的范围等.
3. 兼容性: 可以与不同的编程语言和框架集成, 方便在各种项目中使用

4. 雪花算法工具类的实现

public class SnowFlakeIdWorker {

    /**
     * 开始时间戳，单位毫秒；这里是2021-06-01
     */
    private static final long TW_EPOCH = 1622476800000L;

    /**
     * 机器 ID 所占的位数
     */
    private static final long WORKER_ID_BITS = 5L;

    /**
     * 数据标识 ID 所占的位数
     */
    private static final long DATA_CENTER_ID_BITS = 5L;

    /**
     * 支持的最大机器ID，最大为31
     *
     * PS. Twitter的源码是 -1L ^ (-1L << workerIdBits)；这里最后和-1进行异或运算，由于-1的二进制补码的特殊性，就相当于进行取反。
     */
    private static final long MAX_WORKER_ID = ~(-1L << WORKER_ID_BITS);

    /**
     * 支持的最大机房ID，最大为31
     */
    private static final long MAX_DATA_CENTER_ID = ~(-1L << DATA_CENTER_ID_BITS);

    /**
     * 序列在 ID 中占的位数
     */
    private static final long SEQUENCE_BITS = 12L;

    /**
     * 机器 ID 向左移12位
     */
    private static final long WORKER_ID_SHIFT = SEQUENCE_BITS;

    /**
     * 机房 ID 向左移17位
     */
    private static final long DATA_CENTER_ID_SHIFT = SEQUENCE_BITS + WORKER_ID_BITS;

    /**
     * 时间截向左移22位
     */
    private static final long TIMESTAMP_LEFT_SHIFT = SEQUENCE_BITS + WORKER_ID_BITS + DATA_CENTER_ID_BITS;

    /**
     * 生成序列的掩码最大值，最大为4095
     */
    private static final long SEQUENCE_MASK = ~(-1L << SEQUENCE_BITS);

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

    /**
     * 机房 ID(0~31)
     */
    private final long dataCenterId;

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

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

    /**
     * 创建 ID 生成器的方式一: 使用工作机器的序号(也就是将机房的去掉给机器ID使用)，范围是 [0, 1023]，优点是方便给机器编号
     *
     * @param workerId 工作机器 ID
     */
    public SnowFlakeIdWorker(long workerId) {
        // 计算最大值
        long maxMachineId = (MAX_DATA_CENTER_ID + 1) * (MAX_WORKER_ID + 1) - 1;

        if (workerId < 0 || workerId > maxMachineId) {
            throw new IllegalArgumentException(String.format("Worker ID can't be greater than %d or less than 0", maxMachineId));
        }

        // 取高位部分作为机房ID部分
        this.dataCenterId = (workerId >> WORKER_ID_BITS) & MAX_DATA_CENTER_ID;
        // 取低位部分作为机器ID部分
        this.workerId = workerId & MAX_WORKER_ID;
    }

    /**
     * 创建 ID 生成器的方式二: 使用工作机器 ID 和机房 ID，优点是方便分机房管理
     *
     * @param dataCenterId 机房 ID (0~31)
     * @param workerId     工作机器 ID (0~31)
     */
    public SnowFlakeIdWorker(long dataCenterId, long workerId) {
        if (workerId > MAX_WORKER_ID || workerId < 0) {
            throw new IllegalArgumentException(String.format("Worker ID can't be greater than %d or less than 0", MAX_WORKER_ID));
        }
        if (dataCenterId > MAX_DATA_CENTER_ID || dataCenterId < 0) {
            throw new IllegalArgumentException(String.format("DataCenter ID can't be greater than %d or less than 0", MAX_DATA_CENTER_ID));
        }

        this.workerId = workerId;
        this.dataCenterId = dataCenterId;
    }

    /**
     * 获得下一个 ID(该方法是线程安全的)
     *
     * @return 返回一个长度位15的 long类型的数字
     */
    public synchronized long nextId() {
        long timestamp = timeGen();
        // 如果当前时间小于上一次 ID 生成的时间戳，说明发生时钟回拨，为保证ID不重复抛出异常。
        if (timestamp < lastTimestamp) {
            throw new RuntimeException(String.format("Clock moved backwards. Refusing to generate id for %d milliseconds", lastTimestamp - timestamp));
        }

        if (lastTimestamp == timestamp) {
            // 同一时间生成的，则序号+1
            sequence = (sequence + 1) & SEQUENCE_MASK;
            // 毫秒内序列溢出：超过最大值
            if (sequence == 0) {
                // 阻塞到下一个毫秒，获得新的时间戳
                timestamp = tilNextMillis(lastTimestamp);
            }
        } else {
            // 时间戳改变，毫秒内序列重置
            sequence = 0L;
        }
        // 上次生成 ID 的时间戳
        lastTimestamp = timestamp;

        // 移位并通过或运算拼到一起
        return ((timestamp - TW_EPOCH) << TIMESTAMP_LEFT_SHIFT)
                | (dataCenterId << DATA_CENTER_ID_SHIFT)
                | (workerId << WORKER_ID_SHIFT)
                | sequence;
    }

    private long tilNextMillis(long lastTimestamp) {
        long timestamp = timeGen();
        while (timestamp <= lastTimestamp) {
            timestamp = timeGen();
        }
        return timestamp;
    }

    private long timeGen() {
        return System.currentTimeMillis();
    }
}

上面这个示例中, 实现了雪花算法工具类

5. 使用雪花算法工具类

SnowFlakeIdWorker snowFlakeIdWorker = new SnowFlakeIdWorker(1, 0);
// Object 表的实体类
Object.setId(snowFlakeIdWorker.nextId());

6. 总结

雪花算法是一种强大的工具, 它为开发者提供了一种高效, 可靠的方式生成唯一ID, 通过封装雪花算法的复杂实现细节, 工具类使得在各种项目中使用雪花算法变得更加简单和便携. 无论在分布式系统中还是在高并发环境下, 雪花算法工具类都能发挥重要的作用, 确保数据的唯一性和系统的稳定性. 在实际应用中, 开发者可以根据自己的需求对工具类进行进一步的扩展和优化, 以满足特定的业务场景.