/generate-uid

统一生产分布式ID策略生成器，去除了原百度对数据库的依赖，改用NoSQL的mongodb方式来实现，方便扩展，同时增加twitter的雪花算法。

Primary LanguageJava

seeker-generate-uid

==========================

探索者统一生产分布式ID策略生成器，去除了原百度对数据库的依赖，改用NoSQL的mongodb方式来实现，方便扩展。

前言

此项目计划将 百度UID 更改成Spring Boot的一个派生版本，改造为基于spring boot的版本，并封装为starter的方式，以方便作为组件引入到spring boot项目， 并去除对数据库的依赖，方便服务化的资源引用，只须将seeker-uid-core发布maven中引入即可轻松使用，做到即开即用，无须过多配置。

工程结构说明：

├── README.md
├── seeker-uid-generator	# 分布式ID调用接口
└──seeker-uid-core	# 分布式ID核心类与服务实现类

概述

UidGenerator是Java实现的，基于Snowflake算法的唯一ID生成器。UidGenerator以组件形式工作在应用项目中, 支持自定义workerId位数和初始化策略, 从而适用于docker等虚拟化环境下实例自动重启、漂移等场景。

在实现上, UidGenerator通过借用未来时间来解决sequence天然存在的并发限制; 采用RingBuffer来缓存已生成的UID, 并行化UID的生产和消费，同时对CacheLine补齐，避免了由RingBuffer带来的硬件级「伪共享」问题. 最终单机QPS可达600万。

