mybatis-plus 全局唯一ID发号器（SnowFlakeID）源码解析

mybatis-plus 全局唯一ID发号器（SnowFlakeID）源码解析

一、前言

分布式场景下保证ID全局唯一是基本需求，UUID常用来作为唯一ID的生成策略，但不适合作为数据库主键（不具备有序性）；雪花ID（SnowFlake）是twitter公司内部分布式项目采用的ID生成算法，开源后广受国内大厂的好评。而mybatis-plus（以下简称MP）默认ID生成器就使用了雪花算法com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator。

二、雪花算法

1.SnowflakeId结构

0 - 0000000000 0000000000 0000000000 0000000000 0 - 0000000000 - 000000000000
// 备用位(1) - 时间位(41) - datacenterId(5)+workId(5) - 序列位(12)

2.雪花算法不足及优化办法

• 时钟回拨

MP 雪花算法：若时钟回拨偏移量小于等于5毫秒，则等待5x2=10毫秒；否则直接报错。
建议生产环境使用ntp同步时间并启用微调限制。
若是时间相差较大必须通过ntpdate强制同步时间该怎么办？（使用MP 雪花算法）
此种情况下，可通过重写启动应用，JVM PID会发生变动，机器位也就改变了。

• workerId不易维护

MP 雪花算法：datacenterId由机器MAC地址决定；workId由JVM PID决定（String name = ManagementFactory.getRuntimeMXBean().getName();）。当然，你也可以通过application.yml配置文件设置datacenterId及workId或自定义ID生成器。

三、mybatis-plus

1.调用链

com.baomidou.mybatisplus.autoconfigure.MybatisPlusAutoConfiguration#sqlSessionFactory SqlSessionFactory工厂bean注入
=> com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean#afterPropertiesSet
=> com.baomidou.mybatisplus.extension.spring.MybatisSqlSessionFactoryBean#buildSqlSessionFactory
=> com.baomidou.mybatisplus.core.MybatisSqlSessionFactoryBuilder#build(org.apache.ibatis.session.Configuration)
=> com.baomidou.mybatisplus.core.incrementer.DefaultIdentifierGenerator#DefaultIdentifierGenerator() 默认ID生产器
=> com.baomidou.mybatisplus.core.toolkit.Sequence#Sequence() 雪花算法

2.核心代码

/*
 * Copyright (c) 2011-2020, baomidou (jobob@qq.com).
 * <p>
 * Licensed under the Apache License, Version 2.0 (the "License"); you may not
 * use this file except in compliance with the License. You may obtain a copy of
 * the License at
 * <p>
 * https://www.apache.org/licenses/LICENSE-2.0
 * <p>
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
 * WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
 * License for the specific language governing permissions and limitations under
 * the License.
 */
package com.baomidou.mybatisplus.core.toolkit;

import org.apache.ibatis.logging.Log;
import org.apache.ibatis.logging.LogFactory;

import java.lang.management.ManagementFactory;
import java.net.InetAddress;
import java.net.NetworkInterface;
import java.util.concurrent.ThreadLocalRandom;

/**
 * 分布式高效有序 ID 生产黑科技(sequence)
 *
 * <p>优化开源项目：https://gitee.com/yu120/sequence</p>
 *
 * @author hubin
 * @since 2016-08-18
 */
public class Sequence {

    private static final Log logger = LogFactory.getLog(Sequence.class);
    /**
     * 时间起始标记点，作为基准，一般取系统的最近时间（一旦确定不能变动）
     */
    private final long twepoch = 1288834974657L;
    /**
     * 机器标识位数
     */
    private final long workerIdBits = 5L;
    private final long datacenterIdBits = 5L;
    private final long maxWorkerId = -1L ^ (-1L << workerIdBits);
    private final long maxDatacenterId = -1L ^ (-1L << datacenterIdBits);
    /**
     * 毫秒内自增位
     */
    private final long sequenceBits = 12L;
    private final long workerIdShift = sequenceBits;
    private final long datacenterIdShift = sequenceBits + workerIdBits;
    /**
     * 时间戳左移动位
     */
    private final long timestampLeftShift = sequenceBits + workerIdBits + datacenterIdBits;
    private final long sequenceMask = -1L ^ (-1L << sequenceBits);

    private final long workerId;

    /**
     * 数据标识 ID 部分
     */
    private final long datacenterId;
    /**
     * 并发控制
     */
    private long sequence = 0L;
    /**
     * 上次生产 ID 时间戳
     */
    private long lastTimestamp = -1L;

    public Sequence() {
        this.datacenterId = getDatacenterId(maxDatacenterId);
        this.workerId = getMaxWorkerId(datacenterId, maxWorkerId);
    }

