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）的抽象。
对Lua脚本（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上启用了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'],
]);

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

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来使用更健壮的高可用环境，其中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的贡献非常受欢迎，无论是以新功能、错误修复或仅错误报告的形式的pull request。我们只要求您在提交更改或向问题跟踪器提交错误报告之前，遵守一组基本规则，以便使每个人在项目开发中保持一致性。

测试套件

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

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

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

saredis / predis_with_proxy

维护者

详细信息