Node.js Beanstalk 客户端技术文档

2024-12-16 13:51:31作者：虞亚竹Luna

nodestalker是一个基于Node.js的Beanstalk客户端工具，专为追求高效队列处理而生，兼容Beanstalkd 1.4.6版本。这款开源宝藏简化了与高性能消息队列的交互，确保你的应用流畅地管理和执行任务。通过单一socket连接实现命令发送与状态响应的无缝对接，保留了watch和ignore设置的上下文。想要并发处理多个任务？多socket策略配合异步调用是关键，即便在处理密集型任务时也能保持应用灵动。内含详尽文档与测试套件，确保稳定可靠。感谢js-yaml背后团队及社区贡献者的一路支持，让nodestalker成为你解决后台任务调度的强大助手。立即拥抱它，解锁 Node.js 应用中的队列管理新境界！

项目地址：https://gitcode.com/gh_mirrors/no/nodestalker

本文档旨在帮助用户安装和使用 nodestalker，一个基于 Node.js 开发的 Beanstalk 客户端。以下为安装指南、使用说明以及项目 API 使用文档。

1. 安装指南

首先，确保您的环境中已安装了 Node.js。然后，使用以下命令安装 nodestalker：

npm install nodestalker

2. 项目使用说明

以下是一个简单的使用示例：

var bs = require('nodestalker'),
    client = bs.Client('127.0.0.1:11300');

client.use('default').onSuccess(function(data) {
    console.log(data);

    client.put('my job').onSuccess(function(data) {
        console.log(data);
        client.disconnect();
    });
});

如何预留多个任务？

每个客户端基本上代表一个打开的 socket 连接到 Beanstalkd。每个命令调用只是将一个命令放入该 socket，然后期望有一个相应的返回。

服务器应该维护 socket 的状态。然而，reserve（或带超时的 reserve）只会拉取一个任务。然后您可以在同一个 socket 上再次调用 reserve，服务器会保持 watch 和 ignore 的状态。

以下是一个最常见的使用场景：

var bs = require('nodestalker'),
    client = bs.Client('127.0.0.1:11300'),
    tube = 'test_tube';

client.watch(tube).onSuccess(function(data) {
    function resJob() {
        client.reserve().onSuccess(function(job) {
            console.log('reserved', job);

            client.deleteJob(job.id).onSuccess(function(del_msg) {
                console.log('deleted', job);
                console.log('message', del_msg);
                resJob();
            });
        });
    }

    resJob();
});

如果您想以完全异步的方式执行此操作（因为在其他情况下会有阻塞的过程发生），您需要使用多个 sockets。这意味着您需要在每个 socket 上重复 watch 和 ignore 命令。

var bs = require('nodestalker'),
    tube = 'test_tube';

function processJob(job, callback) {
    // 执行一些耗时的操作
    console.log('processing...');
    setTimeout(function() {
        callback();
    }, 1000);
}

function resJob() {
    var client = bs.Client('127.0.0.1:11300');

    client.watch(tube).onSuccess(function(data) {
        client.reserve().onSuccess(function(job) {
            console.log('received job:', job);
            resJob();

            processJob(job, function() {
                client.deleteJob(job.id).onSuccess(function(del_msg) {
                    console.log('deleted', job);
                    console.log(del_msg);
                    client.disconnect();
                });
                console.log('processed', job);
            });
        });
    });
}

resJob();