Golang极速全局唯一ID生成器插件库WUID的使用

概述

• WUID是一个通用唯一标识符生成器
• WUID比传统UUID快得多，每个WUID实例每秒可以生成1亿个唯一标识符
• 本质上，WUID按顺序生成64位整数，高28位从数据源加载，目前支持Redis、MySQL、MongoDB和Callback
• 只要所有WUID实例共享相同数据源或每组具有不同的section ID，就能保证唯一性
• 当低36位即将用完时，WUID会自动更新高28位
• WUID是线程安全的，并且无锁
• 支持混淆

性能基准

BenchmarkWUID           159393580          7.661 ns/op        0 B/op       0 allocs/op
BenchmarkRand           100000000         14.95 ns/op         0 B/op       0 allocs/op
BenchmarkTimestamp      164224915          7.359 ns/op        0 B/op       0 allocs/op
BenchmarkUUID_V1        23629536          43.42 ns/op         0 B/op       0 allocs/op
BenchmarkUUID_V2        29351550          43.96 ns/op         0 B/op       0 allocs/op
BenchmarkUUID_V3         4703044         254.2 ns/op        144 B/op       4 allocs/op
BenchmarkUUID_V4         5796310         210.0 ns/op         16 B/op       1 allocs/op
BenchmarkUUID_V5         4051291         310.7 ns/op        168 B/op       4 allocs/op
BenchmarkRedis              2996       38725 ns/op          160 B/op       5 allocs/op
BenchmarkSnowflake       1000000        2092 ns/op            0 B/op       0 allocs/op
BenchmarkULID            5660170         207.7 ns/op         16 B/op       1 allocs/op
BenchmarkXID            49639082          26.21 ns/op         0 B/op       0 allocs/op
BenchmarkShortID         1312386         922.2 ns/op        320 B/op      11 allocs/op
BenchmarkKsuid          19717675          59.79 ns/op         0 B/op       0 allocs/op

安装

go get -u github.com/edwingeng/wuid

使用示例

Redis示例

import "github.com/edwingeng/wuid/redis/v8/wuid"

newClient := func() (redis.UniversalClient, bool, error) {
    var client redis.UniversalClient
    // 初始化Redis客户端
    return client, true, nil
}

// 初始化
w := NewWUID("alpha", nil)
err := w.LoadH28FromRedis(newClient, "wuid")
if err != nil {
    panic(err)
}

// 生成ID
for i := 0; i < 10; i++ {
    fmt.Printf("%#016x\n", w.Next())
}

MySQL示例

import "github.com/edwingeng/wuid/mysql/wuid"

openDB := func() (*sql.DB, bool, error) {
    var db *sql.DB
    // 初始化数据库连接
    return db, true, nil
}

// 初始化
w := NewWUID("alpha", nil)
err := w.LoadH28FromMysql(openDB, "wuid")
if err != nil {
    panic(err)
}

// 生成ID
for i := 0; i < 10; i++ {
    fmt.Printf("%#016x\n", w.Next())
}

MongoDB示例

import "github.com/edwingeng/wuid/mongo/wuid"

newClient := func() (*mongo.Client, bool, error) {
    var client *mongo.Client
    // 初始化MongoDB客户端
    return client, true, nil
}

// 初始化
w := NewWUID("alpha", nil)
err := w.LoadH28FromMongo(newClient, "test", "wuid", "default")
if err != nil {
    panic(err)
}

// 生成ID
for i := 0; i < 10; i++ {
    fmt.Printf("%#016x\n", w.Next())
}

Callback示例

import "github.com/edwingeng/wuid/callback/wuid"

callback := func() (int64, func(), error) {
    var h28 int64
    // 自定义逻辑获取h28值
    return h28, nil, nil
}

// 初始化
w := NewWUID("alpha", nil)
err := w.LoadH28WithCallback(callback)
if err != nil {
    panic(err)
}

// 生成ID
for i := 0; i < 10; i++ {
    fmt.Printf("%#016x\n", w.Next())
}

MySQL表创建

CREATE TABLE IF NOT EXISTS `wuid` (
    `h` int(10) NOT NULL AUTO_INCREMENT,
    `x` tinyint(4) NOT NULL DEFAULT '0',
    PRIMARY KEY (`x`),
    UNIQUE KEY `h` (`h`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1;

选项

• WithSection 在每个生成的数字上标记一个section ID，section ID必须在[0, 7]之间
• WithStep 设置每个生成数字的步长和下限
• WithObfuscation 启用数字混淆

注意事项

强烈建议将logger传递给wuid.NewWUID并密切关注包含"renew failed"的警告。这表示低36位将在几小时到几百小时内用完，并且续订程序因某些原因失败。WUID将进行多次续订尝试，直到成功为止。