1. 程式人生 > 程式設計 >封裝一個流水號ID生成器:id-spring-boot-starter

封裝一個流水號ID生成器:id-spring-boot-starter


概述

ID號生成器(或:全域性唯一ID生成器)是服務端系統的基礎設施,而且ID號這個東西基本搞後端開發的程式設計師天天都要接觸。而關於ID生成的演演算法現在業界首屈一指的當屬Snowflake雪花演演算法。

UidGenerator正是百度開源的一款基於Snowflake雪花演演算法實現的高效能唯一ID生成器。在本號前文中已經詳細使用過UidGenerator,但使用過程還是比較繁雜,還需要自己去引UidGenerator元件的原始碼,感覺有點不方便。為此本文基於UidGenerator,再來封裝一套更利於Spring Boot專案使用的ID號生成元件,命名為id-spring-boot-starter

,一看名字就知道是開箱即用的。


用法

  • 匯入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需要資料庫支援

  • 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註解即可:

@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原始碼在此,需要請自提:


id-spring-boot-starter原始碼下載

需要元件id-spring-boot-starter原始碼進行自定製的,可以去github上自行下載原始碼,地址在此:


幾個注意點:

  • 由於UidGenerator需要資料庫支援,因此使用前一定要導資料表,並且要配置MapperScan
  • 需要高度定製UidGenerator元件詳情的,可以自行修改id-spring-boot-starter內部的cached-uid-spring.xml檔案,然後重新打jar
  • 由於ID號生成一般屬於系統基礎服務,因此可以獨立成一個微服務,供其他微服務呼叫

寫在最後

由於能力有限,若有錯誤或者不當之處,還請大家批評指正,一起學習交流!