README

PHP 7.2 及更高版本的一个灵活且功能齐全的 Redis 客户端。

有关此项目的更多详细信息，可以在 常见问题解答 中找到。

主要特性

• 支持 Redis 从 3.0 到 7.0。
• 支持使用客户端分片和可插拔键空间分发器的集群。
• 支持 redis-cluster (Redis >= 3.0)。
• 支持主从复制设置和 redis-sentinel。
• 使用可自定义的前缀策略透明地键前缀。
• 单节点和集群（客户端分片）上的命令流水线。
• Redis 事务（Redis >= 2.0）和 CAS 操作（Redis >= 2.2）的抽象。
• Lua 脚本（Redis >= 2.6）的抽象，并自动在 EVALSHA 或 EVAL 之间切换。
• 基于 PHP 迭代器的 SCAN、SSCAN、ZSCAN 和 HSCAN（Redis >= 2.8）的抽象。
• 连接由客户端在第一次命令时懒加载，并且可以持久化。
• 可以通过 TCP/IP（也包括 TLS/SSL 加密）或 UNIX 域套接字建立连接。
• 支持自定义连接类，以提供不同的网络或协议后端。
• 灵活的系统用于定义自定义命令和覆盖默认命令。

如何 安装 和使用 Predis

此库可以在 Packagist 上找到，以便使用 Composer 更容易地管理项目依赖关系。每个版本的压缩归档都可以在 GitHub 上找到。

composer require predis/predis

加载库

Predis 依赖于 PHP 的自动加载功能，在需要时加载其文件，并符合 PSR-4 标准。当通过 Composer 管理依赖关系时，自动加载会自动处理，但在没有自动加载功能的项目或脚本中也可以利用其自己的加载器。

// Prepend a base path if Predis is not available in your "include_path".
require 'Predis/Autoloader.php';

Predis\Autoloader::register();

连接到 Redis

在创建客户端实例而不传递任何连接参数时，Predis 假设默认主机为 127.0.0.1 和端口为 6379。默认的 connect() 操作超时时间为 5 秒。

$client = new Predis\Client();
$client->set('foo', 'bar');
$value = $client->get('foo');

连接参数可以以 URI 字符串或命名数组的形式提供。后者是提供参数的首选方式，但 URI 字符串在从非结构化或部分结构化的来源读取参数时可能很有用。

// Parameters passed using a named array:
$client = new Predis\Client([
    'scheme' => 'tcp',
    'host'   => '10.0.0.1',
    'port'   => 6379,
]);

// Same set of parameters, passed using an URI string:
$client = new Predis\Client('tcp://10.0.0.1:6379');

可以通过将 password 添加到参数集中来访问受密码保护的服务器。当 Redis >= 6.0 上启用了 ACL 时，用户认证需要 username 和 password。

还可以使用 UNIX 域套接字连接到本地 Redis 实例，在这种情况下，参数必须使用 unix 方案，并指定套接字文件的路径。

$client = new Predis\Client(['scheme' => 'unix', 'path' => '/path/to/redis.sock']);
$client = new Predis\Client('unix:/path/to/redis.sock');

客户端可以利用TLS/SSL加密连接到安全的远程Redis实例，无需配置stunnel等SSL代理。这在连接到运行在各种云托管提供商上的节点时非常有用。可以通过使用tls方案和一个通过ssl参数传递的合适选项数组来启用加密。

// Named array of connection parameters:
$client = new Predis\Client([
  'scheme' => 'tls',
  'ssl'    => ['cafile' => 'private.pem', 'verify_peer' => true],
]);

// Same set of parameters, but using an URI string:
$client = new Predis\Client('tls://127.0.0.1?ssl[cafile]=private.pem&ssl[verify_peer]=1');

还支持连接方案redis（tcp的别名）和rediss（tls的别名），它们之间的区别在于包含这些方案的URI字符串的解析遵循它们各自的IANA临时注册文档中描述的规则。

