封装一个流水号ID生成器:id-spring-boot-starter

喀拉喀托火山,印度尼西亚 (© Martin Rietze/Alamy)


概述

ID号生成器(或:全局惟一ID生成器)是服务端系统的基础设施,并且ID号这个东西基本搞后端开发的程序员每天都要接触。而关于ID生成的算法如今业界数一数二的当属Snowflake雪花算法。node

UidGenerator正是百度开源的一款基于Snowflake雪花算法实现的高性能惟一ID生成器。在本号前文中已经详细使用过UidGenerator,但使用过程仍是比较繁杂,还须要本身去引UidGenerator组件的源码,感受有点不方便。为此本文基于UidGenerator,再来封装一套更利于Spring Boot项目使用的ID号生成组件,命名为id-spring-boot-starter,一看名字就知道是开箱即用的。mysql


用法

  • 导入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;

这一步确定是省不掉,毕竟UidGenerator须要数据库支持git

  • pom中加入依赖
<dependency>
	<groupid>cn.codesheep</groupid>
	<artifactid>id-spring-boot-starter</artifactid>
	<version>1.0.0</version>
</dependency>
  • 配置数据库链接
url: jdbc:mysql://xxx.xxx.xxx.xxx:3306/demo?useUnicode=true&amp;characterEncoding=utf8&amp;autoReconnect=true&amp;useOldAliasMetadataBehavior=true&amp;connectionCollation=utf8mb4_unicode_ci&amp;rewriteBatchedStatements=true&amp;allowMultiQueries=true
username: xxxxxx
password: xxxxxx

仍是由于UidGenerator须要数据库支持程序员

  • 修改Spring Boot主类

Spring Boot应用主类上加上mybatis注解便可:github

@MapperScan({"com.baidu.fsg.uid.worker.dao"})
  • 代码使用方式
@RestController
public class TestController {

  @Autowired
  private UidGenService uidGenService;

  @GetMapping("/uid")
  public String genUid() {
    return String.valueOf("本次生成的惟一ID号为:"+uidGenService.getUid());
  }
}

怎么样,用法超级简单吧:算法

  1. 首先用 Autowired的方式引入UidGenService类;
  2. 直接调用UidGenService类的getUid()方法便可得到一个Long型的 ID
  • 运行效果

运行效果

demo源码在此,须要请自提:spring


id-spring-boot-starter源码下载

须要组件id-spring-boot-starter源码进行自定制的,能够去github上自行下载源代码,地址在此:sql


几个注意点:

  • 因为UidGenerator须要数据库支持,所以使用前必定要导数据表,而且要配置MapperScan
  • 须要高度定制UidGenerator组件详情的,能够自行修改id-spring-boot-starter内部的cached-uid-spring.xml文件,而后从新打jar
  • 因为ID号生成通常属于系统基础服务,所以能够独立成一个微服务,供其余微服务调用
相关文章
相关标签/搜索