SnowFlakeIDKeyGenerator (Mybatis-Flex)

java.lang.Object
- com.mybatisflex.core.keygen.impl.SnowFlakeIDKeyGenerator

所有已实现的接口:

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
从以下版本开始:

2023-05-12

作者:

王帅

字段概要

字段
限定符和类型	字段和说明
`protected InetAddress`	`address` IP 地址信息，用来生成工作机器 ID 和数据中心 ID。
`private static long`	`DATA_CENTER_ID_BITS` 数据中心 ID 占用的位数（5bit）。
`private static long`	`DATA_CENTER_ID_SHIFT` 数据中心 ID 位需要左移的位数（12bit + 5bit）。
`private long`	`dataCenterId` 数据中心 ID。
`private long`	`lastTimeMillis` 上次生产 ID 时间戳。
`private static long`	`MAX_DATA_CENTER_ID` 数据中心 ID 占用 5bit 时的最大值 31。
`private static long`	`MAX_WORKER_ID` 工作机器 ID 占用 5bit 时的最大值 31。
`private static long`	`offsetPeriod` 可容忍的时间偏移量。
`private long`	`sequence` 同一毫秒内的最新序号，最大值可为（2^12 - 1 = 4095）。
`private static long`	`SEQUENCE_BITS` 序号占用的位数（12bit）。
`private static long`	`SEQUENCE_MASK` 序号掩码，用于与自增后的序列号进行位“与”操作，如果值为 0，则代表自增后的序列号超过了 4095。
`private static long`	`TIMESTAMP_SHIFT` 时间戳需要左移的位数（12bit + 5bit + 5bit）。
`private static long`	`twepoch` 时间起始标记点，一旦确定不能变动（2023-04-02 13:01:00）。
`private static long`	`WORK_ID_SHIFT` 工作机器 ID 位需要左移的位数（12bit）。
`private static long`	`WORKER_ID_BITS` 工作机器 ID 占用的位数（5bit）。
`private long`	`workerId` 工作机器 ID。

构造器概要

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

方法概要

所有方法静态方法实例方法具体方法
限定符和类型	方法和说明
`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)`
`private long`	`tilNextMillis(long lastTimestamp)` 获取指定时间戳的接下来的时间戳。

从类继承的方法 java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- 字段详细资料
  - WORKER_ID_BITS
```
private static final long WORKER_ID_BITS
```
    工作机器 ID 占用的位数（5bit）。
    
    另请参阅:
    
    常量字段值
  - DATA_CENTER_ID_BITS
```
private static final long DATA_CENTER_ID_BITS
```
    数据中心 ID 占用的位数（5bit）。
    
    另请参阅:
    
    常量字段值
  - SEQUENCE_BITS
```
private static final long SEQUENCE_BITS
```
    序号占用的位数（12bit）。
    
    另请参阅:
    
    常量字段值
  - MAX_WORKER_ID
```
private static final long MAX_WORKER_ID
```
    工作机器 ID 占用 5bit 时的最大值 31。
    
    另请参阅:
    
    常量字段值
  - MAX_DATA_CENTER_ID
```
private static final long MAX_DATA_CENTER_ID
```
    数据中心 ID 占用 5bit 时的最大值 31。
    
    另请参阅:
    
    常量字段值
  - SEQUENCE_MASK
```
private static final long SEQUENCE_MASK
```
    序号掩码，用于与自增后的序列号进行位“与”操作，如果值为 0，则代表自增后的序列号超过了 4095。
    
    另请参阅:
    
    常量字段值
  - WORK_ID_SHIFT
```
private static final long WORK_ID_SHIFT
```
    工作机器 ID 位需要左移的位数（12bit）。
    
    另请参阅:
    
    常量字段值
  - DATA_CENTER_ID_SHIFT
```
private static final long DATA_CENTER_ID_SHIFT
```
    数据中心 ID 位需要左移的位数（12bit + 5bit）。
    
    另请参阅:
    
    常量字段值
  - TIMESTAMP_SHIFT
```
private static final long TIMESTAMP_SHIFT
```
    时间戳需要左移的位数（12bit + 5bit + 5bit）。
    
    另请参阅:
    
    常量字段值
  - twepoch
```
private static long twepoch
```
    时间起始标记点，一旦确定不能变动（2023-04-02 13:01:00）。
  - offsetPeriod
```
private static long offsetPeriod
```
    可容忍的时间偏移量。
  - workerId
```
private final long workerId
```
    工作机器 ID。
  - dataCenterId
```
private final long dataCenterId
```
    数据中心 ID。
  - address
```
protected InetAddress address
```
    IP 地址信息，用来生成工作机器 ID 和数据中心 ID。
  - sequence
```
private long sequence
```
    同一毫秒内的最新序号，最大值可为（2^12 - 1 = 4095）。
  - lastTimeMillis
```
private long lastTimeMillis
```
    上次生产 ID 时间戳。
- 构造器详细资料
  - SnowFlakeIDKeyGenerator
```
public SnowFlakeIDKeyGenerator()
```
    雪花算法 ID 生成器。
  - SnowFlakeIDKeyGenerator
```
public SnowFlakeIDKeyGenerator(InetAddress address)
```
    根据 IP 地址计算数据中心 ID 和工作机器 ID 生成数据库 ID。
    
    参数:
    
    address - IP 地址
  - SnowFlakeIDKeyGenerator
```
public SnowFlakeIDKeyGenerator(long workerId,
                               long dataCenterId)
```
    根据数据中心 ID 和工作机器 ID 生成数据库 ID。
    
    参数:
    
    workerId - 工作机器 ID
    
    dataCenterId - 数据中心 ID
- 方法详细资料
  - 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)
```
    指定者:
    
    generate 在接口中 IKeyGenerator
  - nextId
```
public long nextId()
```
    获取下一个 ID。
  - tilNextMillis
```
private long tilNextMillis(long lastTimestamp)
```
    获取指定时间戳的接下来的时间戳。
  - 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)
```

类 SnowFlakeIDKeyGenerator

字段概要

构造器概要

方法概要

从类继承的方法 java.lang.Object

字段详细资料

WORKER_ID_BITS

DATA_CENTER_ID_BITS

SEQUENCE_BITS

MAX_WORKER_ID

MAX_DATA_CENTER_ID

SEQUENCE_MASK

WORK_ID_SHIFT

DATA_CENTER_ID_SHIFT

TIMESTAMP_SHIFT

twepoch

offsetPeriod

workerId

dataCenterId

address

sequence

lastTimeMillis

构造器详细资料

SnowFlakeIDKeyGenerator

SnowFlakeIDKeyGenerator

SnowFlakeIDKeyGenerator

方法详细资料

getWorkerId

getDataCenterId

generate

nextId

tilNextMillis

getTwepoch

setTwepoch

getOffsetPeriod

setOffsetPeriod

getWorkerId

getDataCenterId

getAddress

setAddress

getSequence

setSequence

getLastTimeMillis

setLastTimeMillis