Flexihash 技术文档

1. 安装指南

Flexihash 是一个用于实现一致性哈希的小型 PHP 库，适用于分布式缓存场景。推荐使用 Composer 进行安装。

使用 Composer 安装

1. 确保你已经安装了 Composer。如果尚未安装，请参考 Composer 官方文档 进行安装。

2. 在项目根目录下运行以下命令进行安装：

   composer require flexihash/flexihash
   

3. 或者，你也可以在 composer.json 文件中添加以下内容，然后运行 composer install：

   {
       "require": {
           "flexihash/flexihash": "^3.0.0"
       }
   }
   

2. 项目的使用说明

Flexihash 库的主要功能是实现一致性哈希，用于在分布式缓存系统中将数据均匀分布到多个缓存节点上。以下是基本的使用示例：

初始化 Flexihash

$hash = new Flexihash();

添加目标节点

你可以一次性添加多个目标节点：

$hash->addTargets(['cache-1', 'cache-2', 'cache-3']);

查找目标节点

通过 lookup 方法查找某个对象应该存储在哪个节点上：

$hash->lookup('object-a'); // 返回 "cache-1"
$hash->lookup('object-b'); // 返回 "cache-2"

添加和删除节点

你可以动态添加或删除节点：

$hash->addTarget('cache-4');
$hash->removeTarget('cache-1');

查找多个备选节点

通过 lookupList 方法查找多个备选节点，适用于冗余写入场景：

$hash->lookupList('object', 2); // 返回 ["cache-2", "cache-4"]

删除节点后的重新查找

删除某个节点后，对象会被重新分配到其他节点：

$hash->removeTarget('cache-2');
$hash->lookup('object'); // 返回 "cache-4"

3. 项目 API 使用文档

Flexihash 类

• __construct(): 初始化 Flexihash 实例。
• addTarget($target): 添加单个目标节点。
• addTargets($targets): 批量添加多个目标节点。
• removeTarget($target): 删除单个目标节点。
• lookup($resource): 查找某个资源对应的目标节点。
• lookupList($resource, $requestedCount): 查找某个资源对应的多个备选节点。

4. 项目安装方式

Flexihash 的安装方式非常简单，推荐使用 Composer 进行安装。具体步骤如下：

1. 安装 Composer。
2. 在项目根目录下运行以下命令：

   composer require flexihash/flexihash
   

3. 或者在 composer.json 文件中添加依赖：

   {
       "require": {
           "flexihash/flexihash": "^3.0.0"
       }
   }
   

4. 运行 composer install 完成安装。

通过以上步骤，你就可以成功安装并使用 Flexihash 库来实现一致性哈希功能。