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());
    }
}