Graphile Worker 快速上手：5分钟学会创建你的第一个后台任务

Graphile Worker 快速上手：5分钟学会创建你的第一个后台任务

【免费下载链接】workerHigh performance Node.js/PostgreSQL job queue (also suitable for getting jobs generated by PostgreSQL triggers/functions out into a different work queue)项目地址: https://gitcode.com/gh_mirrors/wo/worker

Graphile Worker 是一个基于 Node.js 和 PostgreSQL 的高性能任务队列，特别适合将 PostgreSQL 触发器或函数生成的任务分发到不同的工作队列中。本文将带你快速掌握 Graphile Worker 的核心功能，在5分钟内完成你的第一个后台任务创建。

1. 环境准备：3步完成安装配置

1.1 安装必要依赖

确保你的系统已安装 Node.js (v14+) 和 PostgreSQL (v12+)，然后通过以下命令克隆项目：

git clone https://gitcode.com/gh_mirrors/wo/worker cd worker yarn install

1.2 配置数据库连接

创建环境配置文件：

cp .env.example .env

编辑.env文件设置 PostgreSQL 连接信息：

DATABASE_URL=postgres://username:password@localhost:5432/worker_db

1.3 初始化数据库架构

运行数据库迁移脚本创建必要表结构：

yarn run migrate

2. 创建任务：编写你的第一个后台任务

2.1 创建任务文件

在项目根目录创建tasks文件夹，并添加log_payload.js文件：

// tasks/log_payload.js module.exports = async (payload, helpers) => { const { logger } = helpers; logger.info(`Received payload: ${JSON.stringify(payload)}`); // 这里添加你的任务逻辑 return { success: true, payload }; };

2.2 注册任务

修改graphile.config.ts文件注册新任务：

// graphile.config.ts import { makeConfig } from "graphile-config"; export default makeConfig({ plugins: [ "graphile-worker", // 其他插件... ], worker: { taskDirectory: `${__dirname}/tasks`, }, });

3. 运行任务：3种启动方式任你选

3.1 单次运行模式

适合测试单个任务：

yarn run worker --once --task log_payload --payload '{"message":"Hello Graphile Worker"}'

3.2 持续监听模式

生产环境常用，持续监听任务队列：

yarn run worker

3.3 使用 cron 定时任务

编辑crontab文件添加定时任务：

# 每分钟执行一次 log_payload 任务 * * * * * yarn run worker --once --task log_payload --payload '{"type":"cron"}'

4. 监控与调试：确保任务可靠运行

4.1 查看任务状态

通过 SQL 查询监控任务状态：

-- 查看所有待处理任务 SELECT * FROM graphile_worker.jobs WHERE status = 'pending';

4.2 日志查看

默认日志保存在logs/worker.log，也可通过配置文件自定义日志路径：

// src/logger.ts export const logger = createLogger({ filename: `${__dirname}/../logs/worker.log`, level: "info", });

4.3 错误处理

任务失败时会自动重试，可在任务函数中添加自定义错误处理：

// tasks/log_payload.js module.exports = async (payload, helpers) => { try { // 任务逻辑 } catch (error) { helpers.logger.error(`Task failed: ${error.message}`); throw error; // 触发重试机制 } };

5. 进阶技巧：提升任务处理效率

5.1 任务优先级

添加任务时指定优先级：

yarn run worker --task log_payload --payload '{"urgent": true}' --priority 10

5.2 并发控制

修改配置文件设置并发数：

// graphile.config.ts export default makeConfig({ worker: { concurrency: 5, // 同时处理5个任务 }, });

5.3 使用 TypeScript

创建 TypeScript 任务文件tasks/log_payload.ts：

// tasks/log_payload.ts import type { Task } from "graphile-worker"; const task: Task = async (payload, helpers) => { helpers.logger.info(`TypeScript task: ${JSON.stringify(payload)}`); return { success: true }; }; export default task;

通过以上步骤，你已经掌握了 Graphile Worker 的基本使用方法。更多高级功能可参考官方文档 website/docs/index.md，开始构建你的高性能任务队列系统吧！🚀

【免费下载链接】workerHigh performance Node.js/PostgreSQL job queue (also suitable for getting jobs generated by PostgreSQL triggers/functions out into a different work queue)项目地址: https://gitcode.com/gh_mirrors/wo/worker