snowman

snowflake（分布式ID生成器），基于Twitter的Snowflake理论

支持客户端分组按块（chunk）生成算法，当前支持的算法包括UUID、DIGIT递增顺序号、SNOWFLAKE（雪花算法）

项目说明

• JDK 版本要求: JDK8+

• 依赖外部服务

  • MySQL
  • Redis

核心概念

• 服务名称name- 服务的名称
• 区块chunk- 一个区块对应一个客户端集群，集群内节点共享，代表每次生成的ID数量
• 服务组group- 服务独有唯一标识
• 服务实例ID- 服务组中每一个运行实例的唯一标识(集群)
• ID策略mode- 可选值，可选项为digit、snowflake、uuid，默认为digit

使用方法

客户端引入依赖

<dependency>
    <groupId>cc.kevinlu</groupId>
    <artifactId>snowman-spring-boot-starter</artifactId>
    <version>最新版本</version>
</dependency>

开启配置(Nacos)

snowman:
  prop:
    name: springcloud-nacos
    chunk: 25
    mode: uuid
    group-id: springcloud-nacos
    server-id: nacos-1

开启配置(spring-boot)

snowman.prop.name=springboot
snowman.prop.group-id=springboot
snowman.prop.server-id=1
server.port=8081

使用

import cc.kevinlu.snow.autoconfigure.SnowmanClient;

@RestController
public class TestController {

   @Resource
   private SnowmanClient snowmanClient;

   @RequestMapping(value = "/index")
   public List<Object> query() {
       return snowmanClient.generateSnowId();
   }
}

• maven依赖等详细配置请查看examples目录下的演示项目

开发计划

v1.0.0 Tag: v1.0.0

• 支持 Digit ID 生成算法
• 支持 Snowflake ID 生成算法
• 支持 UUID 生成算法
• 构建 snowman-spring-boot-starter 实现自动配置
• 支持高可用集群部署
• 支持 ID 预生成，优化每次请求效率，提升性能
• 加入任务异步处理，降低服务队系统资源的影响
• 优化 Snowflake 时钟同步，使用 Redis 时钟做同步
• Web 容器由 Tomcat 更改为 Undertow 提升吞吐量
• 加入日志链路追踪 MDC

v1.0.1 Tag: v1.0.1

• 历史记录支持分表，缓解数据量过大导致的操作性能问题
• 使用 Redis 控制定期任务执行节点

v1.1.0 Tag: v1.1.0

• 新增时间戳生成算法
• 利用SPI提升算法可扩展性
• 自定义注解AlgorithmAnno和AlgorithmInject解决算法扩展

贡献指南

代码要求：

• 统一风格，包含注释、代码缩进等与本项目保持一致
• 保持代码整洁，比如注释掉的代码块等垃圾代码应该删除
• 严格控制外部依赖，如果没有必要，请不要引入外部依赖
• 请在类注释中保留你的作者信息，请不要害羞