百度开源分布式id生成器uid-generator源码剖析

百度uid-generator源码

https://github.com/baidu/uid-generator

snowflake算法

uid-generator是基于Twitter开源的snowflake算法实现的。

snowflake将long的64位分为了3部分,时间戳、工作机器id和序列号,位数分配如下。

其中,时间戳部分的时间单位一般为毫秒。也就是说1台工作机器1毫秒可产生4096个id(2的12次方)。

源码实现分析

与原始的snowflake算法不同,uid-generator支持自定义时间戳、工作机器id和序列号等各部分的位数,以应用于不同场景。默认分配方式如下。

  • sign(1bit)
    固定1bit符号标识,即生成的UID为正数。

  • delta seconds (28 bits)
    当前时间,相对于时间基点"2016-05-20"的增量值,单位:秒,最多可支持约8.7年(注意:1. 这里的单位是秒,而不是毫秒! 2.注意这里的用词,是“最多”可支持8.7年,为什么是“最多”,后面会讲)

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

  • sequence (13 bits)
    每秒下的并发序列,13 bits可支持每秒8192个并发。(注意下这个地方,默认支持qps最大为8192个)

DefaultUidGenerator

DefaultUidGenerator的产生id的方法与基本上就是常见的snowflake算法实现,仅有一些不同,如以秒为为单位而不是毫秒。

DefaultUidGenerator的产生id的方法如下。


 
 
  1. protected synchronized long nextId() {
  2. long currentSecond = getCurrentSecond();
  3. // Clock moved backwards, refuse to generate uid
  4. if (currentSecond < lastSecond) {
  5. long refusedSeconds = lastSecond - currentSecond;
  6. throw new UidGenerateException( "Clock moved backwards. Refusing for %d seconds", refusedSeconds);
  7. }
  8. // At the same second, increase sequence
  9. if (currentSecond == lastSecond) {
  10. sequence = (sequence + 1) & bitsAllocator.getMaxSequence();
  11. // Exceed the max sequence, we wait the next second to generate uid
  12. if (sequence == 0) {
  13. currentSecond = getNextSecond(lastSecond);
  14. }
  15. // At the different second, sequence restart from zero
  16. } else {
  17. sequence = 0L;
  18. }
  19. lastSecond = currentSecond;
  20. // Allocate bits for UID
  21. return bitsAllocator.allocate(currentSecond - epochSeconds, workerId, sequence);
  22. }

CachedUidGenerator

CachedUidGenerator支持缓存生成的id。

基本实现原理

关于CachedUidGenerator,文档上是这样介绍的。

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

【采用RingBuffer来缓存已生成的UID, 并行化UID的生产和消费】

使用RingBuffer缓存生成的id。RingBuffer是个环形数组,默认大小为8192个,里面缓存着生成的id。

获取id

会从ringbuffer中拿一个id,支持并发获取

填充id

RingBuffer填充时机

  • 程序启动时,将RingBuffer填充满,缓存着8192个id

  • 在调用getUID()获取id时,检测到RingBuffer中的剩余id个数小于总个数的50%,将RingBuffer填充满,使其缓存8192个id

  • 定时填充(可配置是否使用以及定时任务的周期)

【UidGenerator通过借用未来时间来解决sequence天然存在的并发限制】

因为delta seconds部分是以秒为单位的,所以1个worker 1秒内最多生成的id书为8192个(2的13次方)。

从上可知,支持的最大qps为8192,所以通过缓存id来提高吞吐量。

为什么叫借助未来时间?

因为每秒最多生成8192个id,当1秒获取id数多于8192时,RingBuffer中的id很快消耗完毕,在填充RingBuffer时,生成的id的delta seconds 部分只能使用未来的时间。

(因为使用了未来的时间来生成id,所以上面说的是,【最多】可支持约8.7年)

源码剖析

获取id


 
 
  1. @Override
  2. public long getUID() {
  3. try {
  4. return ringBuffer.take();
  5. } catch (Exception e) {
  6. LOGGER.error( "Generate unique id exception. ", e);
  7. throw new UidGenerateException(e);
  8. }
  9. }

