id

package module
v0.1.1 Latest Latest
Warning

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

Go to latest
Published: Sep 12, 2026 License: MIT Imports: 16 Imported by: 0

README

ID 生成器

id package 提供多种唯一 ID 生成能力,覆盖通用主键、分布式时序 ID、订单号和机器标识。

功能概览

  • UUID/GUID:NewGUIDv4、NewGUIDv7(支持是否带横线)
  • 短 ID:NewShortUUID、NewKSUID、NewXID
  • 分布式 ID:NewSnowflakeID、NewSonyflakeID
  • MongoDB ID:NewMongoObjectID
  • 订单号:随机、自增、商户维度、带前缀 Snowflake/Sonyflake
  • 机器标识:UnifyMachineID、FormatMachineID

快速开始

package main

import (
	"fmt"
	"log"

	"github.com/kalandramo/bald-utils/id"
)

func main() {
	guid := id.NewGUIDv4(false)
	guidV7 := id.NewGUIDv7(true)
	shortID := id.NewShortUUID()
	ksuid := id.NewKSUID()
	xid := id.NewXID()

	sfID, err := id.NewSnowflakeID(1)
	if err != nil {
		log.Fatal(err)
	}

	sonyID, err := id.NewSonyflakeID()
	if err != nil {
		log.Fatal(err)
	}

	machineID, err := id.UnifyMachineID()
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println(guid, guidV7, shortID, ksuid, xid, sfID, sonyID, machineID)
}

主要 API

UUID / 短 ID
func NewGUIDv4(withHyphen bool) string
func NewGUIDv7(withHyphen bool) string
func NewShortUUID() string
func NewKSUID() string
func NewXID() string
func NewMongoObjectID() string
Snowflake / Sonyflake
func NewSnowflakeID(workerId int64) (int64, error)
func GenerateSnowflakeID(workerId int64) int64

func NewSonyflakeID() (uint64, error)
func GenerateSonyflakeID() uint64
订单号
func GenerateOrderIdWithRandom(prefix string, tm *time.Time) string
func GenerateOrderIdWithIncreaseIndex(prefix string, tm *time.Time) string
func GenerateOrderIdWithTenantId(tenantID string) string
func GenerateOrderIdWithPrefixSonyflake(prefix string) string
func GenerateOrderIdWithPrefixSnowflake(workerId int64, prefix string) string
Machine ID
type FormatOption struct {
	UpperCase  bool
	WithHyphen bool
}

func UnifyMachineID() (string, error)
func FormatMachineID(opt FormatOption) (string, error)
  • UnifyMachineID:返回 32 位小写十六进制字符串
  • FormatMachineID:支持大小写与 GUID 横线格式(8-4-4-4-12)
  • 当底层返回值格式异常时,会自动降级为哈希结果,保证稳定输出

Machine ID 平台说明

底层依赖 id/machineid 子包,支持多平台(Windows、Linux、macOS、BSD、AIX、Z/OS)。

说明

  • 本包依赖多个成熟第三方库(如 uuid、snowflake、sonyflake、ksuid 等)
  • Generate* 系列方法通常会忽略底层错误,业务中建议优先使用 New* 并处理 error

测试

go test ./...

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func FormatMachineID

func FormatMachineID(opt FormatOption) (string, error)

FormatMachineID 获取格式化后的 machineId

func GenerateOrderIdWithIncreaseIndex

func GenerateOrderIdWithIncreaseIndex(prefix string, tm *time.Time) string

GenerateOrderIdWithIncreaseIndex 生成订单号:前缀 + 时间(14位) + 自增索引(3位补零)。 UT7 修复:索引 %03d 补零——原 %d 不定长使「20 位订单号」承诺失真;索引 mod 1000 环绕,同秒第 1001 单与完全同构的前段 ID 碰撞,使用方须保证单实例同秒 <1000 单 (多实例须按 worker 分片计数,当前计数器为进程级)。

func GenerateOrderIdWithPrefixSnowflake

func GenerateOrderIdWithPrefixSnowflake(workerId int64, prefix string) string

func GenerateOrderIdWithPrefixSonyflake

func GenerateOrderIdWithPrefixSonyflake(prefix string) string

func GenerateOrderIdWithRandom

func GenerateOrderIdWithRandom(prefix string, tm *time.Time) string

GenerateOrderIdWithRandom 生成订单号,前缀 + 时间戳 + 随机数

func GenerateOrderIdWithTenantId

func GenerateOrderIdWithTenantId(tenantID string) string

GenerateOrderIdWithTenantId 带商户ID的订单ID生成器

func GenerateSnowflakeID

func GenerateSnowflakeID(workerId int64) int64

func GenerateSonyflakeID

func GenerateSonyflakeID() uint64

func NewGUIDv4

func NewGUIDv4(withHyphen bool) string

NewGUIDv4 generates a new GUID/UUID v4 string.

func NewGUIDv7

func NewGUIDv7(withHyphen bool) string

NewGUIDv7 generates a new GUID/UUID v7 string.

func NewKSUID

func NewKSUID() string

NewKSUID generates a new KSUID string.

func NewMongoObjectID

func NewMongoObjectID() string

NewMongoObjectID generates a new MongoDB ObjectID string.

func NewShortUUID

func NewShortUUID() string

NewShortUUID generates a new ShortUUID string.

func NewSnowflakeID

func NewSnowflakeID(workerId int64) (int64, error)

func NewSonyflakeID

func NewSonyflakeID() (uint64, error)

func NewXID

func NewXID() string

NewXID generates a new XID string.

func UnifyMachineID

func UnifyMachineID() (string, error)

UnifyMachineID 兼容旧接口,等价于 FormatMachineID(小写无横线)

Types

type FormatOption

type FormatOption struct {
	UpperCase  bool // true: 大写,false: 小写
	WithHyphen bool // true: 带横线,false: 不带横线
}

FormatOption 定义格式化选项

type SnowflakeNode

type SnowflakeNode struct {
	sync.Mutex
	// contains filtered or unexported fields
}

func NewSnowflakeNode

func NewSnowflakeNode(workerId int64) (*SnowflakeNode, error)

func (*SnowflakeNode) Generate

func (sfNode *SnowflakeNode) Generate() int64

func (*SnowflakeNode) GenerateString

func (sfNode *SnowflakeNode) GenerateString() string

Directories

Path Synopsis
Package machineid provides support for reading the unique machine id of most OSs (without admin privileges).
Package machineid provides support for reading the unique machine id of most OSs (without admin privileges).

Jump to

Keyboard shortcuts

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