Loading [MathJax]/jax/output/CommonHTML/config.js
前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
圈层
工具
发布
首页
学习
活动
专区
圈层
工具
MCP广场
社区首页 >专栏 >聊聊mybatis-plus的DefaultIdentifierGenerator

聊聊mybatis-plus的DefaultIdentifierGenerator

作者头像
code4it
发布于 2024-05-13 09:20:29
发布于 2024-05-13 09:20:29
36200
代码可运行
举报
文章被收录于专栏:码匠的流水账码匠的流水账
运行总次数:0
代码可运行

本文主要研究一下mybatis-plus的DefaultIdentifierGenerator

MybatisSqlSessionFactoryBuilder

com/baomidou/mybatisplus/core/MybatisSqlSessionFactoryBuilder.java

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
    @Override
    public SqlSessionFactory build(Configuration configuration) {
        GlobalConfig globalConfig = GlobalConfigUtils.getGlobalConfig(configuration);

        final IdentifierGenerator identifierGenerator;
        if (null == globalConfig.getIdentifierGenerator()) {
            identifierGenerator = new DefaultIdentifierGenerator();
            globalConfig.setIdentifierGenerator(identifierGenerator);
        } else {
            identifierGenerator = globalConfig.getIdentifierGenerator();
        }
        IdWorker.setIdentifierGenerator(identifierGenerator);

        if (globalConfig.isEnableSqlRunner()) {
            new SqlRunnerInjector().inject(configuration);
        }

        SqlSessionFactory sqlSessionFactory = super.build(configuration);

        // 缓存 sqlSessionFactory
        globalConfig.setSqlSessionFactory(sqlSessionFactory);

        return sqlSessionFactory;
    }

MybatisSqlSessionFactoryBuilder的build方法,在globalConfig.getIdentifierGenerator()为null的时候创建并使用DefaultIdentifierGenerator

IdentifierGenerator

com/baomidou/mybatisplus/core/incrementer/IdentifierGenerator.java

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
public interface IdentifierGenerator {

    /**
     * 判断是否分配 ID
     *
     * @param idValue 主键值
     * @return true 分配 false 无需分配
     */
    default boolean assignId(Object idValue) {
        return StringUtils.checkValNull(idValue);
    }

    /**
     * 生成Id
     *
     * @param entity 实体
     * @return id
     */
    Number nextId(Object entity);

    /**
     * 生成uuid
     *
     * @param entity 实体
     * @return uuid
     */
    default String nextUUID(Object entity) {
        return IdWorker.get32UUID();
    }
}

IdentifierGenerator接口定义了nextId方法,同时提供了assignId、nextUUID默认方法

DefaultIdentifierGenerator

com/baomidou/mybatisplus/core/incrementer/DefaultIdentifierGenerator.java

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
public class DefaultIdentifierGenerator implements IdentifierGenerator {
    private final Sequence sequence;

    public DefaultIdentifierGenerator() {
        this.sequence = new Sequence(null);
    }

    public DefaultIdentifierGenerator(InetAddress inetAddress) {
        this.sequence = new Sequence(inetAddress);
    }

    public DefaultIdentifierGenerator(long workerId, long dataCenterId) {
        this.sequence = new Sequence(workerId, dataCenterId);
    }

    public DefaultIdentifierGenerator(Sequence sequence) {
        this.sequence = sequence;
    }

    @Override
    public Long nextId(Object entity) {
        return sequence.nextId();
    }
}

DefaultIdentifierGenerator实现了IdentifierGenerator接口,其nextId方法委托给了Sequence

Sequence

com/baomidou/mybatisplus/core/toolkit/Sequence.java

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
public class Sequence {

    private static final Log logger = LogFactory.getLog(Sequence.class);
    /**
     * 时间起始标记点,作为基准,一般取系统的最近时间(一旦确定不能变动)
     */
    private static 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;
    /**
     * IP 地址
     */
    private InetAddress inetAddress;

