snowflake

README

snowflake

雪花算法，用于生成分布式数据库中的主键。能保证全局唯一性、趋势递增和信息安全。

原理

使用

1. 安装依赖

go get -u github.com/zhanglp0129/snowflake

1. 创建雪花算法配置

startTime, _ := time.Parse("2006-01-02 15:04:05", "2024-08-14 00:00:00")
cfg := snowflake.NewDefaultConfigWithStartTime(startTime)

1. 创建工作节点

worker, err := snowflake.NewWorker(cfg, 0)

1. 生成id

id, err := worker.GenerateId()

LICENSE

MIT

Documentation

Index

• Variables
• func GetMachineId(c SnowFlakeConfig, id int64) (int64, error)
• type SnowFlakeConfig
  • func NewDefaultConfigWithStartTime(startTime time.Time) SnowFlakeConfig
  • func (c *SnowFlakeConfig) SetStartTime(startTime time.Time)
• type SnowflakeError
  • func (e SnowflakeError) Error() string
• type Worker
  • func (w *Worker) GenerateId() (int64, error)
• type WorkerInterface
  • func NewWorker(c SnowFlakeConfig, machineId int64) (WorkerInterface, error)

Variables

var (
	// DefaultConfig 雪花算法默认配置
	DefaultConfig = SnowFlakeConfig{
		StartTimestamp: 0,
		TimestampBits:  41,
		MachineIdBits:  10,
		SeqBits:        12,
	}
)

Functions

func GetMachineId

func GetMachineId(c SnowFlakeConfig, id int64) (int64, error)

GetMachineId 获取机器码

Types

type SnowFlakeConfig

type SnowFlakeConfig struct {
	// 起始时间戳，单位为毫秒，默认为0，即1970-01-01 00:00:00.000
	StartTimestamp int64
	// 时间戳位数，默认为41
	TimestampBits uint8
	// 机器码位数，默认为10
	MachineIdBits uint8
	// 序列号位数，默认为12
	SeqBits uint8
}

SnowFlakeConfig 雪花

func NewDefaultConfigWithStartTime

func NewDefaultConfigWithStartTime(startTime time.Time) SnowFlakeConfig

NewDefaultConfigWithStartTime 创建一个雪花算法默认配置，并指定起始时间

func (*SnowFlakeConfig) SetStartTime

func (c *SnowFlakeConfig) SetStartTime(startTime time.Time)

SetStartTime 设置起始时间

type SnowflakeError

type SnowflakeError string

const (
	BitsSumError     SnowflakeError = "the sum of bits error, must be 63"
	MachineIdIllegal SnowflakeError = "machine id is illegal"
	TimestampIllegal SnowflakeError = "timestamp is illegal"
	SeqIllegal       SnowflakeError = "sequence is illegal"
)

func (SnowflakeError) Error

func (e SnowflakeError) Error() string

type Worker

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

Worker 工作节点

func (*Worker) GenerateId

func (w *Worker) GenerateId() (int64, error)

GenerateId 生成雪花id

type WorkerInterface

type WorkerInterface interface {
	GenerateId() (int64, error)
}

func NewWorker

func NewWorker(c SnowFlakeConfig, machineId int64) (WorkerInterface, error)

NewWorker 创建一个雪花算法的工作节点