com.mybatisflex.core.keygen.impl

Class SnowFlakeIDKeyGenerator

java.lang.Object

com.mybatisflex.core.keygen.impl.SnowFlakeIDKeyGenerator

All Implemented Interfaces:

IKeyGenerator

public class SnowFlakeIDKeyGenerator
extends Object
implements IKeyGenerator

雪花算法 ID 生成器。

• 最高 1 位固定值 0，因为生成的 ID 是正整数；
• 接下来 41 位存储毫秒级时间戳，2 ^ 41 / ( 1000 * 60 * 60 * 24 * 365) = 69，大概可以使用 69 年；
• 再接下 10 位存储机器码，包括 5 位 dataCenterId 和 5 位 workerId，最多可以部署 2 ^ 10 = 1024 台机器；
• 最后 12 位存储序列号，同一毫秒时间戳时，通过这个递增的序列号来区分，即对于同一台机器而言，同一毫秒时间戳下，可以生成 2 ^ 12 = 4096 个不重复 ID。

优化自开源项目：Sequence

Since:

2023-05-12

Author:

王帅

Field Summary

Fields

Modifier and Type	Field and Description
protected InetAddress	address IP 地址信息，用来生成工作机器 ID 和数据中心 ID。

Constructor Summary

Constructors

Constructor and Description
SnowFlakeIDKeyGenerator() 雪花算法 ID 生成器。
SnowFlakeIDKeyGenerator(InetAddress address) 根据 IP 地址计算数据中心 ID 和工作机器 ID 生成数据库 ID。
SnowFlakeIDKeyGenerator(long workerId, long dataCenterId) 根据数据中心 ID 和工作机器 ID 生成数据库 ID。

Method Summary

Modifier and Type	Method and Description
Object	generate(Object entity, String keyColumn)
InetAddress	getAddress()
long	getDataCenterId()
protected long	getDataCenterId(long maxDataCenterId) 根据网卡 MAC 地址计算余数作为数据中心 ID。
long	getLastTimeMillis()
static long	getOffsetPeriod()
long	getSequence()
static long	getTwepoch()
long	getWorkerId()
protected long	getWorkerId(long dataCenterId, long maxWorkerId) 根据 MAC + PID 的 hashCode 获取 16 个低位生成工作机器 ID。
long	nextId() 获取下一个 ID。
void	setAddress(InetAddress address)
void	setLastTimeMillis(long lastTimeMillis)
static void	setOffsetPeriod(long offsetPeriod)
void	setSequence(long sequence)
static void	setTwepoch(long twepoch)

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

address

protected InetAddress address

IP 地址信息，用来生成工作机器 ID 和数据中心 ID。

Constructor Detail

SnowFlakeIDKeyGenerator

public SnowFlakeIDKeyGenerator()

雪花算法 ID 生成器。

SnowFlakeIDKeyGenerator

public SnowFlakeIDKeyGenerator(InetAddress address)

根据 IP 地址计算数据中心 ID 和工作机器 ID 生成数据库 ID。

Parameters:

address - IP 地址

SnowFlakeIDKeyGenerator

public SnowFlakeIDKeyGenerator(long workerId,
                               long dataCenterId)

根据数据中心 ID 和工作机器 ID 生成数据库 ID。

Parameters:

workerId - 工作机器 ID

dataCenterId - 数据中心 ID

Method Detail

getWorkerId

protected long getWorkerId(long dataCenterId,
                           long maxWorkerId)

根据 MAC + PID 的 hashCode 获取 16 个低位生成工作机器 ID。

getDataCenterId

protected long getDataCenterId(long maxDataCenterId)

根据网卡 MAC 地址计算余数作为数据中心 ID。

generate

public Object generate(Object entity,
                       String keyColumn)

Specified by:

generate in interface IKeyGenerator

nextId

public long nextId()

获取下一个 ID。

getTwepoch

public static long getTwepoch()

setTwepoch

public static void setTwepoch(long twepoch)

getOffsetPeriod

public static long getOffsetPeriod()

setOffsetPeriod

public static void setOffsetPeriod(long offsetPeriod)

getWorkerId

public long getWorkerId()

getDataCenterId

public long getDataCenterId()

getAddress

public InetAddress getAddress()

setAddress

public void setAddress(InetAddress address)

getSequence

public long getSequence()

setSequence

public void setSequence(long sequence)

getLastTimeMillis

public long getLastTimeMillis()

setLastTimeMillis

public void setLastTimeMillis(long lastTimeMillis)