    /**
     * 有参构造器
     *
     * @param workerId     工作机器 ID
     * @param datacenterId 序列号
     */
    public Sequence(long workerId, long datacenterId) {
        Assert.isFalse(workerId > maxWorkerId || workerId < 0,
                String.format("worker Id can't be greater than %d or less than 0", maxWorkerId));
        Assert.isFalse(datacenterId > maxDatacenterId || datacenterId < 0,
                String.format("datacenter Id can't be greater than %d or less than 0", maxDatacenterId));
        this.workerId = workerId;
        this.datacenterId = datacenterId;
    }

    /**
     * 获取 maxWorkerId
     */
    protected static long getMaxWorkerId(long datacenterId, long maxWorkerId) {
        StringBuilder mpid = new StringBuilder();
        mpid.append(datacenterId);
        String name = ManagementFactory.getRuntimeMXBean().getName();
        if (StringUtils.isNotBlank(name)) {
            /*
             * GET jvmPid
             */
            mpid.append(name.split(StringPool.AT)[0]);
        }
        /*
         * MAC + PID 的 hashcode 获取16个低位
         */
        return (mpid.toString().hashCode() & 0xffff) % (maxWorkerId + 1);
    }

    /**
     * 数据标识id部分
     */
    protected static long getDatacenterId(long maxDatacenterId) {
        long id = 0L;
        try {
            InetAddress ip = InetAddress.getLocalHost();
            NetworkInterface network = NetworkInterface.getByInetAddress(ip);
            if (network == null) {
                id = 1L;
            } else {
                byte[] mac = network.getHardwareAddress();
                if (null != mac) {
                    id = ((0x000000FF & (long) mac[mac.length - 2]) | (0x0000FF00 & (((long) mac[mac.length - 1]) << 8))) >> 6;
                    id = id % (maxDatacenterId + 1);
                }
            }
        } catch (Exception e) {
            logger.warn(" getDatacenterId: " + e.getMessage());
        }
        return id;
    }

    /**
     * 获取下一个 ID
     *
     * @return 下一个 ID
     */
    public synchronized long nextId() {
        long timestamp = timeGen();
        //闰秒
        if (timestamp < lastTimestamp) {
            long offset = lastTimestamp - timestamp;
            if (offset <= 5) {
                try {
                    wait(offset << 1);
                    timestamp = timeGen();
                    if (timestamp < lastTimestamp) {
                        throw new RuntimeException(String.format("Clock moved backwards.  Refusing to generate id for %d milliseconds", offset));
                    }
                } catch (Exception e) {
                    throw new RuntimeException(e);
                }
            } else {
                throw new RuntimeException(String.format("Clock moved backwards.  Refusing to generate id for %d milliseconds", offset));
            }
        }

        if (lastTimestamp == timestamp) {
            // 相同毫秒内，序列号自增
            sequence = (sequence + 1) & sequenceMask;
            if (sequence == 0) {
                // 同一毫秒的序列数已经达到最大
                timestamp = tilNextMillis(lastTimestamp);
            }
        } else {
            // 不同毫秒内，序列号置为 1 - 3 随机数
            sequence = ThreadLocalRandom.current().nextLong(1, 3);
        }

        lastTimestamp = timestamp;

        // 时间戳部分 | 数据中心部分 | 机器标识部分 | 序列号部分
        return ((timestamp - twepoch) << timestampLeftShift)
                | (datacenterId << datacenterIdShift)
                | (workerId << workerIdShift)
                | sequence;
    }

    protected long tilNextMillis(long lastTimestamp) {
        long timestamp = timeGen();
        while (timestamp <= lastTimestamp) {
            timestamp = timeGen();
        }
        return timestamp;
    }

    protected long timeGen() {
        return SystemClock.now();
    }

}

技术点总结：

• 位运算（全局唯一ID可逆，可反向提取时间戳、数据中心ID、机器ID、序列号）

• workerId 机器ID (JVM PID)

通过String name = ManagementFactory.getRuntimeMXBean().getName();获取当前进程ID,返回值示例19480@LAPTOP-O5TBUP89，其中19480即为进程ID，截取即可！

• SystemClock 自定义时钟

com.baomidou.mybatisplus.core.toolkit.SystemClock
高并发场景下System.currentTimeMillis()存在性能问题，后台启动一个守护线程定时（每毫秒）更新时钟。

• 不同毫秒内，序列号置为 1 - 2 随机数

sequence = ThreadLocalRandom.current().nextLong(1, 3);
这段代码做什么的？不是应该直接将sequence重置为0吗？
增加以上代码，是为了避免在并发不是太高的情况下（每毫秒并发数小于等于1），增加奇、偶的随机性，打散数据，方便取余（分库、分表常用操作）。
参考：Sequence

向大佬致敬 👍👍👍

Java使用雪花id