    public Sequence(InetAddress inetAddress) {
        this.inetAddress = inetAddress;
        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;
    }

    //......

}    

Sequence的twepoch为1288834974657(2010-11-04 09:42:54 657),默认工作机器ID为5bit和数据中心ID均为5bit(与雪花算法一致),默认maxWorkerId与maxDatacenterId均为2^5-1;毫秒内序列号为12bit;时间戳为41bit

getDatacenterId

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
    protected long getDatacenterId(long maxDatacenterId) {
        long id = 0L;
        try {
            if (null == this.inetAddress) {
                this.inetAddress = InetAddress.getLocalHost();
            }
            NetworkInterface network = NetworkInterface.getByInetAddress(this.inetAddress);
            if (null == network) {
                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;
    }

getDatacenterId会通过NetworkInterface.getByInetAddress获取NetworkInterface,若为null则返回1,否则获取NetworkInterface的getHardwareAddress,之后根据mac地址(00:16:3e:0e:36:ac)的倒数第2部分的低8位,将倒数第1部分左移8位再取低16位,再将这两部分取或,最后右移6位,再将结果对(maxDatacenterId + 1)(即32)取余作为datacenterId

getMaxWorkerId

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
    protected 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);
    }

getMaxWorkerId实际是在没有指定workerId的时候自动计算一个workerId,它是基于datacenterId及pid的哈希值取低16位,最后对(maxWorkerId + 1)(即32)取余

nextId

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
    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 - 2 随机数
            sequence = ThreadLocalRandom.current().nextLong(1, 3);
        }

        lastTimestamp = timestamp;

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

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

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

nextId就是雪花算法生成id的部分,它先通过SystemClock.now()获取当前时间戳,判断是同毫秒的则递增sequence,不同毫秒则随机设置为1或者2;最开始会对时间回拨进行判断,若差异大于5则直接抛出异常,在小于等于5的时候会等待offset的两倍,若时间还是小于lastTimestamp则抛出异常;sequence设置完之后更新lastTimestamp,然后按照时间戳部分 | 数据中心部分 | 机器标识部分 | 序列号部分构造id

SystemClock

com/baomidou/mybatisplus/core/toolkit/SystemClock.java

代码语言:javascript
代码运行次数:0
运行
AI代码解释
复制
public class SystemClock {

    private final long period;
    private final AtomicLong now;

    private SystemClock(long period) {
        this.period = period;
        this.now = new AtomicLong(System.currentTimeMillis());
        scheduleClockUpdating();
    }

    private static SystemClock instance() {
        return InstanceHolder.INSTANCE;
    }

    public static long now() {
        return instance().currentTimeMillis();
    }

    public static String nowDate() {
        return new Timestamp(instance().currentTimeMillis()).toString();
    }

    private void scheduleClockUpdating() {
        ScheduledExecutorService scheduler = Executors.newSingleThreadScheduledExecutor(runnable -> {
            Thread thread = new Thread(runnable, "System Clock");
            thread.setDaemon(true);
            return thread;
        });
        scheduler.scheduleAtFixedRate(() -> now.set(System.currentTimeMillis()), period, period, TimeUnit.MILLISECONDS);
    }

    private long currentTimeMillis() {
        return now.get();
    }

    private static class InstanceHolder {
        public static final SystemClock INSTANCE = new SystemClock(1);
    }
}

SystemClock是针对高并发场景下System. currentTimeMillis()的性能问题的优化,其构造器在创建的时候将System.currentTimeMillis()赋值给AtomicLong,其now方法返回的是instance().currentTimeMillis(),即now.get(),它有个定时任务,每隔1毫秒更新一下now为当前System.currentTimeMillis()

小结