支持的实际连接参数列表可能因每个连接后端而异，因此建议参考它们的特定文档或实现以获取详细信息。

Predis在提供连接参数数组以及适当的选项来指导客户端如何聚合它们（集群、复制或自定义聚合逻辑）时可以聚合多个连接。在为每个节点提供配置时，可以混合命名数组和URI字符串。

$client = new Predis\Client([
    'tcp://10.0.0.1?alias=first-node', ['host' => '10.0.0.2', 'alias' => 'second-node'],
], [
    'cluster' => 'predis',
]);

有关更多详细信息，请参阅本文件的聚合连接部分。

连接到Redis是延迟的，这意味着只有在需要时客户端才会连接到服务器。虽然建议让客户端在幕后自行处理，但有时仍希望控制连接何时打开或关闭：这可以通过调用$client->connect()和$client->disconnect()轻松实现。请注意，这些方法对聚合连接的影响可能因具体实现而异。

客户端配置

可以通过向Predis\Client::__construct()的第二个参数传递特定的客户端选项来配置客户端的许多方面和行为。

$client = new Predis\Client($parameters, ['prefix' => 'sample:']);

选项通过一个类似于DI容器的迷你容器进行管理，并且其值只有在需要时才进行懒加载初始化。Predis默认支持的客户端选项包括

• prefix：应用于命令中找到的每个键的前缀字符串。
• exceptions：客户端在Redis错误时应抛出或返回响应。
• connections：连接后端列表或连接工厂实例。
• cluster：指定集群后端（predis、redis或可调用对象）。
• replication：指定复制后端（predis、sentinel或可调用对象）。
• aggregate：使用自定义聚合连接（可调用对象）配置客户端。
• parameters：聚合连接的默认连接参数列表。
• commands：指定要通过库使用的命令工厂实例。

用户还可以提供自定义选项和值或可调用对象（用于懒加载初始化），这些选项存储在选项容器中，以便稍后通过库使用。

聚合连接

聚合连接是Predis实现集群和复制的基础，它们用于将多个连接分组到单个Redis节点，并隐藏根据上下文正确处理它们所需的具体逻辑。聚合连接通常在创建新客户端实例时需要一个连接参数数组以及适当的客户端选项。

集群

Predis可以被配置为以传统的客户端分片方法在集群模式下工作，创建一个独立的节点集群并将键空间分配给它们。这种方法需要节点的外部健康监控，并在节点添加或删除时需要手动重新平衡键空间。

$parameters = ['tcp://10.0.0.1', 'tcp://10.0.0.2', 'tcp://10.0.0.3'];
$options    = ['cluster' => 'predis'];

$client = new Predis\Client($parameters);

随着Redis 3.0的推出，引入了一种新型的监督和协调集群类型，称为redis-cluster。这种方法使用不同的算法来分配键空间，Redis节点通过Gossip协议进行通信，以处理健康状态、重新平衡、节点发现和请求重定向。为了连接到由redis-cluster管理的集群，客户端需要一个节点列表（不一定是完整的，因为它将自动发现新节点），并将cluster客户端选项设置为redis

$parameters = ['tcp://10.0.0.1', 'tcp://10.0.0.2', 'tcp://10.0.0.3'];
$options    = ['cluster' => 'redis'];

$client = new Predis\Client($parameters, $options);

复制

客户端可以配置为在单个主节点/多个从节点设置下运行，以提供更好的服务可用性。当使用复制时，Predis识别只读命令并将它们发送到随机从节点，以提供某种形式的负载均衡，并在检测到任何可能修改键空间或键值的值的操作时切换到主节点。当从节点失败时，客户端会尝试回退到配置中提供的其他从节点。

在复制模式下使用客户端所需的基本配置需要一个Redis服务器被标识为主节点（可以通过设置role参数为master来通过连接参数完成），以及一个或多个从节点（在这种情况下，将role设置为slave对于从节点是可选的）

