mybatis-plus雪花算法增強(qiáng)idworker的實現(xiàn)

更新時間：2022年07月08日 10:02:18 作者：斗者_(dá)2013

今天聊聊在mybatis-plus中引入分布式ID生成框架idworker，進(jìn)一步增強(qiáng)實現(xiàn)生成分布式唯一ID,具有一定的參考價值，感興趣的小伙伴們可以參考一下

一、官網(wǎng)

官方文檔：https://baomidou.com/

Git地址：https://github.com/baomidou/mybatis-plus

idworker官網(wǎng)：https://github.com/imadcn/idworker

TIP??：
推薦學(xué)習(xí)框架的時候，多研究下官網(wǎng)，獲取第一手資料。

二、默認(rèn)實現(xiàn)的弊端

在雪花算法的實現(xiàn)中，需要用戶指定datacenterId和workerId的值。

在分布式場景下，如果多臺機(jī)器上的服務(wù)都指定相同的datacenterId和workerId，在高并發(fā)請求下，會出現(xiàn)Id重復(fù)的風(fēng)險。

如下是一個雪花算法ID出現(xiàn)重復(fù)的案例：
https://github.com/imadcn/idworker/issues/14

三、mybatis-plus中datacenterId和workerId的默認(rèn)生成規(guī)則

默認(rèn)情況下，并不需要我們主動去配置datacenterId和workerId的值。mybatis-plus框架會根據(jù)應(yīng)用所在服務(wù)器IP地址來生成datacenterId和workerId。

我們來看看DefaultIdentifierGenerator的構(gòu)造方法：

//默認(rèn)的無參構(gòu)造方法
public DefaultIdentifierGenerator() {
    this.sequence = new Sequence((InetAddress)null);
}

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

#也可以主動指定datacenterId和workerId的值
public DefaultIdentifierGenerator(long workerId, long dataCenterId) {
    this.sequence = new Sequence(workerId, dataCenterId);
}

根據(jù)ip地址初始化Sequence：

public Sequence(InetAddress inetAddress) {
    this.inetAddress = inetAddress;
    this.datacenterId = this.getDatacenterId(31L);
    this.workerId = this.getMaxWorkerId(this.datacenterId, 31L);
}

根據(jù)ip地址生成datacenterId：

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 = (255L & (long)mac[mac.length - 2] | 65280L & (long)mac[mac.length - 1] << 8) >> 6;
                    id %= maxDatacenterId + 1L;
                }
            }
        } catch (Exception var7) {
            logger.warn(" getDatacenterId: " + var7.getMessage());
        }

        return id;
    }

根據(jù)datacenterId生成workerId：

protected long getMaxWorkerId(long datacenterId, long maxWorkerId) {
    StringBuilder mpid = new StringBuilder();
    mpid.append(datacenterId);
    String name = ManagementFactory.getRuntimeMXBean().getName();
    if (StringUtils.isNotBlank(name)) {
        mpid.append(name.split("@")[0]);
    }

    return (long)(mpid.toString().hashCode() & '\uffff') % (maxWorkerId + 1L);
}

小結(jié)：
無論是用戶自己指定datacenterId和workerId，還是根據(jù)IP地址自動生成datacenterId和workerId。顯然在大規(guī)模的集群環(huán)境下都不利于集群的擴(kuò)展和維護(hù)管理，而且容易出現(xiàn)datacenterId和workerId相同而導(dǎo)致出現(xiàn)id重復(fù)的問題。

那么有沒有方法自動管理datacenterId和workerId的生成呢？

四、idworker介紹

idworker 是一個基于zookeeper和snowflake算法的分布式統(tǒng)一ID生成工具，通過zookeeper自動注冊機(jī)器（最多1024臺），無需手動指定workerId和dataCenterId。

在分布式集群中，可能需要部署的大量的機(jī)器節(jié)點。在節(jié)點少的受，可以人工維護(hù)。在量大的場景下，手動維護(hù)成本高，考慮到自動部署、運(yùn)維等等問題，節(jié)點的命名，最好由系統(tǒng)自動維護(hù)。

