README

PHP >= 5.3 和 HHVM >= 2.3.0 的灵活且功能齐全的 Redis 客户端。

Predis 默认不需要任何额外的 C 扩展，但可以选择与 phpiredis 配对，以降低 Redis RESP 协议 的序列化和解析开销。对于客户端的 实验性 异步实现，您可以参考 Predis\Async。

有关此项目的更多详细信息，请参阅 常见问题解答。

由于原始项目 Predis 已停止维护，因此本项目是它的分支。

主要功能

• 使用配置文件支持 Redis 的不同版本（从 2.0 到 3.2）。
• 支持使用客户端分片和可插拔的键空间分发程序进行集群。
• 支持 redis-cluster（Redis >= 3.0）。
• 支持主从复制设置和 redis-sentinel。
• 使用可自定义的前缀策略透明地对键进行前缀。
• 在单个节点和集群（仅客户端分片）上执行命令管道。
• Redis 事务（Redis >= 2.0）和 CAS 操作（Redis >= 2.2）的抽象。
• Redis 脚本（Redis >= 2.6）的抽象，并自动在 EVALSHA 或 EVAL 之间切换。
• 基于 PHP 迭代器的 SCAN、SSCAN、ZSCAN 和 HSCAN（Redis >= 2.8）的抽象。
• 客户端在首次命令时建立连接，并且可以持久化。
• 可以通过 TCP/IP（也可通过 TLS/SSL 加密）或 UNIX 域套接字建立连接。
• 支持 Webdis（需要 ext-curl 和 ext-phpiredis）。
• 支持自定义连接类，以提供不同的网络或协议后端。
• 灵活的系统，用于定义自定义命令和配置文件，并覆盖默认值。

如何 安装 和使用 Predis

此库可在 Packagist 上找到，以便通过 Composer 或压缩归档来更轻松地管理项目的依赖关系。

加载库

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();

也可以通过运行 bin/create-phar 脚本来直接从仓库创建 phar 归档。生成的 phar 已经包含定义其自身自动加载器的 stub，因此您只需通过 require() 来启动使用库。

连接到 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');

也可以使用 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'],
]);

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

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

客户端配置

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

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

选项通过一个类似 DI 的容器来管理，并且它们的值仅在需要时才会懒加载。Predis 默认支持的客户端选项包括：

• profile：指定用于匹配特定 Redis 版本的配置文件。
• prefix：自动应用到命令中找到的键的前缀字符串。
• exceptions：客户端在 Redis 错误时是抛出异常还是返回响应。
• connections：连接后端列表或连接工厂实例。
• cluster：指定集群后端（predis、redis 或可调用对象）。
• replication：指定复制后端（TRUE、sentinel 或可调用对象）。
• aggregate：覆盖 cluster 和 replication 以提供自定义连接聚合器。
• parameters：聚合连接的默认连接参数列表。

用户还可以提供带有值或可调用的对象（用于懒加载）的自定义选项，这些选项存储在选项容器中，供库稍后使用。

聚合连接

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

集群

默认情况下，当没有设置特定的客户端选项，并且向客户端构造函数传递一个连接参数数组时，Predis会配置自身以集群模式工作，使用传统的客户端分片方法创建一个独立节点的集群，并在它们之间分配key空间。这种方法需要某种形式的节点外部健康监控，并在更改配置（通过添加或删除节点）时需要手动操作来重新平衡key空间。

$parameters = ['tcp://10.0.0.1', 'tcp://10.0.0.2', 'tcp://10.0.0.3'];

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

随着Redis 3.0的推出，一种新的监督和协调式的集群以redis-cluster的形式被引入。这种方法使用不同的算法来分配key空间，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识别只读命令并将它们发送到随机从节点，以提供某种类型的负载均衡。一旦检测到执行任何可能最终修改key空间或键值的操作的命令，它就会切换到主节点。当从节点失败时，客户端尝试在配置中提供的不同从节点之间回退到不同的从节点。

使用客户端在复制模式下所需的配置需要识别一个Redis服务器作为主节点（这可以通过连接参数完成，使用alias参数设置为master），以及一个或多个作为从节点的服务器。

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

$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?alias=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\Aggregate\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 profile:
$client = new Predis\Client();
$client->getProfile()->defineCommand('newcmd', 'BrandNewRedisCommand');

$response = $client->newcmd();

还有一个方法可以发送原始命令，不对其参数进行过滤或解析响应。用户必须提供命令参数的数组，遵循Redis命令文档中定义的签名。

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

脚本命令

虽然可以在Redis 2.6+上使用Lua脚本（通过直接使用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 profile:
$client = new Predis\Client();
$client->getProfile()->defineCommand('lpushrand', 'ListPushRandomValue');

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

可定制连接后端

Predis可以使用不同的连接后端连接到Redis。其中两个利用第三方扩展，如phpiredis，在处理大型多批量响应时带来重大性能提升。其中一个是基于PHP流，另一个是基于由ext-socket提供的套接字资源。两者都支持TCP/IP和UNIX域套接字。

$client = new Predis\Client('tcp://127.0.0.1', [
    'connections' => [
        'tcp'  => 'Predis\Connection\PhpiredisStreamConnection',  // PHP stream resources
        'unix' => 'Predis\Connection\PhpiredisSocketConnection',  // ext-socket resources
    ],
]);

开发人员可以创建自己的连接类来支持全新的网络后端，扩展现有类或提供完全不同的实现。连接类必须实现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，可以禁用集成测试。默认情况下，测试套件配置为使用 Redis 3.2（当前稳定版本）的配置文件来执行集成测试，但可以通过修改 phpunit.xml 并将 REDIS_SERVER_VERSION 设置为 dev 来选择构建自 unstable 分支的 Redis 实例。有关测试 Predis 的更多信息，请参阅测试 README。

Predis 使用 Travis CI 进行持续集成，过去和当前的构建历史可以在其项目页面上找到。

其他

项目相关链接

• 源代码
• Wiki
• 问题跟踪器

作者

• Daniele Alessandri (twitter)
• Benedikt Lenzen

许可证

Predis 的代码在 MIT 许可证的条款下分发（见LICENSE）。