Tinypool 使用教程

Tinypool 使用教程

tinypool 🧵 A minimal and tiny Node.js Worker Thread Pool implementation (38KB) 项目地址: https://gitcode.com/gh_mirrors/ti/tinypool

1. 项目介绍

Tinypool 是一个轻量级的 Node.js 工作线程池实现，它基于 Piscina 项目进行了优化，移除了一些不必要的依赖和特性，以服务于特定的用户场景（如 Vitest）。Tinypool 的安装大小仅为 38KB，相比之下，Piscina 的安装大小为 6MB。如果你不需要像资源利用或操作系统特定的线程优先级设置这样的特性，Tinypool 是一个更小巧的选择。

2. 项目快速启动

在开始使用 Tinypool 之前，确保你的 Node.js 环境版本为 18.x 或更高。

安装

通过 npm 安装 Tinypool：

npm install tinypool

基本使用

以下是一个使用 node:worker_threads 的基本示例：

main.mjs

import Tinypool from 'tinypool';

const pool = new Tinypool({
  filename: new URL('./worker.mjs', import.meta.url).href,
});

const result = await pool.run({ a: 4, b: 6 });
console.log(result); // 输出 10

// 任务完成后销毁线程池
await pool.destroy();

worker.mjs

export default ({ a, b }) => {
  return a + b;
};

使用 node:child_process

你也可以选择使用 child_process 作为工作线程的运行时。

main.mjs

import Tinypool from 'tinypool';

const pool = new Tinypool({
  runtime: 'child_process',
  filename: new URL('./worker.mjs', import.meta.url).href,
});

const result = await pool.run({ a: 4, b: 6 });
console.log(result); // 输出 10

worker.mjs

export default ({ a, b }) => {
  return a + b;
};

3. 应用案例和最佳实践

Tinypool 适用于需要在 Node.js 中处理并发任务，但又不希望引入过多额外依赖的场景。以下是一些应用案例：

• CPU 密集型任务处理：可以分散到多个工作线程中，以充分利用多核处理器的优势。
• 异步任务并行处理：将多个 I/O 密集型异步任务分配到不同工作线程中，以提高整体效率。

最佳实践：

• 在任务执行完毕后，及时销毁线程池，释放资源。
• 对于可能内存泄漏的任务，可以使用 maxMemoryLimitBeforeRecycle 配置项来终止并重新创建工作线程。

4. 典型生态项目

Tinypool 作为一个轻量级的工作线程池实现，是 Node.js 生态系统中的一个补充。以下是一些可能会与 Tinypool 配合使用的主流项目：

• Vitest：一个快速的单元测试框架，可以利用 Tinypool 来并行运行测试。
• 其他任务队列或调度库：与 Tinypool 结合，可以构建更加强大和灵活的后端任务处理系统。

tinypool 🧵 A minimal and tiny Node.js Worker Thread Pool implementation (38KB) 项目地址: https://gitcode.com/gh_mirrors/ti/tinypool