5 分钟学会雪花算法 (Golang)

前言

“

嗨，everybody，我是asong，这是我的第十二篇文章，今天给大家介绍一下雪花算法。介绍雪花算法是次要的，因为大家都太熟悉了，主要目的是推荐一下我的新系列。今天，我突发奇想，想创建一个新系列。这个系列主要是存储我们日常工作开发中使用的算法，比如雪花算法、哈希算法等等。网络上关于这些算法的知识还是很多的，但是很杂，想找一个算法很不容易，还要看各种各样的博客，五花八门的。所以我们现在的想法就是想将这些算法整理到一起，全部采用go实现，并附带基础知识学习，代码说明这样的详细文档，这样我们想要学习一门新算法时，都可以在这里找到，如果没有也可以提交issues一块完善。目前也是刚刚起步，现在只有雪花算法的代码文档，以后会慢慢完善起来的，有兴趣的小伙伴欢迎加入进来，我们一起完善。详情请看github说明：https://github.com/asong2020/go-algorithm。

雪花算法背景

雪花算法产生的背景当然是twitter高并发环境下对唯一ID生成的需求，得益于twitter内部牛逼的技术，雪花算法能够流传于至今并且被广泛使用，是因为它有几个特点

能满足高并发分布式系统环境下ID不重复
生成效率高
基于时间戳，可以保证基本有序递增
不依赖于第三方的库或者中间件
生成的id具有时序性和唯一性

雪花算法原理

先来看一个图片吧，来源于网络：

由图我们可以看出来，snowFlake ID结构是一个64bit的int型数据。

第1位bit

在二进制中最高位为1，表示的是负数，因为我们使用的id应该都是整数，所以这里最高位应该是0。

41bit时间戳

41位可以表示2^41-1个数字，如果只用来表示正整数，可以表示的数值范围是：0 – (2^41 -1)，这里减去1的原因就是因为数值范围是从0开始计算的，而不是从1开始的。

这里的单位是毫秒，所以41位就可以表示2^41-1个毫秒值，这样转化成单位年则是(2^41-1)/(1000 * 60 * 60 * 24 * 365) = 69

10bit-工作机器id

这里是用来记录工作机器的id。2^10=1024表示当前规则允许分布式最大节点数为1024个节点。这里包括5位的workerID和5位的dataCenterID，这里其实可以不区分，但我下面的代码进行了区分。

12bit-序列号

用来记录同毫秒内产生的不同id。12bit可以表示的最大正整数是2^12-1=4095，即可以用0,1,2,3,……4094这4095个数字，表示同一机器同一时间戳(毫秒)内产生的4095个ID序号。

原理就是上面这些，没有什么难度吧，下面我们看代码如何实现：

go实现雪花算法

1. 定义基本常量

先看代码，我们依次介绍：

const (
 workerIDBits =  uint64(5)  // 10bit 工作机器ID中的 5bit workerID
 dataCenterIDBits = uint64(5) // 10 bit 工作机器ID中的 5bit dataCenterID
 sequenceBits = uint64(12)

 maxWorkerID = int64(-1) ^ (int64(-1) << workerIDBits) //节点ID的最大值 用于防止溢出
 maxDataCenterID = int64(-1) ^ (int64(-1) << dataCenterIDBits)
 maxSequence = int64(-1) ^ (int64(-1) << sequenceBits)

 timeLeft = uint8(22)  // timeLeft = workerIDBits + sequenceBits // 时间戳向左偏移量
 dataLeft = uint8(17)  // dataLeft = dataCenterIDBits + sequenceBits
 workLeft = uint8(12)  // workLeft = sequenceBits // 节点IDx向左偏移量
 // 2020-05-20 08:00:00 +0800 CST
 twepoch = int64(1589923200000) // 常量时间戳(毫秒)
)

下面对这段代码的每一个常量进行解释：

