NATS Unique Identifier (NUID) 项目使用教程

NATS Unique Identifier (NUID) 项目使用教程

nuidNATS Unique Identifiers项目地址:https://gitcode.com/gh_mirrors/nu/nuid

1. 项目的目录结构及介绍

NUID 项目的目录结构相对简单，主要包含以下几个部分：

nuid/
├── LICENSE
├── README.md
├── go.mod
├── go.sum
├── nuid.go
└── nuid_test.go

• LICENSE: 项目的许可证文件。
• README.md: 项目的基本介绍和使用说明。
• go.mod 和 go.sum: Go 模块文件，用于管理项目的依赖。
• nuid.go: 项目的主要源代码文件，包含了 NUID 的生成逻辑。
• nuid_test.go: 项目的测试文件，用于测试 NUID 的生成逻辑。

2. 项目的启动文件介绍

NUID 项目的启动文件是 nuid.go，该文件包含了 NUID 的主要实现逻辑。以下是 nuid.go 文件的主要内容介绍：

package nuid

import (
	"math/rand"
	"sync"
	"time"
)

const (
	digits   = "0123456789"
	alphabet = "abcdefghijklmnopqrstuvwxyzABCDEFGHIJKLMNOPQRSTUVWXYZ"
	length   = 12
)

var (
	globalNUID = New()
	random     = rand.New(rand.NewSource(time.Now().UnixNano()))
	mu         sync.Mutex
)

type NUID struct {
	pre []byte
	seq uint32
	inc uint32
}

func New() *NUID {
	n := &NUID{}
	n.init()
	return n
}

func (n *NUID) init() {
	n.pre = make([]byte, 12)
	for i := 0; i < 12; i++ {
		n.pre[i] = digits[random.Intn(len(digits))]
	}
	n.seq = random.Uint32()
	n.inc = random.Uint32()%1000 + 1000
}

func (n *NUID) Next() string {
	mu.Lock()
	defer mu.Unlock()

	n.seq += n.inc
	seq := n.seq

	b := make([]byte, length)
	for i := 0; i < 12; i++ {
		b[i] = n.pre[i]
	}
	for i := 12; i < length; i++ {
		b[i] = digits[seq%10]
		seq /= 10
	}

	return string(b)
}

func Next() string {
	return globalNUID.Next()
}

• New(): 创建一个新的 NUID 实例。
• Next(): 生成下一个唯一的 NUID。

3. 项目的配置文件介绍

NUID 项目没有显式的配置文件，其生成逻辑和参数在代码中直接定义。主要的配置参数包括：

• digits: 用于生成 NUID 的字符集。
• alphabet: 用于生成 NUID 的字符集。
• length: NUID 的长度。

这些参数在 nuid.go 文件中定义，可以根据需要进行修改。

---

以上是 NATS Unique Identifier (NUID) 项目的使用教程，包含了项目的目录结构、启动文件和配置文件的介绍。希望对您有所帮助！

nuidNATS Unique Identifiers项目地址:https://gitcode.com/gh_mirrors/nu/nuid