mybatis-plus的MybatisSqlSessionFactoryBuilder的build方法,在globalConfig.getIdentifierGenerator()为null的时候创建并使用DefaultIdentifierGenerator,它内部使用的是Sequence来生成id的,Sequence使用的是雪花算法,默认的datacenterId(5bit)是基于mac地址计算而来(取倒数第2部分的低8位,将倒数第1部分左移8位再取低16位,再将这两部分取或,最后右移6位,再将结果对(maxDatacenterId + 1)(即32)取余作为datacenterId),默认的workerId(5bit)是基于datacenterId及pid的哈希值取低16位,最后对(maxWorkerId + 1)(即32)取余;nextId就是雪花算法生成id的部分,它先通过SystemClock.now()获取当前时间戳,判断是同毫秒的则递增sequence,不同毫秒则随机设置为1或者2。

doc

  • snowflake
本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2024-05-11,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 码匠的流水账 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
暂无评论
推荐阅读
编辑精选文章
换一批
聊聊mybatis-plus的DefaultIdentifierGenerator
本文主要研究一下mybatis-plus的DefaultIdentifierGenerator
code4it
2024/05/11
2300
Java工具集-雪花算法实现分布式唯一ID获取
代码示例 package com.simple.util.distributed; import java.lang.management.ManagementFactory; import java.net.InetAddress; import java.net.NetworkInterface; /** * @program: simple_tools * @description: 雪花算法代码实现 * @author: ChenWenLong * @create: 2019-12-29
cwl_java
2020/01/02
2.2K0
分布式ID生成器
由于我们的数据库在生产环境中要分片部署(MyCat),所以我们不能使用数据库本身的自增功能来产生主键值,只能由程序来生成唯一的主键值。我们采用的是开源的 twitter 的 snowflake (雪花)算法。
名字是乱打的
2022/05/13
3040
分布式ID生成器
分布式唯一ID生成器Twitter 的 Snowflake idworker java版本
import java.lang.management.ManagementFactory; import java.net.InetAddress; import java.net.NetworkInterface; /** * <p>名称:IdWorker.java</p> * <p>描述:分布式自增长ID</p> * <pre> * Twitter的 Snowflake JAVA实现方案 * </pre> * 核心代码为其IdWorker这个类实现,其原理结构如下,我分别用一个0
MonroeCode
2018/01/09
2.9K0
MybatisPlus 分布式Id
对于分布式id,有很多方案,现在大多数用的是基于雪花算法Snowflake的实现,美团有Leaf,百度有Uidgenerator,我这里记录下苞米豆在MybatisPlus3中的分布式id实现
全栈程序员站长
2022/11/16
8690
MybatisPlus 分布式Id
分布式id生成算法SnowFlake
10位记录工作机器id;即datacenterId (5位数据id) + workerId (5位机器id)
chenchenchen
2019/09/03
9620
分布式id生成算法SnowFlake
【工具类】雪花算法生成id
雪花算法生成id package com.xiepanpan.utils; import java.lang.management.ManagementFactory; import java.net.InetAddress; import java.net.NetworkInterface; /** * <p>名称:IdWorker.java</p> * <p>描述:分布式自增长ID</p> * <pre> * Twitter的 Snowflake JAVA实现方案 * </pre>
周杰伦本人
2022/10/25
1.3K0
分布式 ID 生成器如何选择?
UUID(Universally Unique Identifier)的标准型式包含32个16进制数字,以“-”连接符分为五段,形式为8-4-4-4-12的36个字符。
IT技术小咖
2019/08/22
1.8K0
分布式 ID 生成器如何选择?
SaaS-工程搭建
SpringBoot+SpringCloud+SpringMVC+SpringData
cwl_java
2020/01/02
7190
技术汇总:第六章:分布式自增长ID
import java.lang.management.ManagementFactory; import java.net.InetAddress; import java.net.NetworkInterface;
马克社区
2023/01/29
6150
七种分布式全局 ID 生成策略,你更爱哪种?
松哥最近工作中刚好用到这块内容,于是调研了市面上几种常见的全局 ID 生成策略,稍微做了一下对比,供小伙伴们参考。
江南一点雨
2021/08/06
9810
七种分布式全局 ID 生成策略,你更爱哪种?
Mybatis-Plus
MyBatis-Plus(简称 MP)是一个 MyBatis 的增强工具,在 MyBatis 的基础上只做增强不做改变,为简化开发、提高效率而生。
OY
2022/03/17
1.1K0
Mybatis-Plus
雪花算法对System.currentTimeMillis()优化真的有用么?
前面已经讲过了雪花算法,里面使用了System.currentTimeMillis()获取时间,有一种说法是认为System.currentTimeMillis()慢,是因为每次调用都会去跟系统打一次交道,在高并发情况下,大量并发的系统调用容易会影响性能(对它的调用甚至比new一个普通对象都要耗时,毕竟new产生的对象只是在Java内存中的堆中)。我们可以看到它调用的是native 方法:
秦怀杂货店
2021/11/30
4680
雪花算法对System.currentTimeMillis()优化真的有用么?
前面已经讲过了雪花算法 ,里面使用了System.currentTimeMillis()获取时间,有一种说法是认为System.currentTimeMillis()慢,是因为每次调用都会去跟系统打一次交道,在高并发情况下,大量并发的系统调用容易会影响性能(对它的调用甚至比new一个普通对象都要耗时,毕竟new产生的对象只是在Java内存中的堆中)。我们可以看到它调用的是native 方法:
秦怀杂货店
2022/02/17
7200
基于Twitter的Snowflake算法实现分布式高效有序ID生产黑科技(无懈可击)
参考美团文档:https://tech.meituan.com/2017/04/21/mt-leaf.html
爱撸猫的杰
2019/03/28
1.6K0
基于Twitter的Snowflake算法实现分布式高效有序ID生产黑科技(无懈可击)
探讨面试常见问题雪花算法、时钟回拨问题,java中优雅的实现方式
在大数据量系统中,分布式ID生成是一个关键问题。为了保证在分布式环境下生成的ID唯一、有序且高效,业界提出了多种解决方案,其中雪花算法(Snowflake Algorithm)是一种广泛应用的分布式ID生成算法。本文将详细介绍雪花算法的原理、实现及其处理时钟回拨问题的方法,并提供Java代码示例。
小马哥学JAVA
2024/10/13
6171
Java工具集-分布式全局唯一ID生成
简单工具类 写作初衷:由于日常开发经常需要用到很多工具类,经常根据需求自己写也比较麻烦 网上好了一些工具类例如commom.lang3或者hutool或者Jodd这样的开源工具,但是 发现他们之中虽然设计不错,但是如果我想要使用,就必须要引入依赖并且去维护依赖,有些 甚至会有存在版本编译不通过问题,故此想要写作一个每个类都可以作为独立工具类使用 每个使用者只需要复制该类,到任何项目当中都可以使用,所以需要尊从以下两个原则才能 做到.在此诚邀各位大佬参与.可以把各自用过的工具,整合成只依赖JDK
cwl_java
2019/10/26
1K0
面试题:分库分表之后,id 主键如何处理?
其实这是分库分表之后你必然要面对的一个问题,就是 id 咋生成?因为要是分成多个表之后,每个表都是从 1 开始累加,那肯定不对啊,需要一个全局唯一的 id 来支持。所以这都是你实际生产环境中必须考虑的问题。
用户1263954
2019/07/12
2.8K0
面试题:分库分表之后,id 主键如何处理?
雪花片算法的实现原理
?一般雪花大约有10的19次方水分组成。在雪花形成的过程中,会形成的不同的结构分支,大自然当中不存在两片完全一样的雪花。由此引申而来。
张哥编程
2024/12/07
1710
雪花算法下的ID生成工具类
对于常用的算法生成的根据当前日期等生成的IP,在分布式环境下都有可能出现重复的状况。
CodeWwang
2022/08/24
7980
推荐阅读
相关推荐
聊聊mybatis-plus的DefaultIdentifierGenerator
更多 >
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档
本文部分代码块支持一键运行,欢迎体验
本文部分代码块支持一键运行,欢迎体验