Node.js crypto.randomBytes(size[, callback])用法及代码示例

crypto.randomBytes(size[, callback])

参数

• size <number> 要生成的字节数。 size 不得大于 2**31 - 1 。
• callback <Function>
  • err <Error>
  • buf <Buffer>
• 如果未提供 callback 函数，则返回： <Buffer> 。

生成加密的强伪随机数据。 size 参数是一个数字，表示要生成的字节数。

如果提供了 callback 函数，则会异步生成字节，并使用两个参数调用 callback 函数：err 和 buf。如果发生错误，err 将是一个Error 对象；否则为 null 。 buf 参数是一个包含生成字节的 Buffer 。

// Asynchronous
const {
  randomBytes
} = await import('node:crypto');

randomBytes(256, (err, buf) => {
  if (err) throw err;
  console.log(`${buf.length} bytes of random data: ${buf.toString('hex')}`);
});// Asynchronous
const {
  randomBytes,
} = require('node:crypto');

randomBytes(256, (err, buf) => {
  if (err) throw err;
  console.log(`${buf.length} bytes of random data: ${buf.toString('hex')}`);
});

如果未提供 callback 函数，则同步生成随机字节并以 Buffer 的形式返回。如果生成字节时出现问题，将引发错误。

// Synchronous
const {
  randomBytes
} = await import('node:crypto');

const buf = randomBytes(256);
console.log(
  `${buf.length} bytes of random data: ${buf.toString('hex')}`);// Synchronous
const {
  randomBytes,
} = require('node:crypto');

const buf = randomBytes(256);
console.log(
  `${buf.length} bytes of random data: ${buf.toString('hex')}`);

在有足够的可用熵之前，crypto.randomBytes() 方法不会完成。这通常不会花费超过几毫秒的时间。可以想象，生成随机字节的唯一时间可能会阻塞更长的时间是在启动之后，此时整个系统的熵仍然很低。

此 API 使用 libuv 的线程池，这可能会对某些应用程序产生令人惊讶的负面性能影响；有关详细信息，请参阅 UV_THREADPOOL_SIZE 文档。

crypto.randomBytes() 的异步版本在单个线程池请求中执行。为了最大限度地减少线程池任务长度变化，请在执行客户端请求时对大型 randomBytes 请求进行分区。