开源项目 `semaphore-async-await` 使用教程

史姿若Muriel

于 2024-09-02 07:59:41 发布

阅读量539

点赞数 24

本文链接：https://blog.csdn.net/gitblog_01073/article/details/141799372

版权

开源项目 `semaphore-async-await` 使用教程

semaphore-async-await:crossed_flags: Promise based Semaphore suitable to be used with async/await.项目地址:https://gitcode.com/gh_mirrors/se/semaphore-async-await

项目介绍

semaphore-async-await 是一个基于 JavaScript 的异步信号量库，旨在帮助开发者管理异步任务的并发执行。通过使用信号量，开发者可以限制同时进行的异步操作数量，从而避免资源过度占用和提高程序的稳定性。

项目快速启动

安装

首先，通过 npm 或 yarn 安装 semaphore-async-await：

npm install semaphore-async-await
# 或者
yarn add semaphore-async-await

基本使用

以下是一个简单的示例，展示了如何使用 semaphore-async-await 来限制并发任务的数量：

const { Semaphore } = require('semaphore-async-await');

// 创建一个信号量，允许最多 3 个并发任务
const semaphore = new Semaphore(3);

async function task(id) {
  await semaphore.acquire();
  try {
    console.log(`Task ${id} started`);
    // 模拟异步操作
    await new Promise(resolve => setTimeout(resolve, 1000));
    console.log(`Task ${id} finished`);
  } finally {
    semaphore.release();
  }
}

// 启动多个任务
for (let i = 0; i < 10; i++) {
  task(i);
}

应用案例和最佳实践

限制 API 请求并发数

在实际开发中，我们经常需要限制对某个外部 API 的请求并发数，以避免被服务提供商限制或封禁。使用 semaphore-async-await 可以轻松实现这一需求：

const { Semaphore } = require('semaphore-async-await');
const axios = require('axios');

const apiSemaphore = new Semaphore(5); // 限制并发请求数为 5

async function fetchData(url) {
  await apiSemaphore.acquire();
  try {
    const response = await axios.get(url);
    console.log(response.data);
  } catch (error) {
    console.error(`Error fetching ${url}:`, error);
  } finally {
    apiSemaphore.release();
  }
}

// 并发请求多个 URL
const urls = [
  'https://api.example.com/data1',
  'https://api.example.com/data2',
  // ...更多 URL
];

urls.forEach(url => fetchData(url));

资源池管理

在某些场景下，我们可能需要管理一个资源池，例如数据库连接池。使用 semaphore-async-await 可以确保资源池中的资源被合理分配和回收：

const { Semaphore } = require('semaphore-async-await');

class ResourcePool {
  constructor(size) {
    this.semaphore = new Semaphore(size);
    this.resources = Array.from({ length: size }, (_, i) => `Resource-${i}`);
  }

  async acquire() {
    await this.semaphore.acquire();
    return this.resources.pop();
  }

  release(resource) {
    this.resources.push(resource);
    this.semaphore.release();
  }
}

const pool = new ResourcePool(3);

async function useResource() {
  const resource = await pool.acquire();
  try {
    console.log(`Using ${resource}`);
    // 模拟使用资源
    await new Promise(resolve => setTimeout(resolve, 1000));
  } finally {
    pool.release(resource);
  }
}

// 并发使用资源
for (let i = 0; i < 5; i++) {
  useResource();
}