pg-boss 使用教程

范垣楠Rhoda

于 2024-09-15 08:35:48 发布

阅读量811

点赞数 10

本文链接：https://blog.csdn.net/gitblog_00283/article/details/142276904

版权

pg-boss 使用教程

pg-boss Queueing jobs in Node.js using PostgreSQL like a boss 项目地址: https://gitcode.com/gh_mirrors/pg/pg-boss

1. 项目介绍

pg-boss 是一个基于 PostgreSQL 和 Node.js 的任务队列库。它利用 PostgreSQL 的 SKIP LOCKED 特性来解决关系数据库中记录锁定的挑战，从而实现任务的异步处理和可靠的执行。pg-boss 适用于已经熟悉关系数据库操作（如 SQL 查询和备份）的团队，特别是那些已经在使用 PostgreSQL 并希望减少系统监控和支持复杂性的团队。

主要特性

Exactly-once 任务交付：确保任务只执行一次。
事务内创建任务：可以在现有数据库事务中创建任务。
支持背压的轮询工作器：适用于高并发场景。
Cron 调度：支持定时任务调度。
优先级队列、死信队列、任务延迟、自动重试：提供多种任务管理策略。
Pub/sub API：支持发布/订阅模式。
多主节点兼容：适用于 Kubernetes ReplicaSet 等多主节点环境。

2. 项目快速启动

安装

首先，确保你已经安装了 Node.js 和 PostgreSQL。然后，通过 npm 或 yarn 安装 pg-boss：

# 使用 npm 安装
npm install pg-boss

# 使用 yarn 安装
yarn add pg-boss

初始化

以下是一个简单的示例，展示如何初始化 pg-boss 并创建一个任务队列：

const PgBoss = require('pg-boss');

// 初始化 pg-boss
const boss = new PgBoss('postgres://user:pass@host/database');

// 监听错误
boss.on('error', console.error);

async function start() {
    // 启动 pg-boss
    await boss.start();

    // 创建一个任务队列
    const queue = 'example-queue';
    await boss.createQueue(queue);

    // 发送一个任务
    const id = await boss.send(queue, { arg1: 'hello' });
    console.log(`created job ${id} in queue ${queue}`);

    // 处理任务
    await boss.work(queue, async (job) => {
        console.log(`received job ${job.id} with data ${JSON.stringify(job.data)}`);
    });
}

start().catch(err => {
    console.error(err);
    process.exit(1);
});