概述
流水号生成器（全局唯一 ID生成器）是服务化系统的基础设施，其在保障系统的正确运行和高可用方面发挥着重要作用。而关于流水号生成算法首屈一指的当属 Snowflake雪花算法，然而 Snowflake本身很难在现实项目中直接使用，因此实际应用时需要一种可落地的方案。

UidGenerator 由百度开发，是Java实现的, 基于 Snowflake算法的唯一ID生成器。UidGenerator以组件形式工作在应用项目中, 支持自定义workerId位数和初始化策略, 从而适用于 docker等虚拟化环境下实例自动重启、漂移等场景。

本文就在项目中来集成 UidGenerator这一工程来作为项目的全局唯一 ID生成器。

本文内容脑图如下：

Spring Boot工程集成全局唯一ID生成器 UidGenerator

基础工程创建
只需创建一个 Multi-Moudule的 Maven项目即可，然后我们集成进两个 Module：

uid-generator：github.com/baidu/uid-generator

uid-consumer：消费者（使用uid-generator产生全局唯一的流水号）

uid-generator模块我就不多说了，源码拿过来即可，无需任何改动；而关于 uid-consumer模块，先在 pom.xml中添加相关依赖如下：

org.springframework.boot spring-boot-starter-web org.springframework.boot spring-boot-starter-test test org.mybatis.spring.boot mybatis-spring-boot-starter 1.3.2 mysql mysql-connector-java runtime 8.0.12 com.alibaba druid-spring-boot-starter 1.1.9 cn.codesheep uid-generator 1.0

然后在 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

完成之后工程缩影如下图所示：
Spring Boot工程集成全局唯一ID生成器 UidGenerator

下面我们来一步步集成 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"

<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”

Mybatis Mapper XML 配置

即原样引入 UidGenerator源码中关于工作节点（Worker Node）操作的 mapper xml 文件： WORKER_NODE.xml，其内容如下：

<?
xml version

“1.0”
encoding

“UTF-8”
?>

<mapper

namespace

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

<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}

编写业务代码
config 类创建与配置

新建 UidConfig类，为我们引入上文的 cached-uid-spring.xml配置

@Configuration

@ImportResource
(
locations

{

“classpath:uid/cached-uid-spring.xml”

})

public

class

UidConfig

{

}

service 类创建与配置

新建 UidGenService，引入 UidGenerator 生成 UID的业务接口

@Service

public

class

UidGenService

{

@Resource

private

UidGenerator
uidGenerator
;

public

long
getUid
()

{

return
uidGenerator
.
getUID
();

}

controller 创建与配置

新建 UidTestController，目的是方便我们用浏览器测试接口并观察效果：

@RestController

public

class

UidTestController

{

@Autowired

private

UidGenService
uidGenService
;

@GetMapping
(
“/testuid”
)

public

String
test
()

{

return

String
.
valueOf
(
uidGenService
.
getUid
()

);

}

实验测试
我们每启动一次 Spring Boot工程，其即会自动去 MySQL数据的 WORKER_NODE表中插入一行关于工作节点的记录，类似下图所示：

Spring Boot工程集成全局唯一ID生成器 UidGenerator

接下来我们浏览器访问：http://localhost:9999/testuid
Spring Boot工程集成全局唯一ID生成器 UidGenerator

OK，全局唯一流水号ID已经成功生成并返回！

后记
由于能力有限，若有错误或者不当之处，还请大家批评指正，一起学习交流！
加Java架构师进阶交流群获取Java工程化、高性能及分布式、高性能、深入浅出。高架构。性能调优、Spring，MyBatis，Netty源码分析和大数据等多个知识点高级进阶干货的直播免费学习权限都是大牛带飞让你少走很多的弯路的群号是：883922439 对了小白勿进最好是有开发经验
注：加群要求

1、具有工作经验的，面对目前流行的技术不知从何下手，需要突破技术瓶颈的可以加。

2、在公司待久了，过得很安逸，但跳槽时面试碰壁。需要在短时间内进修、跳槽拿高薪的可以加。

3、如果没有工作经验，但基础非常扎实，对java工作机制，常用设计思想，常用java开发框架掌握熟练的，可以加。

4、觉得自己很牛B，一般需求都能搞定。但是所学的知识点没有系统化，很难在技术领域继续突破的可以加。

5.阿里Java高级大牛直播讲解知识点，分享知识，多年工作经验的梳理和总结，带着大家全面、科学地建立自己的技术体系和技术认知！

Spring Boot工程集成全局唯一ID生成器 UidGenerator

server . port

spring . datasource . url

spring . datasource . username

spring . datasource . password

spring . datasource . driver

class

name

mybatis . mapper

locations

COMMENT

‘DB WorkerID Assigner for UID Generator’ , ENGINE

<? xml version

“1.0” encoding

xmlns

xmlns:xsi

xsi:schemaLocation

id

class

id

class

name

ref

<? xml version

“1.0” encoding

namespace

id

type

column

jdbcType

property

column

jdbcType

property

column

jdbcType

property

column

jdbcType

property

column

jdbcType

property

column

jdbcType

property

column

jdbcType

property

id

useGeneratedKeys

keyProperty

parameterType

id

resultMap

@ImportResource ( locations

相关推荐

server
.
port

spring
.
datasource
.
url

spring
.
datasource
.
username

spring
.
datasource
.
password

spring
.
datasource
.
driver

mybatis
.
mapper

‘DB WorkerID Assigner for UID Generator’
,
ENGINE

<?
xml version

“1.0”
encoding

<?
xml version

“1.0”
encoding

@ImportResource
(
locations