詳解Spring Boot工程集成全局唯一ID生成器 UidGenerator的操作步驟
Spring Boot中全局唯一流水號ID生成器集成實驗
概述
流水號生成器（全局唯一 ID生成器）是服務化系統的基礎設施，其在保障系統的正確運行和高可用方面發(fā)揮著重要作用。而關于流水號生成算法首屈一指的當屬 Snowflake 雪花算法，然而 Snowflake本身很難在現實項目中直接使用，因此實際應用時需要一種可落地的方案。
UidGenerator 由百度開發(fā)，是Java實現的, 基于 Snowflake算法的唯一ID生成器。UidGenerator以組件形式工作在應用項目中, 支持自定義workerId位數和初始化策略, 從而適用于 docker等虛擬化環(huán)境下實例自動重啟、漂移等場景。
本文就在項目中來集成 UidGenerator這一工程來作為項目的全局唯一 ID生成器。
本文內容腦圖如下：
基礎工程創(chuàng)建
只需創(chuàng)建一個 Multi-Moudule的 Maven項目即可，然后我們集成進兩個 Module：
- uid-generator ： 源碼在此
- uid-consumer ：消費者（ 使用uid-generator產生全局唯一的流水號 ）
uid-generator 模塊我就不多說了，源碼拿過來即可，無需任何改動；而關于 uid-consumer 模塊，先在 pom.xml中添加相關依賴如下：
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.3.2</version>
</dependency>
<!--for Mysql-->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<scope>runtime</scope>
<version>8.0.12</version>
</dependency>
<!-- druid -->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>druid-spring-boot-starter</artifactId>
<version>1.1.9</version>
</dependency>
<!--必須放在最后-->
<dependency>
<groupId>cn.codesheep</groupId>
<artifactId>uid-generator</artifactId>
<version>1.0</version>
</dependency>
</dependencies>
然后在 application.properties配置文件中添加一些配置（主要是 MySQL和 MyBatis配置）
server.port=9999 spring.datasource.url=jdbc:mysql://xxx.xxx.xxx.xxx:3306/xxx?useUnicode=true&characterEncoding=utf-8&useSSL=false spring.datasource.username=root spring.datasource.password=xxx spring.datasource.driver-class-name=com.mysql.jdbc.Driver mybatis.mapper-locations=classpath:mapper/*.xml mybatis.configuration.map-underscore-to-camel-case=true
完成之后工程縮影如下圖所示：
下面我們來一步步集成 UidGenerator 的源碼。
數據庫建表
首先去 MySQL數據庫中建一個名為 WORKER_NODE 的數據表，其 sql如下：
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詳細配置
CachedUidGenerator 配置
UidGenerator 有兩個具體的實現類，分別是 DefaultUidGenerator 和 CachedUidGenerator ，不過官方也推薦了對于性能比較敏感的項目應使用后者，因此本文也使用 CachedUidGenerator ，而對于 DefaultUidGenerator 不做過多闡述。
我們引入 UidGenerator源碼中的 cached-uid-spring.xml 文件，里面都是默認配置，我目前沒有做任何修改
<?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. --> <!-- 當環(huán)上可用UID數量 < 512時, 將自動對RingBuffer進行填充補全 --> <!--<property name="paddingFactor" value="50"></property>--> <!-- 另外一種RingBuffer填充時機, 在Schedule線程中, 周期性檢查填充 --> <!-- 默認:不配置此項, 即不實用Schedule線程. 如需使用, 請指定Schedule線程時間間隔, 單位:秒 --> <!--<property name="scheduleInterval" value="60"></property>--> <!-- 拒絕策略: 當環(huán)已滿, 無法繼續(xù)填充時 --> <!-- 默認無需指定, 將丟棄Put操作, 僅日志記錄. 如有特殊需求, 請實現RejectedPutBufferHandler接口(支持Lambda表達式) --> <!--<property name="rejectedPutBufferHandler" ref="XxxxYourPutRejectPolicy"></property>--> <!-- 拒絕策略: 當環(huán)已空, 無法繼續(xù)獲取時 --> <!-- 默認無需指定, 將記錄日志, 并拋出UidGenerateException異常. 如有特殊需求, 請實現RejectedTakeBufferHandler接口(支持Lambda表達式) --> <!--<property name="rejectedPutBufferHandler" ref="XxxxYourPutRejectPolicy"></property>--> </bean> </beans>
Mybatis Mapper XML 配置
即原樣引入 UidGenerator源碼中關于工作節(jié)點（Worker Node）操作的 mapper xml 文件： WORKER_NODE.xml ，其內容如下：
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.baidu.fsg.uid.worker.dao.WorkerNodeDAO">
<resultMap id="workerNodeRes"
type="com.baidu.fsg.uid.worker.entity.WorkerNodeEntity">
<id column="ID" jdbcType="BIGINT" property="id" />
<result column="HOST_NAME" jdbcType="VARCHAR" property="hostName" />
<result column="PORT" jdbcType="VARCHAR" property="port" />
<result column="TYPE" jdbcType="INTEGER" property="type" />
<result column="LAUNCH_DATE" jdbcType="DATE" property="launchDate" />
<result column="MODIFIED" jdbcType="TIMESTAMP" property="modified" />
<result column="CREATED" jdbcType="TIMESTAMP" property="created" />
</resultMap>
<insert id="addWorkerNode" useGeneratedKeys="true" keyProperty="id"
parameterType="com.baidu.fsg.uid.worker.entity.WorkerNodeEntity">
INSERT INTO WORKER_NODE
(HOST_NAME,
PORT,
TYPE,
LAUNCH_DATE,
MODIFIED,
CREATED)
VALUES (
#{hostName},
#{port},
#{type},
#{launchDate},
NOW(),
NOW())
</insert>
<select id="getWorkerNodeByHostPort" resultMap="workerNodeRes">
SELECT
ID,
HOST_NAME,
PORT,
TYPE,
LAUNCH_DATE,
MODIFIED,
CREATED
FROM
WORKER_NODE
WHERE
HOST_NAME = #{host} AND PORT = #{port}
</select>
</mapper>
編寫業(yè)務代碼
config 類創(chuàng)建與配置
新建 UidConfig 類，為我們引入上文的 cached-uid-spring.xml 配置
@Configuration
@ImportResource(locations = { "classpath:uid/cached-uid-spring.xml" })
public class UidConfig {
}
service 類創(chuàng)建與配置
新建 UidGenService ，引入 UidGenerator 生成 UID的業(yè)務接口
@Service
public class UidGenService {
@Resource
private UidGenerator uidGenerator;
public long getUid() {
return uidGenerator.getUID();
}
}
controller 創(chuàng)建與配置
新建 UidTestController ，目的是方便我們用瀏覽器測試接口并觀察效果：
@RestController
public class UidTestController {
@Autowired
private UidGenService uidGenService;
@GetMapping("/testuid")
public String test() {
return String.valueOf( uidGenService.getUid() );
}
}
實驗測試
我們每啟動一次 Spring Boot工程，其即會自動去 MySQL數據的 WORKER_NODE 表中插入一行關于工作節(jié)點的記錄，類似下圖所示：
接下來我們?yōu)g覽器訪問： http://localhost:9999/testuid
OK，全局唯一流水號ID已經成功生成并返回！
總結
以上所述是小編給大家介紹的Spring Boot工程集成全局唯一ID生成器 UidGenerator，希望對大家有所幫助，如果大家有任何疑問請給我留言，小編會及時回復大家的。在此也非常感謝大家對腳本之家網站的支持！
相關文章
Intellij IDEA 2017.3使用Lombok及常用注解介紹
這篇文章主要介紹了Intellij IDEA 2017.3使用Lombok及常用注解介紹，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2019-09-09
idea自帶Jacoco/idea自動測試語句覆蓋率方法(使用詳解)
這篇文章主要介紹了idea自帶Jacoco/idea自動測試語句覆蓋率方法，本文給大家分享使用方法，通過圖文實例相結合給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-04-04
這篇文章主要為大家詳細介紹了Java中線程的創(chuàng)建方式的相關知識，文中的示例代碼講解詳細，具有一定的借鑒價值，感興趣的小伙伴可以了解一下2023-03-03
SpringBoot + 微信公眾號JSAPI支付功能的實現
這篇文章主要介紹了SpringBoot + 微信公眾號JSAPI支付功能的實現,本文通過實例代碼給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-03-03
spring的bean的生命周期主要是創(chuàng)建bean的過程，一個bean的生命周期主要是4個步驟，實例化，屬性注入，初始化，銷毀，本文詳細介紹了bean的生命周期，感興趣的小伙伴可以參考閱讀2023-04-04
這篇文章主要介紹了Spring中@DependsOn注解的作用及實現原理解析,本文給大家介紹的非常詳細，對大家的學習或工作具有一定的參考借鑒價值，需要的朋友可以參考下2021-03-03
這篇文章主要介紹了springboot整合druid連接池的步驟，幫助大家更好的理解和學習springboot框架，感興趣的朋友可以了解下2020-11-11
java多線程編程之使用thread類創(chuàng)建線程
在Java中創(chuàng)建線程有兩種方法：使用Thread類和使用Runnable接口。在使用Runnable接口時需要建立一個Thread實例2014-01-01
給大家分享一下利用Java核心庫實現簡單的AOP的經驗分享和教學，需要的讀者們參考下吧。2017-12-12
這篇文章主要介紹了Spring Boot 單元測試和集成測試實現詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2019-09-09