Giter Club home page Giter Club logo

go-nanoid's Introduction

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
  • Semver

Install

go get github.com/jaevor/go-nanoid

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 also 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() {
	canonic, err := nanoid.Standard(21)
	if err != nil {
		panic(err)
	}

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

	// Makes sense to use CustomASCII since 0-9 is ascii.
	custom, err := nanoid.CustomASCII("0123456789", 12)
	if err != nil {
		panic(err)
	}

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

Notes

I have 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 -- it was actually slower than using secure (math/rand vs crypto/rand -- rand.Read(...)).

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

go-nanoid's People

Contributors

jaevor avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.