封裝一個流水號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&characterEncoding=utf8&autoReconnect=true&useOldAliasMetadataBehavior=true&connectionCollation=utf8mb4_unicode_ci&rewriteBatchedStatements=true&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號生成通常屬於系統基礎服務,所以能夠獨立成一個微服務,供其餘微服務調用
相關文章
相關標籤/搜索