随机 ID

介绍

本页介绍 @cat-kit/crypto 的随机 ID 生成能力。实现基于 Web Crypto crypto.getRandomValues，可在 Browser / Node.js / Bun 中使用。

默认的 nanoid 生成 URL 安全字符串，适合作为前端临时 ID、请求追踪 ID、非敏感业务对象 ID 等场景。

快速使用

import { nanoid } from '@cat-kit/crypto'

const id = nanoid()
const shortId = nanoid(8)

vue

长度

PAY1BKdZlNBri0ABQwfXt

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778

<template>
  <div class="demo-box">
    <div class="demo-controls">
      <label>
        长度
        <input v-model.number="size" min="0" max="64" type="number" />
      </label>

      <button type="button" @click="refresh">生成</button>
    </div>

    <code class="demo-result">{{ id }}</code>
  </div>
</template>

<script lang="ts" setup>
import { nanoid } from '@cat-kit/crypto'
import { ref } from 'vue'

const size = ref(21)
const id = ref(nanoid(size.value))

function refresh() {
  id.value = nanoid(size.value)
}
</script>

<style scoped>
.demo-box {
  display: flex;
  flex-direction: column;
  gap: 12px;
}

.demo-controls {
  display: flex;
  flex-wrap: wrap;
  gap: 12px;
  align-items: end;
}

label {
  display: flex;
  flex-direction: column;
  gap: 6px;
  font-size: 13px;
  color: var(--vp-c-text-2);
}

input {
  width: 120px;
  padding: 8px 10px;
  border: 1px solid var(--vp-c-divider);
  border-radius: 6px;
  background: var(--vp-c-bg);
  color: var(--vp-c-text-1);
}

button {
  padding: 8px 14px;
  border: 1px solid var(--vp-c-brand-1);
  border-radius: 6px;
  background: var(--vp-c-brand-1);
  color: var(--vp-c-white);
  cursor: pointer;
}

.demo-result {
  display: block;
  min-height: 38px;
  padding: 10px 12px;
  border: 1px solid var(--vp-c-divider);
  border-radius: 6px;
  overflow-wrap: anywhere;
  background: var(--vp-c-bg-soft);
}
</style>

API参考

nanoid

function nanoid(size?: number): string

生成 URL 安全的随机 ID。默认长度为 21，字符来自 urlAlphabet。

import { nanoid } from '@cat-kit/crypto'

nanoid() // 例如 'V1StGXR8_Z5jdHi6B-myT'
nanoid(8)

customAlphabet

function customAlphabet(alphabet: string, size?: number): (size?: number) => string

基于自定义字符集创建 ID 生成器。

import { customAlphabet } from '@cat-kit/crypto'

const createCode = customAlphabet('0123456789ABCDEFGHIJKLMNOPQRSTUVWXYZ', 10)

createCode()
createCode(6)

customRandom

function customRandom(
  alphabet: string,
  defaultSize: number,
  getRandom: (bytes: number) => Uint8Array
): (size?: number) => string

使用自定义随机字节来源创建 ID 生成器。customRandom 会拒绝导致 modulo bias 的随机字节，避免字符分布倾斜。

random

function random(bytes: number): Uint8Array

返回指定长度的安全随机字节。长度必须在 0 到 1024 之间。

urlAlphabet

const urlAlphabet: string

nanoid 默认使用的 URL 安全字符集。