RingBuffer缓存已生成的id

(注意:这里的RingBuffer不是Disruptor框架中的RingBuffer,但是借助了很多Disruptor中RingBuffer的设计思想,比如使用缓存行填充解决伪共享问题)

RingBuffer为环形数组,默认容量为sequence可容纳的最大值(8192个),可以通过boostPower参数设置大小。

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 补齐方式。


 
 
  1. public class RingBuffer {
  2. private static final Logger LOGGER = LoggerFactory.getLogger(RingBuffer.class);
  3. /** Constants */
  4. private static final int START_POINT = - 1;
  5. private static final long CAN_PUT_FLAG = 0L; //用于标记当前slot的状态,表示可以put一个id进去
  6. private static final long CAN_TAKE_FLAG = 1L; //用于标记当前slot的状态,表示可以take一个id
  7. public static final int DEFAULT_PADDING_PERCENT = 50; //用于控制何时填充slots的默认阈值:当剩余的可用的slot的个数,小于bufferSize的50%时,需要生成id将slots填满
  8. /** The size of RingBuffer's slots, each slot hold a UID */
  9. private final int bufferSize; //slots的大小,默认为sequence可容量的最大值,即8192个
  10. private final long indexMask;
  11. private final long[] slots; //slots用于缓存已经生成的id
  12. private final PaddedAtomicLong[] flags; //flags用于存储id的状态(是否可填充、是否可消费)
  13. /** Tail: last position sequence to produce */
  14. //Tail指针
  15. //表示Producer生产的最大序号(此序号从0开始,持续递增)。Tail不能超过Cursor,即生产者不能覆盖未消费的slot。当Tail已赶上curosr,此时可通过rejectedPutBufferHandler指定PutRejectPolicy
  16. private final AtomicLong tail = new PaddedAtomicLong(START_POINT); //
  17. /** Cursor: current position sequence to consume */
  18. //表示Consumer消费到的最小序号(序号序列与Producer序列相同)。Cursor不能超过Tail,即不能消费未生产的slot。当Cursor已赶上tail,此时可通过rejectedTakeBufferHandler指定TakeRejectPolicy
  19. private final AtomicLong cursor = new PaddedAtomicLong(START_POINT);
  20. /** Threshold for trigger padding buffer*/
  21. private final int paddingThreshold; //用于控制何时填充slots的阈值
  22. /** Reject put/take buffer handle policy */
  23. //当slots满了,无法继续put时的处理策略。默认实现:无法进行put,仅记录日志
  24. private RejectedPutBufferHandler rejectedPutHandler = this::discardPutBuffer;
  25. //当slots空了,无法继续take时的处理策略。默认实现:仅抛出异常
  26. private RejectedTakeBufferHandler rejectedTakeHandler = this::exceptionRejectedTakeBuffer;
  27. /** Executor of padding buffer */
  28. //用于运行【生成id将slots填满】任务
  29. private BufferPaddingExecutor bufferPaddingExecutor;

RingBuffer填充时机

  • 程序启动时,将RingBuffer填充满,缓存着8192个id

  • 在调用getUID()获取id时,检测到RingBuffer中的剩余id个数小于总个数的50%,将RingBuffer填充满,使其缓存8192个id

  • 定时填充(可配置是否使用以及定时任务的周期)

填充RingBuffer


 
 
  1. /**
  2. * Padding buffer fill the slots until to catch the cursor
  3. */
  4. public void paddingBuffer() {
  5. LOGGER.info( "Ready to padding buffer lastSecond:{}. {}", lastSecond.get(), ringBuffer);
  6. // is still running
  7. if (!running.compareAndSet( false, true)) {
  8. LOGGER.info( "Padding buffer is still running. {}", ringBuffer);
  9. return;
  10. }
  11. // fill the rest slots until to catch the cursor
  12. boolean isFullRingBuffer = false;
  13. while (!isFullRingBuffer) {
  14. //获取生成的id,放到RingBuffer中。
  15. List<Long> uidList = uidProvider.provide(lastSecond.incrementAndGet());
  16. for (Long uid : uidList) {
  17. isFullRingBuffer = !ringBuffer.put(uid);
  18. if (isFullRingBuffer) {
  19. break;
  20. }
  21. }
  22. }
  23. // not running now
  24. running.compareAndSet( true, false);
  25. LOGGER.info( "End to padding buffer lastSecond:{}. {}", lastSecond.get(), ringBuffer);
  26. }

生成id(上面代码中的uidProvider.provide调用的就是这个方法)


 
 
  1. /**
  2. * Get the UIDs in the same specified second under the max sequence
  3. *
  4. * @param currentSecond
  5. * @return UID list, size of {@link BitsAllocator#getMaxSequence()} + 1
  6. */
  7. protected List<Long> nextIdsForOneSecond(long currentSecond) {
  8. // Initialize result list size of (max sequence + 1)
  9. int listSize = ( int) bitsAllocator.getMaxSequence() + 1;
  10. List<Long> uidList = new ArrayList<>(listSize);
  11. // Allocate the first sequence of the second, the others can be calculated with the offset
  12. //这里的实现很取巧
  13. //因为1秒内生成的id是连续的,所以利用第1个id来生成后面的id,而不用频繁调用snowflake算法
  14. long firstSeqUid = bitsAllocator.allocate(currentSecond - epochSeconds, workerId, 0L);
  15. for ( int offset = 0; offset < listSize; offset++) {
  16. uidList.add(firstSeqUid + offset);
  17. }
  18. return uidList;

填充缓存行解决“伪共享”

关于伪共享,可以参考这篇文章《伪共享(false sharing),并发编程无声的性能杀手


 
 
  1. //数组在物理上是连续存储的,flags数组用来保存id的状态(是否可消费、是否可填充),在填入id和消费id时,会被频繁的修改。
  2. //如果不进行缓存行填充,会导致频繁的缓存行失效,直接从内存中读数据。
  3. private final PaddedAtomicLong[] flags;
  4. //tail和cursor都使用缓存行填充,是为了避免tail和cursor落到同一个缓存行上。
  5. /** Tail: last position sequence to produce */
  6. private final AtomicLong tail = new PaddedAtomicLong(START_POINT);
  7. /** Cursor: current position sequence to consume */
  8. private final AtomicLong cursor = new PaddedAtomicLong(START_POINT)

 
 
  1. /**
  2. * Represents a padded {@link AtomicLong} to prevent the FalseSharing problem<p>
  3. *
  4. * The CPU cache line commonly be 64 bytes, here is a sample of cache line after padding:<br>
  5. * 64 bytes = 8 bytes (object reference) + 6 * 8 bytes (padded long) + 8 bytes (a long value)
  6. * @author yutianbao
  7. */
  8. public class PaddedAtomicLong extends AtomicLong {
  9. private static final long serialVersionUID = - 3415778863941386253L;
  10. /** Padded 6 long (48 bytes) */
  11. public volatile long p1, p2, p3, p4, p5, p6 = 7L;
  12. /**
  13. * Constructors from {@link AtomicLong}
  14. */
  15. public PaddedAtomicLong() {
  16. super();
  17. }
  18. public PaddedAtomicLong(long initialValue) {
  19. super(initialValue);
  20. }
  21. /**
  22. * To prevent GC optimizations for cleaning unused padded references
  23. */
  24. public long sumPaddingToPreventOptimization() {
  25. return p1 + p2 + p3 + p4 + p5 + p6;
  26. }
  27. }

PaddedAtomicLong为什么要这么设计?

可以参考下面文章

一个Java对象到底占用多大内存?https://www.cnblogs.com/magialmoon/p/3757767.html

写Java也得了解CPU--伪共享 https://www.cnblogs.com/techyc/p/3625701.html

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值