$parameters = ['tcp://10.0.0.1?role=master', 'tcp://10.0.0.2', 'tcp://10.0.0.3'];
$options    = ['replication' => 'predis'];

$client = new Predis\Client($parameters, $options);

上述配置具有静态的服务器列表，完全依赖于客户端的逻辑，但可以通过依赖redis-sentinel来使用更健壮的HA环境，sentinel服务器作为客户端服务发现的主权来源。客户端与redis-sentinel一起工作所需的最小配置是一个连接参数列表，指向一组sentinel实例，将replication选项设置为sentinel，并将service选项设置为服务的名称

$sentinels = ['tcp://10.0.0.1', 'tcp://10.0.0.2', 'tcp://10.0.0.3'];
$options   = ['replication' => 'sentinel', 'service' => 'mymaster'];

$client = new Predis\Client($sentinels, $options);

如果主节点和从节点配置为要求客户端进行身份验证，则必须通过全局parameters客户端选项提供密码。此选项还可以用于指定不同的数据库索引。客户端选项数组将如下所示

$options = [
    'replication' => 'sentinel',
    'service' => 'mymaster',
    'parameters' => [
        'password' => $secretpassword,
        'database' => 10,
    ],
];

尽管Predis能够区分执行写操作和只读操作的命令，但EVAL和EVALSHA代表了客户端切换到主节点的特殊情况，因为它无法判断Lua脚本何时可以在从节点上安全执行。虽然这是默认行为，但某些Lua脚本不执行写操作时，可以提供提示告诉客户端在从节点上执行

$parameters = ['tcp://10.0.0.1?role=master', 'tcp://10.0.0.2', 'tcp://10.0.0.3'];
$options    = ['replication' => function () {
    // Set scripts that won't trigger a switch from a slave to the master node.
    $strategy = new Predis\Replication\ReplicationStrategy();
    $strategy->setScriptReadOnly($LUA_SCRIPT);

    return new Predis\Connection\Replication\MasterSlaveReplication($strategy);
}];

$client = new Predis\Client($parameters, $options);
$client->eval($LUA_SCRIPT, 0);             // Sticks to slave using `eval`...
$client->evalsha(sha1($LUA_SCRIPT), 0);    // ... and `evalsha`, too.

examples目录包含一些脚本，演示了如何配置和使用客户端在基本和复杂场景中利用复制。

命令管道

管道可以帮助提高性能，当需要向服务器发送许多命令时，可以减少网络往返时延。管道还适用于聚合连接。客户端可以在可调用的块中执行管道，或返回一个具有链式命令能力的管道实例，这得益于其流畅的接口

// Executes a pipeline inside the given callable block:
$responses = $client->pipeline(function ($pipe) {
    for ($i = 0; $i < 1000; $i++) {
        $pipe->set("key:$i", str_pad($i, 4, '0', 0));
        $pipe->get("key:$i");
    }
});

// Returns a pipeline that can be chained thanks to its fluent interface:
$responses = $client->pipeline()->set('foo', 'bar')->get('foo')->execute();

事务

客户端提供了基于MULTI和EXEC的Redis事务抽象，其接口类似于命令管道

// Executes a transaction inside the given callable block:
$responses = $client->transaction(function ($tx) {
    $tx->set('foo', 'bar');
    $tx->get('foo');
});

// Returns a transaction that can be chained thanks to its fluent interface:
$responses = $client->transaction()->set('foo', 'bar')->get('foo')->execute();

这种抽象可以通过WATCH和UNWATCH执行检查和设置操作，并提供在WATCH键被触摸时自动重试由Redis中止的事务。有关使用CAS的事务示例，请参阅以下示例。

添加新命令

