Spring Boot教你一种方法生成全局唯一ID

技术文章第一时间送达！

一、概述

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

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

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

二、基础工程创建

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

• uid-generator
  • github.com/baidu/uid-generator
• uid-consumer：消费者
  • 使用uid-generator产生全局唯一的流水号

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

然后在 application.properties配置文件中添加一些配置（主要是 MySQL和 MyBatis配置）

完成之后工程缩影如下图所示：

下面我们来一步步集成 UidGenerator的源码。

三、数据库建表

首先去 MySQL数据库中建一个名为 WORKER_NODE的数据表，其 sql如下：

四、Spring详细配置

4.1、CachedUidGenerator 配置

UidGenerator 有两个具体的实现类，分别是 DefaultUidGenerator 和 CachedUidGenerator，不过官方也推荐了对于性能比较敏感的项目应使用后者，因此本文也使用 CachedUidGenerator，而对于 DefaultUidGenerator不做过多阐述。

我们引入UidGenerator源码中的cached-uid-spring.xml文件，里面都是默认配置，我目前没有做任何修改：

4.2、Mybatis Mapper XML 配置

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

五、编写业务代码

5.1、config 类创建与配置

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

5.2、service 类创建与配置

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

5.3、controller 创建与配置

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

六、实验测试

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

接下来我们浏览器访问:

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

作者：王帅

来源：www.codesheep.cn