Camunda 外部任务客户端 JS 版本安装与使用指南

Camunda 外部任务客户端 JS 版本安装与使用指南

camunda-external-task-client-jsImplement your BPMN Service Task in NodeJS.项目地址:https://gitcode.com/gh_mirrors/ca/camunda-external-task-client-js

目录结构及介绍

当您克隆或下载 camunda-external-task-client-js 项目后，其根目录下主要包含以下文件和目录：

• .github: 包含了持续集成（CI）设置以及仓库的一些自动化工作流程定义。
• examples: 此目录中包含了几个示例脚本，展示了如何使用该库来订阅外部任务并处理它们。
• index.js: 这是包的主要入口点，其中导出了所有对外公开的功能。
• README.md: 提供了关于该项目的基本信息和快速入门指导。
• test: 测试相关的代码和数据存放于此，帮助确保代码质量和功能的正确性。

启动文件介绍

在 camunda-external-task-client-js 中，没有一个特定的“启动”文件，因为这个库通常是作为其他应用的一部分被引入的。然而，在 examples 文件夹下的每一个 .js 文件都可以被视为一个演示性的“启动”文件。例如，simple-worker.js 展示了如何创建一个 Worker 来监听外部任务。具体来说，你可以参考以下步骤初始化和运行示例中的 worker:

初始化环境

首先，你需要安装必要的依赖项：

npm install camunda-external-task-client-js

或者如果你使用的是 Yarn:

yarn add camunda-external-task-client-js

创建并运行Worker

接下来，参照 examples/simple-worker.js ，可以创建一个新的文件并在其中实现你的业务逻辑。在这个文件中，你需要导入 Client 和可能需要的其他工具类，然后实例化 Client 并调用 subscribe 方法来绑定到特定主题的外部任务上。

// 引入外部任务客户端
const { Client } = require('camunda-external-task-client-js');

// 配置客户端
const config = {
    baseUrl: 'http://your-camunda-engine-url:port',
};

// 实例化客户端
const client = new Client(config);

// 订阅到名为 'creditScoreChecker' 的话题
client.subscribe('creditScoreChecker', async (task, taskService) => {
    try {
        // 在此处添加处理任务的业务逻辑...
        
        await taskService.complete({ variables: {} });
    } catch (error) {
        console.error(error);
        await taskService.failure({ errorMessage: error.message });
    }
});

最后，通过命令行执行该文件即可运行 worker。

node path/to/your/script.js

配置文件介绍

虽然 camunda-external-task-client-js 不强制要求使用配置文件，但可以通过构造函数传入一个配置对象来初始化 Client 类。此配置对象可以包括如下的关键属性：

• baseUrl (必需): 连接到 Camunda 引擎的基础 URL，通常形如 http(s)://hostname:port/engine-rest。
• use (可选): 可以指定中间件，如日志记录器等，这有助于调试和监控。

此外，客户端还提供了多个方法用于处理外部任务，比如 lock, complete, failure, revoke 等，这些操作的参数可以在实际业务需求的基础上灵活定制。

以上就是 camunda-external-task-client-js 的基本目录结构、启动文件的概述以及配置方式的简介，希望对您有所帮助！

如果您有更深入的需求或疑问，建议查看官方文档或查阅源代码库获取更多信息。

camunda-external-task-client-jsImplement your BPMN Service Task in NodeJS.项目地址:https://gitcode.com/gh_mirrors/ca/camunda-external-task-client-js