Predis 技术文档

一、安装指南

Predis 是一个 PHP 7.2 及以上版本的 Redis 客户端，支持从 Redis 3.0 到 7.2 的版本。以下是安装 Predis 的步骤：

1. 使用 Composer 管理项目依赖。在项目的根目录下运行以下命令安装 Predis：

composer require predis/predis

2. 确保您的 PHP 环境已经安装了 Redis 扩展。

3. 如果您不使用 Composer，可以通过下载 Predis 的发行版压缩文件并解压到项目目录中，然后手动加载 Predis 类。

require 'Predis/Autoloader.php';
Predis\Autoloader::register();

确保 Predis 的目录位于 PHP 的 include_path 中。

二、项目的使用说明

Predis 的使用非常简单，以下是一个基本的连接和使用示例：

$client = new Predis\Client();
$client->set('foo', 'bar');
$value = $client->get('foo');

Predis 支持多种连接方式，包括 TCP/IP、TLS/SSL 加密的 TCP/IP 以及 UNIX 域套接字。

连接参数

连接参数可以通过以下两种方式提供：

1. 使用命名数组：

$client = new Predis\Client([
    'scheme' => 'tcp',
    'host'   => '10.0.0.1',
    'port'   => 6379,
]);

2. 使用 URI 字符串：

$client = new Predis\Client('tcp://10.0.0.1:6379');

对于密码保护的 Redis 服务器，您需要提供 password 参数。如果 Redis 6.0 及以上版本启用了 ACL，还需要提供 username。

客户端配置

客户端配置可以通过传递特定的客户端选项到 Predis\Client::__construct() 的第二个参数来进行：

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

支持的客户端选项包括 prefix、exceptions、connections、cluster、replication、aggregate、parameters 和 commands。

三、项目 API 使用文档

Predis 提供了丰富的 API，以供用户进行 Redis 数据操作。以下是部分 API 的使用示例：

• 设置和获取键值：

$client->set('key', 'value');
$value = $client->get('key');

• 使用列表：

$client->lpush('list', 'value1');
$client->lpush('list', 'value2');
$value = $client->lrange('list', 0, -1);

• 使用集合：

$client->sadd('set', 'value1');
$client->sadd('set', 'value2');
$members = $client->smembers('set');

更多 API 使用详情，请参考官方文档。

四、项目安装方式

Predis 的安装方式主要有两种：

1. 使用 Composer：

composer require predis/predis

2. 手动下载安装：

• 从 GitHub 下载 Predis 的发行版压缩文件。
• 解压文件到项目目录中。
• 手动加载 Predis 类：

require 'Predis/Autoloader.php';
Predis\Autoloader::register();

确保 Predis 的目录位于 PHP 的 include_path 中。