Moxi 项目技术文档

1. 安装指南

依赖项

在安装 Moxi 之前，需要确保系统中已经安装了以下依赖项：

• libevent：用于事件处理。
• libconflate：用于配置管理。
• libvbucket：用于 vBucket 管理（可选，如果使用 libmemcached 替代 libvbucket，则不需要）。
• libmemcached：用于一致性哈希（可选，替代 libvbucket）。

编译与安装

1. 获取 Moxi 源代码。
2. 运行以下命令进行编译：

   ./config/autorun.sh
   ./configure
   make
   

   如果 libevent 安装在非标准路径（如 /opt/local），则需要指定路径：

   ./config/autorun.sh
   ./configure --with-libevent=/opt/local
   make
   

3. 编译完成后，Moxi 可执行文件将生成在当前目录下。

2. 项目的使用说明

启动 Moxi

Moxi 可以通过命令行启动，支持多种配置方式：

通过 REST/HTTP 服务器加载 vBucket 配置

moxi http://host:port/url/of/vBucketServerMapJSON

例如，针对 NorthScale 服务器：

moxi http://host:8080/pools/default/bucketsStreamingConfig/default

通过配置文件加载 vBucket 配置

创建一个配置文件（如 vbucket1.cfg），内容如下：

11211 = {
  "hashAlgorithm": "CRC",
  "numReplicas": 0,
  "serverList": ["memcached_svr1:11311"],
  "vBucketMap":
    [
      [0],
      [0]
    ]
}

启动 Moxi 时指定配置文件：

moxi -z ./vbucket1.cfg

获取命令行帮助

moxi -h

3. 项目API使用文档

命令行参数

• -z url=http://host:port/url/of/vBucketServerMap.json：指定 vBucket 配置的 URL。
• -z ./vbucket1.cfg：指定 vBucket 配置文件。
• -h：显示帮助信息。

配置文件格式

配置文件是一个 JSON 格式的文件，包含以下字段：

• hashAlgorithm：哈希算法。
• numReplicas：副本数量。
• serverList：后端 memcached 服务器列表。
• vBucketMap：vBucket 映射表。

4. 项目安装方式

通过源码编译安装

1. 下载 Moxi 源码。
2. 安装依赖项。
3. 运行以下命令进行编译：

   ./config/autorun.sh
   ./configure
   make
   

4. 编译完成后，Moxi 可执行文件生成在当前目录下。

使用 libmemcached 替代 libvbucket

如果需要使用 libmemcached 替代 libvbucket，可以在编译时进行如下配置：

./configure --enable-moxi-vbucket=no \
   CFLAGS=<libmemcached/include> \
   LDFLAGS=<libmemcahed/lib>

启动与测试

编译完成后，可以通过以下命令启动 Moxi 并进行测试：

moxi -z 11211=memcached_1:11211,memcached_2:11211

测试命令：

make test
./t/moxi.pl

通过以上步骤，您可以顺利安装、配置和使用 Moxi 项目。