節(jié)點的命名，主要是為節(jié)點進(jìn)行唯一編號。主要的訴求是，不同節(jié)點的編號，是絕對的不能重復(fù)。一旦編號重復(fù)，就會導(dǎo)致有不同的節(jié)點碰撞，導(dǎo)致集群異常。

有以下兩個方案，可供生成集群節(jié)點編號：
（1）使用數(shù)據(jù)庫的自增ID特性，用數(shù)據(jù)表，存儲機(jī)器的mac地址或者ip來維護(hù)。
（2）使用ZooKeeper持久順序節(jié)點的次序特性，來維護(hù)節(jié)點的編號。

這里，我們采用第二種，通過ZooKeeper持久順序節(jié)點特性，來配置維護(hù)節(jié)點的編號NODEID。
集群節(jié)點命名服務(wù)的基本流程是：
（1）啟動節(jié)點服務(wù)，連接ZooKeeper，檢查命名服務(wù)根節(jié)點根節(jié)點是否存在，如果不存在就創(chuàng)建系統(tǒng)根節(jié)點。
（2）在根節(jié)點下創(chuàng)建一個臨時順序節(jié)點，取回順序號做節(jié)點的NODEID。如何臨時節(jié)點太多，可以根據(jù)需要，刪除臨時節(jié)點。

由于是采用zookeeper順序節(jié)點的特性生成datacenterId和workerId，可以天然的保證datacenterId和workerId的唯一性，減少了人工維護(hù)的弊端。

五、idworker實戰(zhàn)

其中mybatis-plus內(nèi)置的ImadcnIdentifierGenerator方法，就已經(jīng)提供了對idworker框架的支持。

對，你沒看錯，又又又是內(nèi)置的，可是你卻還不會用。不得不佩服mybatis-plus框架的開發(fā)者，太牛了。

查看ImadcnIdentifierGenerator的源碼，可以發(fā)現(xiàn)里面就是通過idworker實現(xiàn)的。

1、引入maven依賴

 <dependency>
        <groupId>com.baomidou</groupId>
        <artifactId>mybatis-plus-boot-starter</artifactId>
        <version>3.5.2</version>
    </dependency>

    <dependency>
        <groupId>com.imadcn.framework</groupId>
        <artifactId>idworker</artifactId>
        <version>1.5.0</version>
    </dependency>

2、添加zookeeper配置

mybatis-plus.zookeeper.serverLists=127.0.0.1:2181

3、指定mybatis-plus的id生成器

@Configuration
public class IdAutoConfig {
    @Value("${mybatis-plus.zookeeper.serverLists}")
    private String zkServerLists;

    @Bean
    public IdentifierGenerator idGenerator() {
        return new ImadcnIdentifierGenerator(zkServerLists);
    }
}

4、測試

執(zhí)行單元測試：

    @Test
    public void testInsert() {
        System.out.println(("----- insert method test ------"));
        User user = new User();
        user.setName("test");
        user.setAge(13);
        user.setEmail("101@qq.com");
        userMapper.insert(user);
        System.out.println(user.toString());
    }

執(zhí)行結(jié)果：

Preparing: INSERT INTO user ( id, name, age, email ) VALUES ( ?, ?, ?, ? )
Parameters: 728706665213329499(Long), test(String), 13(Integer), 101@qq.com(String)
Updates: 1
User(id=728706665213329499, name=test, age=13, email=101@qq.com)

總結(jié)

本文主要介紹如何在mybatis-plus中引入idworker框架，通過zookeeper管理snowflake算法中workerId和dataCenterId`的生成，保證其唯一性，避免出現(xiàn)id重復(fù)的情況。

到此這篇關(guān)于mybatis-plus雪花算法增強(qiáng)idworker的實現(xiàn)的文章就介紹到這了,更多相關(guān)mybatis-plus idworker內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: