npm 包 nanoid 使用教程

在前端开发中，经常需要生成随机字符串来作为唯一标识符或者用于加密等目的。而 npm 包 nanoid 则提供了一种简单易用的方法来生成高性能的随机字符串。本文将详细介绍如何使用 nanoid。

安装

首先需要安装 nanoid，可以通过 npm 进行安装：

npm install nanoid

使用

一旦安装完毕，就可以开始使用了。nanoid 提供了两种生成方式：nanoid() 和 customAlphabet()。

nanoid()

nanoid() 是默认提供的生成函数，它返回一个长度为 21 的随机字符串，由下划线、数字和大小写字母组成：

const { nanoid } = require('nanoid')

const id = nanoid() // e.g. "34BZ_OYXO1d9rYoLjz_Hv"

默认情况下，它会使用 URL-safe Base64 字符集，并去掉了 '_', '-', '+', '/' 这四个字符，以免出现在 URL 中引起歧义。

如果需要更改生成的长度，可以传入一个参数，表示生成的长度（不包括前缀）：

const shortId = nanoid(10) // e.g. "Za6cN8Q2bG"

customAlphabet()

customAlphabet() 则提供了更灵活的自定义字符集方式生成字符串。它需要传入一个参数，表示自定义的字符集，可以是任意字符：

const { customAlphabet } = require('nanoid')

const alphabet = '0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZabcdefghijklmnopqrstuvwxyz'

// 生成长度为 10 的随机字符串
const generate = customAlphabet(alphabet, 10)
const id = generate() // e.g. "JHTdFI5z0w"

注意：自定义字符集中不能包含与默认字符集相同的字符，否则会导致生成的字符串出现错误。

应用场景

唯一标识符

在前端开发过程中，经常需要为每个对象或记录生成唯一标识符。使用 nanoid 可以轻松实现：

const { nanoid } = require('nanoid')
const user = {
  id: nanoid(),
  name: 'john'
}

短链接

在短链接服务中，需要生成短链接编码作为访问标识符。使用 nanoid 可以生成短链接编码，而且长度较短，易于保存和传输。

const { nanoid } = require('nanoid')
const longUrl = 'https://example.com/very-long-url-that-needs-to-be-shortened'
const shortCode = nanoid(7) // e.g. "Za6cN8Q"
const shortUrl = `https://example.com/${shortCode}`

总结

本文介绍了如何使用 npm 包 nanoid 来生成随机字符串，包括安装、默认生成函数 nanoid()、自定义字符集生成函数 customAlphabet() 和应用场景。通过使用 nanoid 可以轻松实现各种前端开发中需要的随机字符串生成需求。

来源：JavaScript中文网 ，转载请注明来源 https://www.javascriptcn.com/post/45061