詳解Spring Boot工程集成全局唯一ID生成器 UidGenerator的操作步驟

更新時(shí)間：2018年10月25日 08:44:29 作者：王帥

本文就在項(xiàng)目中來(lái)集成 UidGenerator這一工程來(lái)作為項(xiàng)目的全局唯一 ID生成器。接下來(lái)通過(guò)實(shí)例代碼給大家詳解詳解Spring Boot工程集成全局唯一ID生成器 UidGenerator的操作步驟，感興趣的朋友一起看看吧

Spring Boot中全局唯一流水號(hào)ID生成器集成實(shí)驗(yàn)

概述

流水號(hào)生成器（全局唯一 ID生成器）是服務(wù)化系統(tǒng)的基礎(chǔ)設(shè)施，其在保障系統(tǒng)的正確運(yùn)行和高可用方面發(fā)揮著重要作用。而關(guān)于流水號(hào)生成算法首屈一指的當(dāng)屬 Snowflake 雪花算法，然而 Snowflake本身很難在現(xiàn)實(shí)項(xiàng)目中直接使用，因此實(shí)際應(yīng)用時(shí)需要一種可落地的方案。

UidGenerator 由百度開(kāi)發(fā)，是Java實(shí)現(xiàn)的, 基于 Snowflake算法的唯一ID生成器。UidGenerator以組件形式工作在應(yīng)用項(xiàng)目中, 支持自定義workerId位數(shù)和初始化策略, 從而適用于 docker等虛擬化環(huán)境下實(shí)例自動(dòng)重啟、漂移等場(chǎng)景。

本文就在項(xiàng)目中來(lái)集成 UidGenerator這一工程來(lái)作為項(xiàng)目的全局唯一 ID生成器。

本文內(nèi)容腦圖如下：

基礎(chǔ)工程創(chuàng)建

只需創(chuàng)建一個(gè) Multi-Moudule的 Maven項(xiàng)目即可，然后我們集成進(jìn)兩個(gè) Module：

uid-generator ：源碼在此
uid-consumer ：消費(fèi)者（使用uid-generator產(chǎn)生全局唯一的流水號(hào) ）

uid-generator 模塊我就不多說(shuō)了，源碼拿過(guò)來(lái)即可，無(wú)需任何改動(dòng)；而關(guān)于 uid-consumer 模塊，先在 pom.xml中添加相關(guān)依賴如下：

<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

完成之后工程縮影如下圖所示：

下面我們來(lái)一步步集成 UidGenerator 的源碼。

數(shù)據(jù)庫(kù)建表

首先去 MySQL數(shù)據(jù)庫(kù)中建一個(gè)名為 WORKER_NODE 的數(shù)據(jù)表，其 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詳細(xì)配置

CachedUidGenerator 配置

UidGenerator 有兩個(gè)具體的實(shí)現(xiàn)類，分別是 DefaultUidGenerator 和 CachedUidGenerator ，不過(guò)官方也推薦了對(duì)于性能比較敏感的項(xiàng)目應(yīng)使用后者，因此本文也使用 CachedUidGenerator ，而對(duì)于 DefaultUidGenerator 不做過(guò)多闡述。

我們引入 UidGenerator源碼中的 cached-uid-spring.xml 文件，里面都是默認(rèn)配置，我目前沒(méi)有做任何修改

<?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" />
 <!-- 以下為可選配置, 如未指定將采用默認(rèn)值 -->
 <!-- RingBuffer size擴(kuò)容參數(shù), 可提高UID生成的吞吐量. --> 
 <!-- 默認(rèn):3， 原bufferSize=8192, 擴(kuò)容后bufferSize= 8192 << 3 = 65536 -->
 <!--<property name="boostPower" value="3"></property>--> 
 
 <!-- 指定何時(shí)向RingBuffer中填充UID, 取值為百分比(0, 100), 默認(rèn)為50 -->
 <!-- 舉例: bufferSize=1024, paddingFactor=50 -> threshold=1024 * 50 / 100 = 512. -->
 <!-- 當(dāng)環(huán)上可用UID數(shù)量 < 512時(shí), 將自動(dòng)對(duì)RingBuffer進(jìn)行填充補(bǔ)全 -->
 <!--<property name="paddingFactor" value="50"></property>--> 
 
 <!-- 另外一種RingBuffer填充時(shí)機(jī), 在Schedule線程中, 周期性檢查填充 -->
 <!-- 默認(rèn):不配置此項(xiàng), 即不實(shí)用Schedule線程. 如需使用, 請(qǐng)指定Schedule線程時(shí)間間隔, 單位:秒 -->
 <!--<property name="scheduleInterval" value="60"></property>--> 
 
 <!-- 拒絕策略: 當(dāng)環(huán)已滿, 無(wú)法繼續(xù)填充時(shí) -->
 <!-- 默認(rèn)無(wú)需指定, 將丟棄Put操作, 僅日志記錄. 如有特殊需求, 請(qǐng)實(shí)現(xiàn)RejectedPutBufferHandler接口(支持Lambda表達(dá)式) -->
 <!--<property name="rejectedPutBufferHandler" ref="XxxxYourPutRejectPolicy"></property>--> 
 
 <!-- 拒絕策略: 當(dāng)環(huán)已空, 無(wú)法繼續(xù)獲取時(shí) -->
 <!-- 默認(rèn)無(wú)需指定, 將記錄日志, 并拋出UidGenerateException異常. 如有特殊需求, 請(qǐng)實(shí)現(xiàn)RejectedTakeBufferHandler接口(支持Lambda表達(dá)式) -->
 <!--<property name="rejectedPutBufferHandler" ref="XxxxYourPutRejectPolicy"></property>--> 
 
 </bean>
</beans>

Mybatis Mapper XML 配置

即原樣引入 UidGenerator源碼中關(guān)于工作節(jié)點(diǎn)（Worker Node）操作的 mapper xml 文件： WORKER_NODE.xml ，其內(nèi)容如下：

<?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è)務(wù)代碼

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è)務(wù)接口

@Service
public class UidGenService {

  @Resource
  private UidGenerator uidGenerator;

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

controller 創(chuàng)建與配置

新建 UidTestController ，目的是方便我們用瀏覽器測(cè)試接口并觀察效果：

@RestController
public class UidTestController {

  @Autowired
  private UidGenService uidGenService;

  @GetMapping("/testuid")
  public String test() {
    return String.valueOf( uidGenService.getUid() );
  }
}

實(shí)驗(yàn)測(cè)試

我們每啟動(dòng)一次 Spring Boot工程，其即會(huì)自動(dòng)去 MySQL數(shù)據(jù)的 WORKER_NODE 表中插入一行關(guān)于工作節(jié)點(diǎn)的記錄，類似下圖所示：