[C#] 分布式ID自增算法 Snowflake

最近在尝试EF的多数据库移植，但是原始项目中主键用的Sqlserver的GUID。MySQL没法移植了。

其实发现GUID也没法保证数据的递增性，又不太想使用int递增主键，就开始探索别的ID形式。

后来发现twitter的Snowflake算法。

一开始我尝试过直接引用Nuget里的Snowflake的扩展包（有Framework版和Core版），不过有些Bug，就是初始化参数有的时候不一定好用，最大问题是，这个需要实例化对象，并且通过同一个对象来实生成ID，否则会出现ID冲突问题。而且，我们还要考虑对象在内存的生存问题。学习这种算法是够用了，但是用到实际生产中则有很多问题，虽然我们可以通过一些技术来避免这种问题，但是总觉得不够优雅，不符合我的美学！

后来看到这篇博客 C# 实现 Snowflake算法 先感谢一下这个大神。但是同样有上述的部分问题，做5线程的并发测试的时候效率不如扩展的。后面我们会提到。

我从这篇博客里摘来了源码，对有的地方做了一些改动使得其更适合（至少我认为是）更适合生产环境。

先贴源码

　　public class SFID
    {
        /// <summary>
        /// 机器码
        /// </summary>
        private static long _workerId;

        /// <summary>
        /// 初始基准时间戳，小于当前时间点即可
        /// 分布式项目请保持此时间戳一致
        /// </summary>
        private static long _twepoch = 0L;

        /// <summary>
        /// 毫秒计数器
        /// </summary>
        private static long sequence = 0L;

        /// <summary>
        /// 机器码字节数。4个字节用来保存机器码(定义为Long类型会出现，最大偏移64位，所以左移64位没有意义)
        /// </summary>
        private static int workerIdBits = 4; 

        /// <summary>
        /// 最大机器ID所占的位数
        /// </summary>
        private static long maxWorkerId = -1L ^ -1L << workerIdBits;

        /// <summary>
        /// 计数器字节数，10个字节用来保存计数码
        /// </summary>
        private static int sequenceBits = 12;

        /// <summary>
        /// 机器码数据左移位数，就是后面计数器占用的位数
        /// </summary>
        private static int workerIdShift = sequenceBits;

        /// <summary>
        /// 时间戳左移动位数就是机器码和计数器总字节数
        /// </summary>
        private static int timestampLeftShift = sequenceBits + workerIdBits;

        /// <summary>
        /// 一微秒内可以产生计数，如果达到该值则等到下一微妙在进行生成
        /// </summary>
        private static long sequenceMask = -1L ^ -1L << sequenceBits;

        /// <summary>
        /// 最后一次的时间戳
        /// </summary>
        private static long lastTimestamp = -1L;

        /// <summary>
        /// 线程锁对象
        /// </summary>
        private static object locker = new object();
        
        static SFID()
        {
            _workerId = new Random(DateTime.Now.Millisecond).Next(1, (int)maxWorkerId);
            _twepoch = timeGen(2010, 1, 1, 0, 0, 0);
        }

        /// <summary>
        /// 机器编号
        /// </summary>
        public static long WorkerID
        {
            get { return _workerId; }
            set
            {
                if (value > 0 && value < maxWorkerId)
                    _workerId = value;
                else
                    throw new Exception("Workerid must be greater than 0 or less than " + maxWorkerId);
            }
        }

        /// <summary>
        /// 获取新的ID
        /// </summary>
        /// <returns></returns>
        public static long NewID()
        {
            lock (locker)
            {
                long timestamp = timeGen();
                if (lastTimestamp == timestamp)
                { //同一微妙中生成ID
                    sequence = (sequence + 1) & sequenceMask; //用&运算计算该微秒内产生的计数是否已经到达上限
                    if (sequence == 0)
                    {
                        //一微妙内产生的ID计数已达上限，等待下一微妙
                        timestamp = tillNextMillis(lastTimestamp);
                    }
                }
                else
                { //不同微秒生成ID
                    sequence = 0; //计数清0
                }
                if (timestamp < lastTimestamp)
                { 
                    //如果当前时间戳比上一次生成ID时时间戳还小，抛出异常，因为不能保证现在生成的ID之前没有生成过
                    throw new Exception(string.Format("Clock moved backwards.  Refusing to generate id for {0} milliseconds", lastTimestamp - timestamp));
                }
                lastTimestamp = timestamp; //把当前时间戳保存为最后生成ID的时间戳
                return (timestamp - _twepoch << timestampLeftShift) | _workerId << workerIdShift | sequence;
            }
        }

        /// <summary>
        /// 获取下一微秒时间戳
        /// </summary>
        /// <param name="lastTimestamp"></param>
        /// <returns></returns>
        private static long tillNextMillis(long lastTimestamp)
        {
            long timestamp = timeGen();
            while (timestamp <= lastTimestamp)
            {
                timestamp = timeGen();
            }
            return timestamp;
        }

        /// <summary>
        /// 当前时间戳
        /// </summary>
        /// <returns></returns>
        private static long timeGen()
        {
            return (long)(DateTime.UtcNow - new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc)).TotalMilliseconds;
        }

        /// <summary>
        /// 指定时间戳
        /// </summary>
        /// <param name="Time">指定时间</param>
        /// <returns></returns>
        private static long timeGen(int Year, int Month, int Day, int Hour, int Minute, int Second)
        {
            var UtcTime = new DateTime(Year, Month, Day, Hour, Minute, Second, DateTimeKind.Utc);
            return (long)(UtcTime - new DateTime(1970, 1, 1, 0, 0, 0, DateTimeKind.Utc)).TotalMilliseconds;
        }
    }

说下使用，理论上如果是单机部署，不用做任何配置工作

直接 SFID.NewID() 就可以使用。

如果分布式的话

.Net Framework项目在Application_Start中，.Net Core项目在Configure中添加 SFID.WorkerID = 1L; 就可以 1L换成你的不同机器代号就可以，建议从配置文件读取可以保证代码一致性。另外不要部署ID相同的服务器，很可能会出现ID冲突。

因为就用了4位，所以最大只支持16台机器，如果不够用，可以去改workerIdBits的值，但是注意，这样会压缩ID的使用寿命，如果改为10位的话，大概可以用69年。

起始时间，我的为了保持一致使用了2010年1月1日0时。ID的使用寿命则是以这个时间点进行计算的。如果觉得不够用修代码中构造方法里的时间。但是注意多台保持一致。否则不能保证ID顺序递增。

然后大概说说修改思路。

1、关于实例化ID算法对象这个事，我觉得与其每次都初始化，然后费了半天劲保持对象生存，不如直接使用单例模式。所以方法不需要再单独实例化。

但是这么做也是有缺点的，如果我想业务A和业务B分别使用不同ID的序列，那么多实例模式则更适合，两个不同的业务，占位可以不一样，并且允许出现相同ID，更节省ID，效率也相对较高。

2、关于效率不高的问题，其实是原来的代码中计数器位过短造成的，并发达到数量达到可分配ID的峰值后，线程就会锁死不再发放ID，直到下一毫秒。

知道问题就很好解决了，调整大计数器长度，压缩服务器编号占位（我觉得实际生产中，很少有机会会用到1K台机器并发）。

以上，有问题或者有错误欢迎指出，可以直接给我发消息或者邮件我