Spring Boot項目集成 UidGenerato

前言

UidGenerato 基於snowflake算法實現

UidGenerato 由百度開發，基於SnowFlake算法的惟一ID生成器。UidGenerato 已組件的形式工做在應用項目中，支持自定義workeid位數和初始化策略，從而適用docker等虛擬化環境下實例自動重啓等場景。

準備一個maven項目，構建兩個模塊。分別做爲使用方和提供方。（建兩個模塊主要是爲了「造輪子」，其餘模塊或項目能夠直接引用，無需關心uid配置，若是沒有分模塊，能夠指忽略構建兩個模塊）
下載uid源碼，放在項目中，開源地址 https://github.com/baidu/uid-generator

數據庫建表

DROP TABLE IF EXISTS WORKER_NODE;CREATE TABLE WORKER_NODE
(
ID BIGINT NOT NULL AUTO_INCREMENT COMMENT 'auto increment id',
HOST_NAME VARCHAR(64) NOT NULL COMMENT 'host name',
PORT VARCHAR(64) NOT NULL COMMENT 'port',TYPE INT NOT NULL COMMENT 'node type: ACTUAL or CONTAINER',
LAUNCH_DATE DATE NOT NULL COMMENT 'launch date',
MODIFIED TIMESTAMP NOT NULL COMMENT 'modified time',
CREATED TIMESTAMP NOT NULL COMMENT 'created time',PRIMARY KEY(ID))
COMMENT='DB WorkerID Assigner for UID Generator',ENGINE = INNODB;

Spring 配置

CachedUidGennerator：java

UidGenerator 有兩個具體的實現類，分別是 DefaultUidGenerator 和 CachedUidGenerator，官方推薦使用性能較強的 CachedUidGenerator。node

咱們直接引用 UdiGenerator源碼中的 cached-uid-spring.xml文件，使用默認配置git

<?xml version="1.0" encoding="UTF-8"?><beans xmlns="http://www.springframework.org/schema/beans" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
    xsi:schemaLocation="
        http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.1.xsd">
    <!-- UID generator -->
    <bean id="disposableWorkerIdAssigner" class="com.baidu.fsg.uid.worker.DisposableWorkerIdAssigner" />
    <bean id="cachedUidGenerator" class="com.baidu.fsg.uid.impl.CachedUidGenerator">
        <property name="workerIdAssigner" ref="disposableWorkerIdAssigner" />
        <!-- 如下爲可選配置, 如未指定將採用默認值 -->
        <!-- RingBuffer size擴容參數, 可提升UID生成的吞吐量. -->
        <!-- 默認:3， 原bufferSize=8192, 擴容後bufferSize= 8192 << 3 = 65536 -->
        <!--<property name="boostPower" value="3"></property>-->
        
        <!-- 指定什麼時候向RingBuffer中填充UID, 取值爲百分比(0, 100), 默認爲50 -->
        <!-- 舉例: bufferSize=1024, paddingFactor=50 -> threshold=1024 * 50 / 100 = 512. -->
        <!-- 當環上可用UID數量 < 512時, 將自動對RingBuffer進行填充補全 -->
        <!--<property name="paddingFactor" value="50"></property>-->
        
        <!-- 另一種RingBuffer填充時機, 在Schedule線程中, 週期性檢查填充 -->
        <!-- 默認:不配置此項, 即不實用Schedule線程. 如需使用, 請指定Schedule線程時間間隔, 單位:秒 -->
        <!--<property name="scheduleInterval" value="60"></property>-->
        
        <!-- 拒絕策略: 當環已滿, 沒法繼續填充時 -->
        <!-- 默認無需指定, 將丟棄Put操做, 僅日誌記錄. 若有特殊需求, 請實現RejectedPutBufferHandler接口(支持Lambda表達式) -->
        <!--<property name="rejectedPutBufferHandler" ref="XxxxYourPutRejectPolicy"></property>-->
        
        <!-- 拒絕策略: 當環已空, 沒法繼續獲取時 -->
        <!-- 默認無需指定, 將記錄日誌, 並拋出UidGenerateException異常. 若有特殊需求, 請實現RejectedTakeBufferHandler接口(支持Lambda表達式) -->
        <!--<property name="rejectedPutBufferHandler" ref="XxxxYourPutRejectPolicy"></property>-->
        
    </bean>
</beans>

引入cached-uid-spring.xml配置文件，在咱們本身新建的 UidConfig中 github

package com.xxx.uid.config;


import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportResource;


/**
* @author lishuzhen
* @date 2020/8/11 16:10
*/
@Configuration
@ImportResource(locations = {"classpath:/uid/cached-uid-spring.xml"})
public class UidConfig {
}

在另外一個模塊中maven引入，建立一個UidGenUtils工具類，方便使用

package com.xxxx.utils;


import com.xxx.uid.UidGenerator;
import org.springframework.stereotype.Component;


import javax.annotation.Resource;


/**
* @author lishuzhen
* @date 2020/8/11 16:13
*/
@Component
public class UidGenUtils {
    @Resource
    private UidGenerator uidGenerator;


    public long getUid() {
        return uidGenerator.getUID();
    }


    public String getUidStr() {
        return String.valueOf(uidGenerator.getUID());
    }
}