1.0.5 released

Author: cooperlyt

README.cn.md

@@ -0,0 +1,222 @@
+
+uid-generator-spring-boot
+==========================
+
+UidGenerator是Java实现的, 基于[Snowflake](https://github.com/twitter/snowflake)算法的支持响应式编程分布式唯一ID生成器。
+
+基与 [雪花算法](https://github.com/twitter/snowflake)，[百度UidGenerator](https://github.com/baidu/uid-generator)，[uid-generator-spring-boot-starter](https://github.com/wujun234/uid-generator-spring-boot-starter)
+
+
+* 更改了打包结构，抽出了Worker node id的生成接口， 使其可以自定义实现分配 Worker node id的方法， 本项目中实现了四种数据库存储的方法。
+* 支持 Spring boot Autoconfigure 
+* 支持响应式编程，返回`Mono<Long>`, 
+  * 在CachedUidGenerator：消耗速度高于填充速度时，等待填充完成后以非阻塞的方式通知订阅者。
+  * 在DefaultUidGenerator不允许使用未来时间（未到达的时间）状态：当前时间ID耗尽等待下一秒后非阻塞的方式通知订阅者
+* 支持 mybatis jdbc, mybatis r2bc , jap jdbc ,jap r2dbc 四种数据库连接方式
+
+你以可以根据[接口包](https://github.com/cooperlyt/uid-generator-spring-boot/tree/master/uid-generator-api)自己实现Worker node分配的实现
+
+## 原理和性能
+
+请参见[Snowflake](https://github.com/twitter/snowflake)和[百度UidGenerator](https://github.com/baidu/uid-generator)
+
+## 使用
+
+### Maven 
+
+#### spring boot autoconfig 方式
+
+当前版本:1.0.5
+
+```xml
+
+<!-- 根据你的项目环境 选择一种 worker node 分配方式 -->
+
+<!-- 以下仅选一种即可，多了会冲突 -->
+
+<!--mybatis jdbc -->
+<dependency>
+    <groupId>cooperlyt.github.io</groupId>
+    <artifactId>uid-generator-mybatis-jdbc-spring-boot-starter</artifactId>
+    <version>${uid.version}</version>
+</dependency>
+
+        <!--mybatis r2dbc -->
+<dependency>
+<groupId>cooperlyt.github.io</groupId>
+<artifactId>uid-generator-mybatis-r2dbc-spring-boot-starter</artifactId>
+<version>${uid.version}</version>
+</dependency>
+
+
+        <!--jpa jdbc -->
+<dependency>
+<groupId>cooperlyt.github.io</groupId>
+<artifactId>uid-generator-jap-jdbc-spring-boot-starter</artifactId>
+<version>${uid.version}</version>
+</dependency>
+
+        <!--jpa r2dbc -->
+<dependency>
+<groupId>cooperlyt.github.io</groupId>
+<artifactId>uid-generator-jpa-r2dbc-spring-boot-starter</artifactId>
+<version>${uid.version}</version>
+</dependency>
+
+        <!-- 选择相印的数据库驱动包 -->
+        <!-- jdbc驱动 -->
+<dependency>
+    <groupId>org.mariadb.jdbc</groupId>
+    <artifactId>mariadb-java-client</artifactId>
+</dependency>
+
+        <!-- r2dbc驱动 -->
+<dependency>
+    <groupId>org.mariadb</groupId>
+    <artifactId>r2dbc-mariadb</artifactId>
+    <version>1.1.3</version>
+</dependency>
+
+```
+由于开发时Mybatis官方还不支持r2dbc所以使用了[reactive-mybatis-support](https://github.com/chenggangpro/reactive-mybatis-support)
+
+
+### 数据库（可选）
+如果使用数据库实现的Worker node id分配器,需要先建立表 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: CONTAINER(1), ACTUAL(2), FAKE(3)',
+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 boot 配置
+
+#### jdbc  配置 (以mariadb为例)
+
+```yml
+mybatis:
+  configuration:
+    default-fetch-size: 100
+    default-statement-timeout: 30
+    map-underscore-to-camel-case: true
+spring:
+  datasource:
+    driver-class-name: org.mariadb.jdbc.Driver
+    url: jdbc:mariadb://127.0.0.1:3306/database?
+    username: root
+    password: ****
+```
+
+#### r2dbc 配置
+
+```yml
+
+r2dbc:
+  mybatis:
+    mapper-locations: classpath:mapper/*.xml
+    map-underscore-to-camel-case: true
+spring:
+  r2dbc:
+    mybatis:
+      r2dbc-url: r2dbc:mariadb://127.0.0.1:3306/database
+      username: root
+      password: ****
+      pool:
+        max-idle-time: PT3M
+        validation-query: SELECT 1 FROM DUAL
+        initial-size: 1
+        max-size: 3
+        acquire-retry: 3
+        validation-depth: REMOTE
+        max-create-connection-time: PT30S
+
+```
+
+#### 自定义 CachedUidGenerator 拒绝策略 
+
+```java
+  // 生成一批ID后由于buffer环已满无法填充时的处理方式, 默认为丢弃并打印日志
+  @Bean
+  RejectedPutBufferHandler customPutHandler() {
+      return (buffer, id) -> {
+      do your
+      };
+  }
+
+  // 由于消耗过快使用到了未来时间（未到达的时间）时的处理方式, 默认为允许并打印日志
+  @Bean
+  TimeIsFutureHandler customFutureTimeHandler() {
+      return (futureTime, currentTime) -> {
+      do your
+      };
+  }
+  
+```
+
+#### ID 生成配置， 如应用在生产环境请确认以下参数，并确保你已经理解每个参数的意义。
+```yml
+uid:
+  timeBits: 30             # 时间位, 默认:30
+  workerBits: 16           # 机器位, 默认:16
+  seqBits: 7               # 序列号, 默认:7
+  epochStr: "2023-02-17"   # 初始时间, 默认:"2019-02-20"
+  enableFutureTime: false # 允许使用未来时间生成ID,可以使用多少未来时间由 maxBackwardSeconds 控制， 默认: false
+  maxBackwardSeconds: 1    # 系统时钟回拨和使用未来时间最长容忍时间（秒）, 默认:1
+  CachedUidGenerator:     # CachedUidGenerator相关参数
+    boostPower: 3          # RingBuffer size扩容参数, 可提高UID生成的吞吐量, 默认:3
+    paddingFactor: 50      # 指定何时向RingBuffer中填充UID, 取值为百分比(0, 100), 默认为50
+    #scheduleInterval: 60    # 默认:不配置此项, 即不使用Schedule线程定时填充buffer环. 如需使用, 请指定Schedule线程时间间隔, 单位:秒
+```
+
+### 使用
+
+#### 
+
+```java
+//实时生成
+//@Resource
+//private UidGenerator defaultUidGenerator;
+
+//生成一次id之后，按序列号+1生成一批id，缓存，供之后请求 
+@Resource
+private UidGenerator cachedUidGenerator;
+
+
+
+@Test
+public void testSerialGenerate() {
+    // Generate UID
+    Mono<Long> uid = cachedUidGenerator.getUID();
+
+    // Parse UID into [Timestamp, WorkerId, Sequence]
+    // {"UID":"450795408770","timestamp":"2019-02-20 14:55:39","workerId":"27","sequence":"2"}
+    System.out.println(cachedUidGenerator.parseUID(uid));
+
+}
+```
+
+#### 策略选择
+
+
+* CachedUidGenerator:
+  
+  适合**持续高消耗量**的ID分发，也会保持证生成ID排序准确性，此方式会一定程度上的增加内存和CPU缓存占用。
+
+* enableFutureTime 为true时的 DefaultUidGenerator:
+
+  适合**偶然突发的消费增加后持续保持低消耗量**的ID分发，此方式在突发高消费时的性能要比CachedUidGenerator还要高，但不应该持续保持高消耗(可消耗的未来时间由maxBackwardSeconds控制，超出后抛出异常)，因为过度使用未来时间有可能会造成服务重启后生成重复ID和短时间内的ID排序不精确。
+
+* enableFutureTime 为false时的 DefaultUidGenerator:
+  
+  适合**低消耗量实时**的ID分发，此方式可以保正ID中的时间精确，可满足高精确性的ID排序，一但消耗量高于当前时间的发号量时会返回一个等待响应，等待下一可用时间后发出ID（此方式在消费量大于当前时间可生成ID数量后性能最低），最大等待时间由maxBackwardSeconds控制，超出后抛出异常。
+
+对于发号性能的测式可使用此 [测试用例](https://github.com/cooperlyt/uid-generator-spring-boot/tree/master/uid-generator-spring-boot-starter/src/test/java/io/github/cooperlyt/cloud/uid) 进行测试，并参见[百度UidGenerator](https://github.com/baidu/uid-generator)