README

A flexible and feature-complete Redis client for PHP 7.2 and newer.

注意：您正在访问 Predis 不稳定分支的 README 文件，该分支专门用于开发未来的版本。这意味着该分支上的代码可能是不稳定的，可能会在没有事先通知的情况下发生破坏性更改。不要在生产环境中使用它，使用它存在风险！

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

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

主要功能

• 支持 Redis 从 2.0 到 6.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 域套接字建立连接。
• 支持 Webdis（需要 ext-curl 和 ext-phpiredis 扩展）。
• 支持自定义连接类，以提供不同的网络或协议后端。
• 支持自定义命令和覆盖默认命令的灵活系统。

如何 安装 和使用 Predis

此库可以在 Packagist 上找到，以使用 Composer 更容易地管理项目依赖。每个版本的压缩归档都可以在 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();

连接到 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实例，而无需配置SSL代理如stunnel。这在连接到运行在各种云托管提供商上的节点时非常有用。可以通过使用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']);

脚本命令

虽然可以在 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 command factory:
$client = new Predis\Client($parameters, [
    'commands' => [
        '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
    ],
]);

客户端还可以通过指定 connections 客户端选项的描述性字符串来配置依赖于 phpiredis 后端。支持的字符串值包括：

• phpiredis-stream 将 tcp、redis 和 unix 映射到 Predis\Connection\PhiredisStreamConnection
• phpiredis-socket 将 tcp、redis 和 unix 映射到 Predis\Connection\PhiredisSocketConnection
• phpiredis 是 phpiredis-stream 的别名。

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

开发人员可以创建自己的连接类来支持全新的网络后端，扩展现有类或提供完全不同的实现。连接类必须实现 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，可以禁用集成测试。有关测试此库的详细信息，请参阅测试 README。

Predis 使用 GitHub Actions 进行持续集成，历史构建记录可以在其操作页面找到。

其他

项目相关链接

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

作者

• Daniele Alessandri (Twitter)
• Till Krüss (Twitter)

许可证

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