Golang分布式生成超短唯一非连续URL友好ID插件库shortid使用指南

shortid是一个用于生成分布式环境下超短、唯一、非连续且URL友好的ID的Go语言库。它特别适合需要生成短链接ID、订单号等场景。

安装

go get github.com/teris-io/shortid

基本用法

1. 生成ID

package main

import (
	"fmt"
	"github.com/teris-io/shortid"
)

func main() {
	// 生成一个ID
	id, err := shortid.Generate()
	if err != nil {
		panic(err)
	}
	fmt.Println("Generated ID:", id) // 输出类似: "g6XxXxXx"
}

2. 自定义配置

func customConfig() {
	// 自定义配置
	sid, err := shortid.New(1, shortid.DefaultABC, 2342)
	if err != nil {
		panic(err)
	}

	// 使用自定义配置生成ID
	id := sid.MustGenerate()
	fmt.Println("Custom ID:", id)
}

高级特性

1. 分布式支持

shortid支持分布式环境，通过为每个worker设置不同的worker编号来避免冲突：

func distributedUsage() {
	// worker编号从0开始，集群中每个实例应有唯一编号
	worker := 2 // 假设这是第3个worker
	
	sid, err := shortid.New(worker, shortid.DefaultABC, 2342)
	if err != nil {
		panic(err)
	}

	for i := 0; i < 5; i++ {
		fmt.Println("Distributed ID:", sid.MustGenerate())
	}
}

2. 自定义字符集

func customAlphabet() {
	// 自定义字符集(仅包含数字和大写字母)
	customABC := "0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ"
	
	sid, err := shortid.New(1, customABC, 2342)
	if err != nil {
		panic(err)
	}

	fmt.Println("Custom alphabet ID:", sid.MustGenerate())
}

3. 设置随机种子

func withSeed() {
	// 设置随机种子以确保可重现结果(仅用于测试)
	sid, err := shortid.New(1, shortid.DefaultABC, 1234) // 固定seed
	if err != nil {
		panic(err)
	}

	// 每次运行都会生成相同的ID序列
	fmt.Println("ID with fixed seed 1:", sid.MustGenerate())
	fmt.Println("ID with fixed seed 2:", sid.MustGenerate())
}

性能考虑

shortid设计为高性能ID生成器，但如果你在极高并发环境下使用，可以考虑以下优化：

func concurrentUsage() {
	sid := shortid.MustNew(1, shortid.DefaultABC, 2342)
	
	// 使用channel批量生成ID
	ids := make(chan string, 100)
	go func() {
		for i := 0; i < 100; i++ {
			ids <- sid.MustGenerate()
		}
		close(ids)
	}()

	for id := range ids {
		fmt.Println(id)
	}
}

实际应用示例

短链接服务

package main

import (
	"fmt"
	"net/http"
	"github.com/teris-io/shortid"
)

var sid = shortid.MustNew(1, shortid.DefaultABC, 2342)

func main() {
	urlStore := make(map[string]string)
	
	http.HandleFunc("/shorten", func(w http.ResponseWriter, r *http.Request) {
		longURL := r.URL.Query().Get("url")
		if longURL == "" {
			http.Error(w, "URL parameter is required", http.StatusBadRequest)
			return
		}
		
		shortID := sid.MustGenerate()
		urlStore[shortID] = longURL
		
		fmt.Fprintf(w, "Short URL: http://localhost:8080/%s", shortID)
	})
	
	http.HandleFunc("/", func(w http.ResponseWriter, r *http.Request) {
		shortID := r.URL.Path[1:]
		if longURL, ok := urlStore[shortID]; ok {
			http.Redirect(w, r, longURL, http.StatusFound)
		} else {
			http.NotFound(w, r)
		}
	})
	
	fmt.Println("Server started at :8080")
	http.ListenAndServe(":8080", nil)
}

注意事项

1. 唯一性保证：确保在分布式环境中每个worker有唯一的编号
2. 字符集选择：默认字符集是URL友好的，修改时需确保仍符合URL规范
3. ID长度：生成的ID长度会随着生成数量的增加而自动增长
4. 安全性：生成的ID不是加密安全的，不应用作安全令牌

shortid是一个简单高效的解决方案，适合需要短ID的大多数场景。对于更高要求的环境，也可以考虑其他方案如ULID或UUID。