Lycoris.Snowflakes 6.0.1

雪花Id生成器

本地雪花Id生成器

雪花Id生成器注册

• 1. 基础注册

builder.Services.AddLocalSnowflake();

• 2. 启用雪花Id存储桶来提高获取Id的效率

builder.Services.AddLocalSnowflake(builder =>
{
    builder.Configure(opt =>
    {
        // 启用雪花Id存储桶，不设置的话默认不启用
        opt.EnabledSnowflakeBucket = true;
        // 雪花Id存储桶上限，默认：50
        // 设置上限的请根据业务量和机器内存来确定
        // 存储桶没有雪花Id的时候方法会自动切换实时生成，不影响Id获取使用，所以不建议设置过大
        opt.SnowflakeBucketLimit = 5;
        // 雪花Id存储桶刷新时长，默认：1秒
        opt.SnowflakeBucketRefreshnterval = TimeSpan.FromSeconds(10);
    });
});

• 3. 所有配置

builder.Services.AddLocalSnowflake(builder =>
{
    builder.Configure(opt =>
    {
        // 工作机器ID，不设置的话默认从1开始，用于防止时钟回拨导致的Id重复
        opt.WorkId = 1;
        // 工作机器id所占用的长度，最大10，默认10
        opt.WorkIdLength = 10;
        // 用于计算时间戳的开始时间，默认起始时间 UTC 2000-01-01
        opt.StartTimeStamp = DateTime.Now;
        // 启用雪花Id存储桶，不设置的话默认不启用
        opt.EnabledSnowflakeBucket = true;
        // 雪花Id存储桶上限，默认：50
        // 设置上限的请根据业务量和机器内存来确定
        // 存储桶没有雪花Id的时候方法会自动切换实时生成，不影响Id获取使用，所以不建议设置过大
        opt.SnowflakeBucketLimit = 5;
        // 雪花Id存储桶刷新时长，默认：1秒
        opt.SnowflakeBucketRefreshnterval = TimeSpan.FromSeconds(10);
        // 是否过滤基础日志 默认：环境变量 ASPNETCORE_ENVIRONMENT = Development 不过滤 其他情况过滤
        opt.FilterInfoLogger = true;
    });

    // 自定义雪花Id存储桶，允许自定义存储桶
    builder.AddSnowflakesBucket<CustomeSnowflakesBucket>();
    // 自定义日志工厂 需要实现 ILycorisLoggerFactory 接口
    builder.AddLoggerFactory<CustomeLoggerFactory>();
});

使用方法

public class TestWork : ITestWork
{
    private readonly ISnowflakeMaker _snowflakeMaker; 

    public TestWork(ISnowflakeMaker snowflakeMaker)
    {
        _snowflakeMaker = snowflakeMaker;
    }

    public void Test()
    {
       // 如果有启用存储桶，请使用以下方法获取Id
       var snowflakeId = _snowflakeMaker.BucketPriorityNextId();
       // 如果没有启用存储桶
       snowflakeId = _snowflakeMaker.RealTimeNextId();
    }
}

分布式雪花Id生成器

• 1. 基础注册

builder.Services.AddDistributedSnowflake(builder => 
{
    // 添加分布式Id缓存服务 需要继承 'IDistributedSnowflakesRedis' 并实现相关redis操作方法
    builder.AddSnowflakesDistributedRedis<DistributedSnowflakesRedis>();
});

• 2. 启用雪花Id存储桶来提高获取Id的效率

builder.Services.AddDistributedSnowflake(builder =>
{
    builder.Configure(opt =>
    {
        // 启用雪花Id存储桶，不设置的话默认不启用
        opt.EnabledSnowflakeBucket = true;
        // 雪花Id存储桶上限，默认：50
        // 设置上限的请根据业务量和机器内存来确定
        // 存储桶没有雪花Id的时候方法会自动切换实时生成，不影响Id获取使用，所以不建议设置过大
        opt.SnowflakeBucketLimit = 5;
        // 雪花Id存储桶刷新时长，默认：1秒
        opt.SnowflakeBucketRefreshnterval = TimeSpan.FromSeconds(10);
    });

    // 添加分布式Id缓存服务 需要继承 'IDistributedSnowflakesRedis' 并实现相关redis操作方法
    builder.AddSnowflakesDistributedRedis<DistributedSnowflakesRedis>();
});

• 3. 所有配置

builder.Services.AddDistributedSnowflake(builder =>
{
    builder.Configure(opt =>
    {
        // 工作机器ID，不设置的话默认从1开始，用于防止时钟回拨导致的Id重复
        opt.WorkId = 1;
        // 工作机器id所占用的长度，最大10，默认10
        opt.WorkIdLength = 10;
        // 用于计算时间戳的开始时间，默认起始时间 UTC 2000-01-01
        opt.StartTimeStamp = DateTime.Now;
        // 启用雪花Id存储桶，不设置的话默认不启用
        opt.EnabledSnowflakeBucket = true;
        // 雪花Id存储桶上限，默认：50
        // 设置上限的请根据业务量和机器内存来确定
        // 存储桶没有雪花Id的时候方法会自动切换实时生成，不影响Id获取使用，所以不建议设置过大
        opt.SnowflakeBucketLimit = 5;
        // 雪花Id存储桶刷新时长，默认：1秒
        opt.SnowflakeBucketRefreshnterval = TimeSpan.FromSeconds(10);
        // 是否过滤基础日志 默认：环境变量 ASPNETCORE_ENVIRONMENT = Development 不过滤 其他情况过滤
        opt.FilterInfoLogger = true;
        // 分布式Id redis缓存前缀，默认值：LycorisSnowflake
        opt.RedisPrefix = "RedisPrefix";
    });

    // 添加分布式Id缓存服务 需要继承 'IDistributedSnowflakesRedis' 并实现相关redis操作方法
    builder.AddSnowflakesDistributedRedis<DistributedSnowflakesRedis>();

    // 自定义雪花Id存储桶
    builder.AddSnowflakesBucket<CustomeSnowflakesBucket>();
    // 自定义日志工厂 需要实现 ILycorisLoggerFactory 接口
    builder.AddLoggerFactory<CustomeLoggerFactory>();
});

使用方法

public class TestWork : ITestWork
{
    private readonly ISnowflakeMaker _snowflakeMaker; 

    public TestWork(ISnowflakeMaker snowflakeMaker)
    {
        _snowflakeMaker = snowflakeMaker;
    }

    public void Test()
    {
       // 如果有启用存储桶，请使用以下方法获取Id
       var snowflakeId = _snowflakeMaker.BucketPriorityNextId();
       // 如果没有启用存储桶
       snowflakeId = _snowflakeMaker.RealTimeNextId();
    }
}

扩展使用注意事项:

• 1. 本地雪花Id生成器与分布式雪花Id生成器无法同时使用，请不要同时注册以免造成异常
• 2. 分布式雪花Id生成器必须要继承 IDistributedSnowflakesRedis 并实现相关redis操作方法，并在添加扩展时候使用 AddSnowflakesDistributedRedis 进行注册

PS:如果你使用了多个Lycoris系列扩展,那你可以在注册这些扩展之前使用builder.Serovces.AddLycorisLoggerFactory<CustomeLoggerFactory>()进行替换，就不需要在每个扩展中使用AddLycorisLoggerFactory进行逐一替换了