README

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

Predis 默认不要求任何额外的 C 扩展，但可以选择与 phpiredis 配对，以降低 Redis RESP 协议的序列化和解析开销。

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

主要功能

• 通过配置文件支持不同版本的 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 管理项目依赖项，或在我们的 自己的 PEAR 频道 上找到，以使用 PEAR 进行更传统的安装。最终，每个版本的压缩存档都可在 GitHub 上找到。

加载库

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 已经包含一个定义其自己的自动加载器的存根，因此您只需使用 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');

可以通过在参数集中添加password来访问受密码保护的服务器。当Redis >= 6.0开启ACLs时，用户认证需要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'],
]);

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

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将配置自身以在集群模式下工作，使用传统的客户端分片方法创建独立节点的集群，并将键空间分配给它们。这种方法需要某种形式的外部节点健康监控，并且在更改配置（通过添加或删除节点）时需要手动操作以重新平衡键空间。

$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的形式被引入。这种方法的算法不同，用于分配键空间，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服务器被标识为主节点（这可以通过使用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']);

脚本命令

尽管可以直接使用EVAL和EVALSHA在Redis 2.6+上利用Lua脚本，但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 的贡献，无论是以新功能、错误修复还是仅仅错误报告的形式，都高度受到欢迎。我们只要求您在提交更改或在问题跟踪器上提交错误之前，遵守一套基本规则，以便在项目中保持一致性。

测试套件

注意：请勿在生产环境中运行 Predis 附带的测试套件，或运行包含您感兴趣的数据的 Redis 实例！

Predis 拥有一个全面的测试套件，涵盖库的各个方面。此测试套件对 Redis 运行实例（需要 >= 2.4.0）进行集成测试，以验证每个命令实现的正确性，并自动跳过指定 Redis 配置文件中未定义的命令。如果您没有运行 Redis，可以禁用集成测试。默认情况下，测试套件配置为使用 Redis 3.2（Redis 的当前稳定版本）的配置文件执行集成测试，但可以通过修改 phpunit.xml 并将 REDIS_SERVER_VERSION 设置为 dev 来选择性地针对从 unstable 分支构建的 Redis 实例。有关 Predis 测试的更详细信息，请参阅测试 README。

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

其他

项目相关链接

• 源代码
• Wiki
• 问题跟踪器
• PEAR 频道

作者

• Daniele Alessandri (twitter)

许可证

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