集成分布式高效ID生成Sequence

Author: hengboy

api-boot-project/api-boot-autoconfigure/src/main/java/org/minbox/framework/api/boot/autoconfigure/sequence/ApiBootSequenceAutoConfiguration.java

@@ -0,0 +1,41 @@
+package org.minbox.framework.api.boot.autoconfigure.sequence;
+
+import org.minbox.framework.api.boot.plugin.sequence.Sequence;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+
+/**
+ * 分布式高效ID "Sequence" 自动化配置类
+ *
+ * @author 恒宇少年
+ */
+@Configuration
+@ConditionalOnClass(Sequence.class)
+@EnableConfigurationProperties(ApiBootSequenceProperties.class)
+public class ApiBootSequenceAutoConfiguration {
+    /**
+     * 注入 "Sequence" 所需要的属性配置类
+     */
+    private ApiBootSequenceProperties apiBootSequenceProperties;
+
+    public ApiBootSequenceAutoConfiguration(ApiBootSequenceProperties apiBootSequenceProperties) {
+        this.apiBootSequenceProperties = apiBootSequenceProperties;
+    }
+
+    /**
+     * 实例化 {@link ApiBootSequenceContext}
+     * <p>
+     * 在{@link ApiBootSequenceContext}内进行实例化{@link Sequence}，
+     * 部分配置的默认值请参考{@link ApiBootSequenceProperties}
+     *
+     * @return Sequence instance object
+     */
+    @Bean
+    @ConditionalOnMissingBean
+    public ApiBootSequenceContext apiBootSequenceContext() {
+        return new ApiBootSequenceContext(apiBootSequenceProperties);
+    }
+}

api-boot-project/api-boot-autoconfigure/src/main/java/org/minbox/framework/api/boot/autoconfigure/sequence/ApiBootSequenceContext.java

@@ -0,0 +1,56 @@
+package org.minbox.framework.api.boot.autoconfigure.sequence;
+
+import org.minbox.framework.api.boot.plugin.sequence.Sequence;
+
+/**
+ * 封装{@link Sequence}的上下文
+ * <p>
+ * 通过该类可以直接获取分布式唯一的ID{@link Sequence#nextId()}
+ *
+ * @author 恒宇少年
+ */
+public class ApiBootSequenceContext {
+    /**
+     * 分布式唯一ID实例
+     */
+    private Sequence sequence;
+
+    /**
+     * 构造函数实例化{@link Sequence}
+     * <p>
+     * 根据传递的{@link ApiBootSequenceProperties}属性配置类各个字段的值来实例化{@link Sequence}
+     *
+     * @param sequenceProperties Sequence属性配置类
+     */
+    public ApiBootSequenceContext(ApiBootSequenceProperties sequenceProperties) {
+        this.sequence = new Sequence(
+            sequenceProperties.getDataCenterId(),
+            sequenceProperties.getWorkerId(),
+            sequenceProperties.isClock(),
+            sequenceProperties.getTimeOffsetMilliseconds(),
+            sequenceProperties.isRandomSequence()
+        );
+    }
+
+    /**
+     * 获取下一个分布式ID的值
+     * <p>
+     * 返回{@link String}类型的值
+     *
+     * @return 下一个ID的值
+     */
+    public String nextStringId() {
+        return String.valueOf(this.nextId());
+    }
+
+    /**
+     * 获取下一个分布式ID的值
+     * <p>
+     * 返回{@link Long} 类型的值
+     *
+     * @return 下一个ID的值
+     */
+    public Long nextId() {
+        return this.sequence.nextId();
+    }
+}

api-boot-project/api-boot-autoconfigure/src/main/java/org/minbox/framework/api/boot/autoconfigure/sequence/ApiBootSequenceProperties.java

@@ -0,0 +1,42 @@
+package org.minbox.framework.api.boot.autoconfigure.sequence;
+
+import lombok.Data;
+import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.context.annotation.Configuration;
+
+import static org.minbox.framework.api.boot.autoconfigure.sequence.ApiBootSequenceProperties.API_BOOT_SEQUENCE_PREFIX;
+
+/**
+ * 整合Sequence分布式高效ID的属性相关配置
+ *
+ * @author 恒宇少年
+ */
+@Data
+@Configuration
+@ConfigurationProperties(prefix = API_BOOT_SEQUENCE_PREFIX)
+public class ApiBootSequenceProperties {
+    /**
+     * 分布式ID配置前缀
+     */
+    public static final String API_BOOT_SEQUENCE_PREFIX = "api.boot.sequence";
+    /**
+     * 数据中心编号，取值范围为0 ~ 3
+     **/
+    private int dataCenterId = 1;
+    /**
+     * 工作机器编号，取值范围为0 ~ 255
+     */
+    private int workerId = 1;
+    /**
+     * 是否解决高并发下获取时间戳的性能问题
+     */
+    private boolean clock;
+    /**
+     * 允许时间回拨的毫秒量
+     */
+    private long timeOffsetMilliseconds = 5L;
+    /**
+     * 毫秒内的随机序列
+     */
+    private boolean randomSequence;
+}