worerIDBits：这里就是对应上图中的10bit-工作机器id，我这里进行拆分了。这是其中5bit“worerIDBits`
dataCenterIDBits：这里就是对应上图中的10bit-工作机器id，我这里进行拆分了。这是其中5bitdataCenterIDBits
sequenceBits：对应上图中的12bit的序列号
maxWorkerID：这里就是求最大，只不过我们采用了异或的方式，因为-1的二进制表示为1的补码，说通俗一点，这里其实就是2^5-1，还不懂的同学，可以自己验证一下
maxDataCenterID：原理同上
maxSequence：原理同上
timeLeft：时间戳向左偏移量，这么你们可能不懂，看上面的图片，由右向左的偏移量是不是22，这么说你们懂了吗？
dataLeft：原理同上，也是求偏移量的
workLeft：原理同上；
twepoch：41bit的时间戳，单位是毫秒，这里我选择的时间是2020-05-20 08:00:00 +0800 CST，这个ID一但生成就不要改了，要不会生成相同的ID。

2. 定义worker工作节点

因为这个是在分布式下使用的ID生成算法，所以我们要生成多个worker，所以要把节点参数抽象出来。

type Worker struct {
 mu sync.Mutex
 LastStamp int64 // 记录上一次ID的时间戳
 WorkerID int64 // 该节点的ID
 DataCenterID int64 // 该节点的 数据中心ID
 Sequence int64 // 当前毫秒已经生成的ID序列号(从0 开始累加) 1毫秒内最多生成4096个ID
}

代码解释：

mu sync.Mutex：添加互斥锁，确保并发安全性
LastStamp int64：记录上一次生成ID的时间戳
WorkerID int64：该工作节点的ID 对上图中的5bit workerID 一个意思
DataCenterID int64：原理同上
Sequence int64：当前毫秒已经生成的id序列号(从0开始累加) 1毫秒内最多生成4096个ID

3. 创建一个worker对象

//分布式情况下,我们应通过外部配置文件或其他方式为每台机器分配独立的id
func NewWorker(workerID,dataCenterID int64) *Worker  {
 return &Worker{
  WorkerID: workerID,
  LastStamp: 0,
  Sequence: 0,
  DataCenterID: dataCenterID,
 }
}

这里没有什么好解释的～～～。

4. 生成id

先看代码：

func (w *Worker) getMilliSeconds() int64 {
 return time.Now().UnixNano() / 1e6
}

func (w *Worker)NextID() (uint64,error) {
 w.mu.Lock()
 defer w.mu.Unlock()


 return w.nextID()
}

func (w *Worker)nextID() (uint64,error) {
 timeStamp := w.getMilliSeconds()
 if timeStamp < w.LastStamp{
  return 0,errors.New("time is moving backwards,waiting until")
 }

 if w.LastStamp == timeStamp{

  w.Sequence = (w.Sequence + 1) & maxSequence

  if w.Sequence == 0 {
   for timeStamp <= w.LastStamp {
    timeStamp = w.getMilliSeconds()
   }
  }
 }else {
  w.Sequence = 0
 }

 w.LastStamp = timeStamp
 id := ((timeStamp - twepoch) << timeLeft) |
  (w.DataCenterID << dataLeft)  |
  (w.WorkerID << workLeft) |
  w.Sequence

 return uint64(id),nil
}

代码有点长，我先来依次解释一下：

getMilliSeconds()：封装的一个方法，用来获取当前的毫秒值
func (w *Worker)NextID() (uint64,error)

这个代码的内容没有什么，具体生成ID算法封装在func (w *Worker)nextID() (uint64,error)这里了，这里不过是为了解藕作用；对了还有一个特别重要的地方，加锁、释放锁，这个步骤很重要。

func (w *Worker)nextID() (uint64,error)

这里是真正的生成id代码了。分为几个步骤：

获取当前时间戳，进行判断，要确保当前时间戳值大于上一次生成ID的时间戳，否则会出现重复。
如果想等了，首先获取当前的当前毫秒已经生成的id序列号。这里你们可能没看懂，其实他等效于if w.sequence++ > maxSequence

, 如果当前毫秒已经生成的id序列号溢出了，则需要等待下一毫秒，如果不等待，就会导致很多重复。

我们在else里将w.sequence置零了，这里解释一下，如果当前时间与工作节点上一次生成ID的时间不一致则需要重置工作节点生成ID的序号。
最后一步，比较重要，采用了或运算，这里的目的就是各部分的bit进行归位并通过按位或运算(就是这个‘|’)将其整合。<<这个就是向左偏移的作用进行归位，而|运算就是为了整合。可能大家还没懂，看下面这一张图片吧：

怎么样，是不是知道什么意思了。

5. 测试

写好了代码，我们就来测试一下吧，这里我并发10000个goroutine进行生成ID，存入到map，查看是否出现重复，来看代码：

var wg sync.WaitGroup

func main()  {
 w := idgen.NewWorker(5,5)

 ch := make(chan uint64,10000)
 count := 10000
 wg.Add(count)
 defer close(ch)
 //并发 count个goroutine 进行 snowFlake ID 生成
 for i:=0 ; i < count ; i++ {
  go func() {
   defer wg.Done()
   id,_ := w.NextID()
   ch <- id
  }()
 }
 wg.Wait()
 m := make(map[uint64]int)
 for i := 0; i < count; i++  {
  id := <- ch
  // 如果 map 中存在为 id 的 key, 说明生成的 snowflake ID 有重复
  _, ok := m[id]
  if ok {
   fmt.Printf("repeat id %d\n",id)
   return
  }
  // 将 id 作为 key 存入 map
  m[id] = i
 }
 // 成功生成 snowflake ID
 fmt.Println("All", len(m), "snowflake ID Get successed!")

}

验证结果：

All 10000 snowflake ID Get successed!

总结

好啦，这一篇文章到这里结束啦，雪花算法并没有我们想象的那么难，还是很好实现的，你学会了吗？没学会不要紧，下载源代码，再看一看，对你不是问题的～～～。

GitHub：https://github.com/asong2020/go-algorithm 欢迎star 感谢各位～～～

朋友们，还记得我开头说的那些吗？有兴趣的欢迎加入进来呦，我们一起进步～～～。

结尾给大家发一个小福利吧，最近我在看[微服务架构设计模式]这一本书，讲的很好，自己也收集了一本PDF，有需要的小伙可以到自行下载。获取方式：关注公众号：[Golang梦工厂]，后台回复：[微服务]，即可获取。

我翻译了一份GIN中文文档，会定期进行维护，有需要的小伙伴后台回复[gin]即可下载。

我是asong，一名普普通通的程序猿，让我一起慢慢变强吧。我自己建了一个golang交流群，有需要的小伙伴加我vx,我拉你入群。欢迎各位的关注，我们下期见~~~

推荐往期文章：

转载请注明：爱学习爱分享 » 5 分钟学会雪花算法 (Golang)