xuwupeng2000 / go-nanoid

Nano ID in Go -- very fast and efficient unique ID generator.

Home Page:https://pkg.go.dev/github.com/jaevor/go-nanoid

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

go-nanoid

Nano ID logo by Anton Lovchikov

Build Status Build Status GitHub Issues Go Version Go Ref

This module is a Go implementation of nanoid.

Features of the nanoid spec are:

  • URL friendly
  • Use of hardware random generator
  • Uses a bigger alphabet than UUID, so a similar number of random bits are packed in just 21 chars instead of 36 (like UUID)
  • Much, much faster than UUID (v4)

Features of this specific implementation are:

  • Fastest and most performant implementation of Nano ID around (benchmarks)
  • Prefetches random bytes in advance
  • Uses optimal memory
  • No production dependencies

Security

See comparison of Nano ID and UUID (V4):

"Nano ID is quite comparable to UUID v4 (random-based). It has a similar number of random bits in the ID (126 in Nano ID and 122 in UUID), so it has a similar collision probability -- for there to be a one in a billion chance of duplication, 103 trillion version 4 IDs must be generated"

And NanoID collision calculator:

If 1,000,000 Nano IDs (using nanoid.Standard(21)) were generated each second, it would require ~41 thousand years in order to have a 1% probability of a collision

In other words, with 21 characters, the total number of possible unique IDs would be 21^64, which is ~four septenvigintillion (4 followed by 84 zeros) -- a figure larger than the number of atoms that exist in the universe, apparently

Read more here

Example

import (
	"log"
	"github.com/jaevor/go-nanoid"
)

func main() {
	canonicID, err := nanoid.Standard(21)
	if err != nil {
		panic(err)
	}

	id1 := canonicID()
	log.Printf("ID 1: %s", id1) // se-jlhSbQbwlviPDFbfGe

	customID, err := nanoid.Custom("0123456789", 12)
	if err != nil {
		panic(err)
	}

	id2 := customID()
	log.Printf("ID 2: %s", id2) // 466568050433
}

Notes

Attempted to make non-secure generation of Nano IDs but removed it because I can't figure out a way to generate many random bytes/numbers efficiently with PRNG

Benchmarks

All benchmarks & tests can be found in nanoid_test.go.

These are all benchmarks of the Standard Nano ID generator

# of characters & # of IDs benchmark screenshot
8, ~21,800,000
21, ~16,400,000
36, ~11,500,000
255, ~2,500,000

Credits & references

License

MIT License

About

Nano ID in Go -- very fast and efficient unique ID generator.

https://pkg.go.dev/github.com/jaevor/go-nanoid

License:MIT License


Languages

Language:Go 98.5%Language:Makefile 1.5%