README

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

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

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

主要功能

支持使用配置文件支持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');

也可以使用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参数传递的适当options数组来启用加密。

// 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']);

脚本命令

虽然可以在 Redis 2.6+ 上使用 Lua 脚本并通过直接使用 EVAL 和 EVALSHA 来利用 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 的贡献非常欢迎，无论是新功能、错误修复还是错误报告的形式。我们只要求你在提交更改或在问题跟踪器上提交错误报告之前遵守一系列基本规则，以便在项目上工作时更容易保持一致性。

测试套件

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

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

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

yosa / predis

维护者

详细信息