snowflake

package
v0.16.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 18, 2026 License: MIT Imports: 4 Imported by: 0

Documentation

Overview

Package snowflake 提供基于雪花算法(Snowflake)的分布式唯一 ID 生成能力。

该实现为纯算法封装,不依赖任何业务类型或全局变量,可直接用于任意项目。 默认起始时间戳为 2024-01-01 00:00:00 UTC,节点位宽 10(0~1023)、序列位宽 12。

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Snowflake

type Snowflake struct {
	// contains filtered or unexported fields
}

Snowflake 雪花 ID 生成器

func NewSnowflake

func NewSnowflake(node uint16) (*Snowflake, error)

NewSnowflake 创建雪花 ID 生成器(使用默认起始时间戳)。

参数:

  • node: 节点 ID,范围为 [0, 1023]

返回值:

  • *Snowflake: 生成器实例
  • error: 节点 ID 非法时返回错误

func NewSnowflakeWithEpoch

func NewSnowflakeWithEpoch(node uint16, epochMillis int64) (*Snowflake, error)

NewSnowflakeWithEpoch 创建雪花 ID 生成器,可自定义起始时间戳(毫秒)。

参数:

  • node: 节点 ID,范围为 [0, 1023]
  • epochMillis: 起始时间戳(毫秒)

返回值:

  • *Snowflake: 生成器实例
  • error: 节点 ID 非法时返回错误

func (*Snowflake) NextID

func (s *Snowflake) NextID() (uint64, error)

NextID 生成下一个唯一 ID。 发生时钟回拨时,小回拨在释放锁后短等,大回拨(超过 5 秒)直接返回错误。

返回值:

  • uint64: 生成的雪花 ID
  • error: 时钟回拨超过阈值或序列号溢出等待失败时返回错误

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL