Node-Zookeeper 技术文档

1. 安装指南

在开始使用 node-zookeeper 之前，您需要确保已经安装了 Node.js 环境。以下是安装 node-zookeeper 的步骤：

npm install zookeeper

请注意，在安装时需要使用小写的 zookeeper 名称。

2. 项目的使用说明

node-zookeeper 是一个基于 Apache Zookeeper 官方 C 客户端 API 实现的 Node.js 客户端。它支持 ZooKeeper 服务器版本 v3.5.x 到 v3.8.x。

创建客户端实例

const ZooKeeper = require('zookeeper');

function createClient(timeoutMs = 5000) {
    const config = {
        connect: host,
        timeout: timeoutMs,
        debug_level: ZooKeeper.constants.ZOO_LOG_LEVEL_WARN,
        host_order_deterministic: false,
    };

    return new ZooKeeper(config);
}

const client = createClient();

客户端在连接到 ZooKeeper 服务器后即可使用：

client.on('connect', () => {
    // 开始使用客户端
});

client.init(config);

创建节点

使用以下 API 创建节点：

const path = '/myPath';
try {
    const createdPath = await client.create(path, data, ZooKeeper.constants.ZOO_EPHEMERAL);

    console.log(`(已创建: ${createdPath})`);
} catch (error) {
    console.log(`${path} 已存在`);
}

更多示例代码可以在项目的 examples 文件夹中找到。

3. 项目API使用文档

以下是 node-zookeeper 项目的部分 API 文档。

异步方法 (async/await)

这些方法支持使用 async/await 语法。

• init(options)
• connect(options, connect_cb)
• close()
• path = await create(path, data, flags, ttl)
• mkdirp(path, callback(Error))
• stat = await exists(path, watch)
• [stat, string|Buffer] = await get(path, watch)
• children = await get_children(path, watch)
• [children, stat] = await get_children2(path, watch)
• stat = await set(path, data, version)
• val = await sync(path)
• delete_ (path, version)
• config = getconfig(watch)
• reconfig(joining, leaving, members, config_version)
• set_acl(path, version, acl)
• acl = await get_acl(path)
• add_auth(scheme, auth)

以及更多其他方法。

基于回调的方法

这些方法使用回调函数作为参数。

• init(options)
• connect(options, connect_cb)
• close()
• a_create(path, data, flags, path_cb)
• a_createTtl(path, data, flags, ttl, pathCb)
• mkdirp(path, callback(Error))
• a_exists(path, watch, stat_cb)
• a_get(path, watch, data_cb)
• a_get_children(path, watch, child_cb)
• a_get_children2(path, watch, child2_cb)
• a_set(path, data, version, stat_cb)
• a_sync(path, value_cb)
• a_delete_ (path, version, void_cb)
• a_getconfig(watch, data_cb)
• a_reconfig(joining, leaving, members, version, data_cb)
• a_set_acl(path, version, acl, void_cb)
• a_get_acl(path, acl_cb)
• add_auth(scheme, auth, void_cb)

以及更多其他方法。

4. 项目安装方式

项目的安装方式已在安装指南中提供，以下是简要步骤：

使用 npm 进行安装：

npm install zookeeper

确保使用 Node.js 环境，并且遵循项目提供的安装要求。在 Windows 平台上，可能还需要安装 CMake 和 Python，以及在某些情况下使用 PowerShell 执行安装命令。