尽管我们努力更新Predis以保持与Redis中所有可用命令同步，但您可能更喜欢坚持使用库的旧版本或提供不同的方式来过滤特定命令的参数或解析响应。为了实现这一点，Predis提供了实现新命令类的能力，用于在客户端使用的默认命令工厂中定义或覆盖命令。

// Define a new command by extending Predis\Command\Command:
class BrandNewRedisCommand extends Predis\Command\Command
{
    public function getId()
    {
        return 'NEWCMD';
    }
}

// Inject your command in the current command factory:
$client = new Predis\Client($parameters, [
    'commands' => [
        'newcmd' => 'BrandNewRedisCommand',
    ],
]);

$response = $client->newcmd();

还有一种方法可以发送未经过滤参数或解析响应的原始命令。用户必须以数组的形式提供命令的参数列表，遵循Redis命令文档中定义的签名。

$response = $client->executeRaw(['SET', 'foo', 'bar']);

脚本命令

虽然可以使用Lua脚本Lua scripting在Redis 2.6+上直接使用EVAL和EVALSHA进行利用，但Predis提供了脚本命令作为构建在它们之上的更高级抽象，以简化事物。脚本命令可以注册到客户端使用的命令工厂中，并可以像普通Redis命令一样访问，但它们定义了要传输到服务器进行远程执行的Lua脚本。内部它们默认使用EVALSHA并使用脚本的SHA1哈希值来识别脚本以节省带宽，但在需要时使用EVAL作为后备。

// Define a new script command by extending Predis\Command\ScriptCommand:
class ListPushRandomValue extends Predis\Command\ScriptCommand
{
    public function getKeysCount()
    {
        return 1;
    }

    public function getScript()
    {
        return <<<LUA
math.randomseed(ARGV[1])
local rnd = tostring(math.random())
redis.call('lpush', KEYS[1], rnd)
return rnd
LUA;
    }
}

// Inject the script command in the current command factory:
$client = new Predis\Client($parameters, [
    'commands' => [
        'lpushrand' => 'ListPushRandomValue',
    ],
]);

$response = $client->lpushrand('random_values', $seed = mt_rand());

可定制的连接后端

Predis可以使用不同的连接后端来连接到Redis。内置的Relay集成利用了Relay扩展，通过在PHP共享运行时内存中缓存Redis数据集的部分副本，实现了主要性能提升。

$client = new Predis\Client('tcp://127.0.0.1', [
    'connections' => 'relay',
]);

开发人员可以创建自己的连接类来支持全新的网络后端，扩展现有类或提供完全不同的实现。连接类必须实现Predis\Connection\NodeConnectionInterface或扩展Predis\Connection\AbstractConnection。

class MyConnectionClass implements Predis\Connection\NodeConnectionInterface
{
    // Implementation goes here...
}

// Use MyConnectionClass to handle connections for the `tcp` scheme:
$client = new Predis\Client('tcp://127.0.0.1', [
    'connections' => ['tcp' => 'MyConnectionClass'],
]);

有关创建新连接后端的更深入见解，您可以参考Predis\Connection命名空间中可用的标准连接类的实际实现。

开发

报告错误和贡献代码

对Predis的贡献无论是以新功能、错误修复或仅仅是错误报告的形式都受到高度赞赏。我们只要求您遵守问题和拉取请求模板。

测试套件

注意：切勿在生产环境中的Redis实例或包含您感兴趣的数据的实例上运行Predis提供的测试套件！

Predis有一个涵盖库各个方面的全面测试套件，并且可以选择对正在运行的Redis实例执行集成测试（需要> = 2.4.0以验证每个命令实现的正确行为。对于不受支持的Redis命令的集成测试将自动跳过。如果您没有运行Redis，可以禁用集成测试。有关测试此库的更多详细信息，请参阅测试README。

Predis使用GitHub Actions进行持续集成，过去和当前的构建历史可以在其操作页面找到。

许可协议

Predis的代码在MIT许可协议的条款下分发（请参阅LICENSE）。