依赖版本：Java8及以上版本，mongodb(内置WorkerID分配器, 启动阶段通过DB进行分配; 如自定义实现, 则DB非必选依赖）。

Snowflake算法

Snowflake算法描述：指定机器 & 同一时刻 & 某一并发序列，是唯一的。据此可生成一个64 bits的唯一ID（long）。默认采用上图字节分配方式：

  • sign(1bit)

    固定1bit符号标识，即生成的UID为正数。

  • delta seconds (28 bits)

    当前时间，相对于时间基点"2016-05-20"的增量值，单位：秒，最多可支持约8.7年

  • worker id (22 bits)

    机器id，最多可支持约420w次机器启动。内置实现为在启动时由数据库分配，默认分配策略为用后即弃，后续可提供复用策略。

  • sequence (13 bits)

    每秒下的并发序列，13 bits可支持每秒8192个并发。

以上参数均可通过application.yml进行自定义：

prong: 
  uid: 
    timeBits: 29
    workerBits: 21
    seqBits: 13
    epochStr: "2018-11-26"

组件功能简述

UidGenerator在应用中是以 Spring 组件的形式提供服务。

  • DefaultUidGenerator提供了最简单的Snowflake式的生成模式，但是并没有使用任何缓存来预存UID，在需要生成ID的时候即时进行计算。
  • CachedUidGenerator是一个使用RingBuffer预先缓存UID的生成器，在初始化时就会填充整个RingBuffer，并在take()时检测到少于指定的填充阈值之后就会异步地再次填充RingBuffer（默认值为50%），另外可以启动一个定时器周期性检测阈值并及时进行填充。

CachedUidGenerator

RingBuffer环形数组，数组每个元素成为一个slot。RingBuffer容量，默认为Snowflake算法中sequence最大值，且为2^N。可通过boostPower配置进行扩容，以提高RingBuffer读写吞吐量。

Tail指针、Cursor指针用于环形数组上读写slot：

  • Tail指针

    表示Producer生产的最大序号(此序号从0开始，持续递增)。Tail不能超过Cursor，即生产者不能覆盖未消费的slot。当Tail已赶上curosr，此时可通过rejectedPutBufferHandler指定PutRejectPolicy。

  • Cursor指针

    表示Consumer消费到的最小序号(序号序列与Producer序列相同)。Cursor不能超过Tail，即不能消费未生产的slot。当Cursor已赶上tail，此时可通过rejectedTakeBufferHandler指定TakeRejectPolicy。

CachedUidGenerator采用了双RingBuffer，Uid-RingBuffer用于存储Uid、Flag-RingBuffer用于存储Uid状态(是否可填充、是否可消费)。由于数组元素在内存中是连续分配的，可最大程度利用CPU cache以提升性能。但同时会带来「伪共享」FalseSharing问题，为此在Tail、Cursor指针、Flag-RingBuffer中采用了CacheLine补齐方式。

RingBuffer填充时机

  • 初始化预填充

    RingBuffer初始化时，预先填充满整个RingBuffer。

  • 即时填充

    Take消费时，即时检查剩余可用slot量(tail - cursor)，如小于设定阈值，则补全空闲slots。阈值可通过paddingFactor来进行配置，请参考Quick Start中CachedUidGenerator配置。

  • 周期填充（默认不启用）

    通过Schedule线程，定时补全空闲slots。可通过scheduleInterval配置，以应用定时填充功能，并指定Schedule时间间隔。

Quick Start

运行单元测试

步骤1: 安装依赖

先下载Java8,mongodb和Maven

设置环境变量

maven无须安装, 设置好MAVEN_HOME即可. 可像下述脚本这样设置JAVA_HOME和MAVEN_HOME, 如已设置请忽略.

export MAVEN_HOME=/xxx/xxx/software/maven/apache-maven-3.3.9
export PATH=$MAVEN_HOME/bin:$PATH
JAVA_HOME="/Library/Java/JavaVirtualMachines/jdk1.8.0_91.jdk/Contents/Home";
export JAVA_HOME;

步骤2: 建立mongodb配置即可，不依赖于数据库

mongo的运行较为简单，本文环境以docker为基础，mongo创建执行如下脚本：

version: '3.1'

services:

  mongo:
    image: mongo
    restart: always
    ports:
      - "27017:27017"
    volumes:
      - /mnt/data/mongo:/data/db
    environment:
      MONGO_INITDB_ROOT_USERNAME: uid
      MONGO_INITDB_ROOT_PASSWORD: 123456

步骤3: 修改Spring Boot配置

提供了两种生成器：DefaultUidGenerator、CachedUidGenerator。如对UID生成性能有要求，请使用CachedUidGenerator。

DefaultUidGenerator配置

在 application.yml 中配置ID生成规则：

# 以下为可选配置, 如未指定将采用默认值
prong: 
  uid: 
    timeBits: 29
    workerBits: 21
    seqBits: 13
    epochStr: "2018-11-26"

spring boot 中生成 WorkerIdAssigner 接口的一个实例：

@Bean
@ConditionalOnMissingBean
WorkerIdAssigner workerIdAssigner() {
	return new DisposableWorkerIdAssigner();
}

注意：DisposableWorkerIdAssigner 可以根据需要替换成其他实现。

CachedUidGenerator配置

在 application.yml 中配置ID生成规则：

# 以下为可选配置, 如未指定将采用默认值
prong: 
  uid: 
    timeBits: 29
    workerBits: 21
    seqBits: 13
    epochStr: "2018-11-26"
    CachedUidGenerator:
      boost-power: 3          # RingBuffer size扩容参数, 可提高UID生成的吞吐量, 默认:3
      padding-factor: 50      # 指定何时向RingBuffer中填充UID, 取值为百分比(0, 100), 默认为50
      #schedule-interval: 60  # 默认:不配置此项, 即不实用Schedule线程. 如需使用, 请指定Schedule线程时间间隔, 单位:秒

spring boot 中生成 WorkerIdAssigner 接口的一个实例：

@Bean
@ConditionalOnMissingBean
WorkerIdAssigner workerIdAssigner() {
	return new DisposableWorkerIdAssigner();
}

注意：DisposableWorkerIdAssigner 可以根据需要替换成其他实现。

根据需要指定2个拒绝策略的接口实现（默认无需指定）：

  • RejectedPutBufferHandler接口：拒绝策略: 当环已满, 无法继续填充。 默认无需指定, 将丢弃Put操作, 仅日志记录. 如有特殊需求, 请实现该接口(支持Lambda表达式)。
  • RejectedTakeBufferHandler接口：拒绝策略: 当环已空, 无法继续获取时。 默认无需指定, 将记录日志, 并抛出UidGenerateException异常. 如有特殊需求, 请实现该接口(支持Lambda表达式)。

例如，下面实现了一个当环已满, 无法继续填充时的自定义策略：

@Component
public class CustomRejectedPutBufferHandler implements RejectedPutBufferHandler {

	/**
	 * 只打印，不记日志
	 */
	@Override
	public void rejectPutBuffer(RingBuffer ringBuffer, long uid) {
		System.out.format("Rejected putting buffer for uid:{%d}. {%s}\r\n", uid, ringBuffer.toString());
	}
}

在Spring Boot项目使用UID组件

本项目提供了一个名为 seeker-uid-generator 的 Spring Boot 的项目例子以供参考。