PHP Redis扩展详解

Redis 是一个开源的高性能键值存储系统，广泛应用于缓存、会话管理、实时分析等场景。PHP Redis扩展（通常称为 phpredis）是 PHP 与 Redis 进行交互的高效接口，提供了丰富的功能和优化，适用于各种复杂的应用需求。本文将全面介绍 PHP Redis 扩展，包括安装、基本使用、高级特性、配置选项、错误处理及性能优化等内容。

简介

什么是 PHP Redis 扩展？

PHP Redis 扩展（phpredis）是一个为 PHP 提供的 Redis 客户端库，通过 C 语言编写，具有高性能和丰富的功能。它支持 Redis 的大多数数据结构和命令，能够高效地与 Redis 服务器通信。

为什么选择 `phpredis`？

高性能：基于 C 语言实现，执行效率高。
丰富的功能：支持 Redis 的各种数据结构、事务、发布/订阅、管道等功能。
稳定性：经过大量生产环境验证，稳定可靠。
易用性：提供面向对象和过程化接口，使用简单直观。

安装

通过 PECL 安装

PECL 是 PHP 扩展社区库的一个分发渠道。可以使用 PECL 命令行工具来安装 phpredis 扩展。

bash 复制代码

sudo pecl install redis

安装过程中，可能会提示选择选项，通常默认即可。

通过源码安装

下载源码

bash 复制代码

git clone https://github.com/phpredis/phpredis.git
cd phpredis
git checkout stable

编译安装

bash 复制代码

phpize
./configure
make
sudo make install

启用扩展

编辑 php.ini 文件，添加以下内容：
bash 复制代码
```
extension=redis.so
```

使用 Composer 安装

虽然 phpredis 是 PHP 的一个扩展，但也有一些基于 PHP 实现的 Redis 客户端库，如 predis。如果无法安装扩展，可以考虑使用这些库。

bash 复制代码

composer require predis/predis

检查安装是否成功

在命令行中运行以下命令，检查 redis 扩展是否已加载：

bash 复制代码

php -m | grep redis

如果安装成功，应该会看到 redis 关键词。

另外，也可以创建一个 PHP 文件，调用 phpinfo() 函数查看扩展信息。

php 复制代码

<?php
phpinfo();
?>

在输出内容中搜索 redis，确认扩展已启用。

基本使用

连接 Redis 服务器

php 复制代码

<?php
// 创建 Redis 对象
$redis = new Redis();

// 连接到 Redis 服务器
$redis->connect('127.0.0.1', 6379);

// 如果 Redis 设置了密码
//$redis->auth('your_password');

// 选择数据库（默认是 0）
//$redis->select(1);
?>

基本命令操作

字符串（String）

php 复制代码

<?php
// 设置字符串
$redis->set('key', 'value');

// 获取字符串
$value = $redis->get('key');
echo $value; // 输出 'value'

// 设置带过期时间的键
$redis->setex('temp_key', 3600, 'temp_value');

// 增加计数
$redis->incr('counter');
?>

哈希（Hash）

php 复制代码

<?php
// 设置哈希字段
$redis->hSet('user:1000', 'name', 'John');
$redis->hSet('user:1000', 'age', 30);

// 获取哈希字段
$name = $redis->hGet('user:1000', 'name');
$age = $redis->hGet('user:1000', 'age');

// 获取整个哈希
$user = $redis->hGetAll('user:1000');
?>

列表（List）

php 复制代码

<?php
// 从列表左侧推入元素
$redis->lPush('mylist', 'a');
$redis->lPush('mylist', 'b');

// 从列表右侧弹出元素
$item = $redis->rPop('mylist'); // 'a'

// 获取列表范围
$items = $redis->lRange('mylist', 0, -1);
?>

集合（Set）

php 复制代码

<?php
// 添加成员到集合
$redis->sAdd('myset', 'value1');
$redis->sAdd('myset', 'value2');

// 获取集合成员
$members = $redis->sMembers('myset');

// 检查成员是否存在
$isMember = $redis->sIsMember('myset', 'value1'); // true

// 移除成员
$redis->sRem('myset', 'value1');
?>

有序集合（Sorted Set）

php 复制代码

<?php
// 添加成员到有序集合
$redis->zAdd('myzset', 1, 'one');
$redis->zAdd('myzset', 2, 'two');

// 获取有序集合成员及分数
$members = $redis->zRange('myzset', 0, -1, true);

// 获取指定分数范围的成员
$range = $redis->zRangeByScore('myzset', 1, 2);

// 移除成员
$redis->zRem('myzset', 'one');
?>

示例代码

以下是一个简单的示例，演示如何使用 phpredis 扩展进行基本操作：

php 复制代码

<?php
// 创建 Redis 对象
$redis = new Redis();

// 连接到 Redis 服务器
$redis->connect('127.0.0.1', 6379);

// 设置字符串
$redis->set('greeting', 'Hello, Redis!');

// 获取字符串
echo $redis->get('greeting'); // 输出 'Hello, Redis!'

// 操作哈希
$redis->hSet('user:1001', 'name', 'Alice');
$redis->hSet('user:1001', 'email', 'alice@example.com');

$user = $redis->hGetAll('user:1001');
print_r($user);

// 操作列表
$redis->lPush('tasks', 'task1');
$redis->lPush('tasks', 'task2');

$task = $redis->rPop('tasks');
echo "Processed: $task\n";

// 操作集合
$redis->sAdd('tags', 'php');
$redis->sAdd('tags', 'redis');

$tags = $redis->sMembers('tags');
print_r($tags);

// 操作有序集合
$redis->zAdd('leaderboard', 100, 'player1');
$redis->zAdd('leaderboard', 200, 'player2');

$topPlayers = $redis->zRange('leaderboard', 0, -1, true);
print_r($topPlayers);
?>

高级特性

事务

Redis 支持事务，允许将多个命令打包执行，保证命令的原子性。phpredis 提供了事务的相关方法。

php 复制代码

<?php
$redis->multi(); // 开启事务
$redis->set('key1', 'value1');
$redis->set('key2', 'value2');
$redis->incr('counter');
$results = $redis->exec(); // 提交事务并执行
print_r($results);
?>

如果需要取消事务，可以使用 discard() 方法。

php 复制代码

<?php
$redis->multi();
$redis->set('key', 'value');
$redis->discard(); // 取消事务
?>

发布/订阅（Pub/Sub）

Redis 提供了发布/订阅机制，允许消息的发布者和订阅者进行通信。phpredis 支持这一特性。

发布者示例：

php 复制代码

<?php
$redis = new Redis();
$redis->connect('127.0.0.1', 6379);

// 发布消息
$redis->publish('channel1', 'Hello Subscribers!');
?>

订阅者示例：

php 复制代码

<?php
$redis = new Redis();
$redis->connect('127.0.0.1', 6379);

// 订阅频道
$redis->subscribe(['channel1'], function($redis, $channel, $message) {
    echo "Received message from $channel: $message\n";
});
?>

注意：subscribe 方法是阻塞的，订阅者会持续等待消息的到来。

管道（Pipelining）

管道允许客户端一次性发送多个命令，减少网络延迟，提高性能。phpredis 提供了管道的方法。

php 复制代码

<?php
$redis = new Redis();
$redis->connect('127.0.0.1', 6379);

$redis->pipeline(function($pipe) {
    for ($i = 0; $i < 1000; $i++) {
        $pipe->set("key:$i", "value:$i");
    }
});
?>

Lua 脚本

Redis 支持在服务器端执行 Lua 脚本，phpredis 提供了相关接口。

bash 复制代码

<?php
$redis = new Redis();
$redis->connect('127.0.0.1', 6379);

$script = '
    local current = redis.call("GET", KEYS[1])
    if not current then
        redis.call("SET", KEYS[1], ARGV[1])
        return ARGV[1]
    else
        return current
    end
';

$result = $redis->eval($script, ['mykey'], 1);
echo $result;
?>

连接池

phpredis 本身不直接支持连接池，但可以结合其他工具或框架实现连接池机制，以提高性能和资源利用率。

哨兵（Sentinel）与集群（Cluster）

phpredis 支持 Redis 哨兵和集群模式，可以用于高可用和分布式部署。

哨兵示例：

php 复制代码

<?php
$redis = new Redis();
$redis->connect('127.0.0.1', 26379);

// 使用哨兵模式获取主节点
$master = $redis->sentinelGetMasterAddrByName('mymaster');
$redis->connect($master[0], $master[1]);

// 进行操作
$redis->set('key', 'value');
?>

集群示例：

php 复制代码

<?php
$redis = new RedisCluster(NULL, ['127.0.0.1:7000', '127.0.0.1:7001', '127.0.0.1:7002']);
$redis->set('key', 'value');
echo $redis->get('key');
?>

配置选项

连接选项

主机与端口
php 复制代码
```
$redis->connect('127.0.0.1', 6379);
```
持久连接

持久连接可以避免频繁建立连接，提高性能。
php 复制代码
```
$redis->pconnect('127.0.0.1', 6379);
```
超时时间

设置连接和操作的超时时间（单位：秒）。
php 复制代码
```
$redis->connect('127.0.0.1', 6379, 2.5); // 2.5秒超时
```
密码认证

如果 Redis 设置了密码，需要进行认证。
php 复制代码
```
$redis->auth('your_password');
```
选择数据库

Redis 默认有 16 个数据库（编号 0-15）。可以使用 select 方法选择数据库。
php 复制代码
```
$redis->select(1);
```

客户端配置

序列化选项

phpredis 支持多种序列化方法，如 igbinary、msgpack 等，需根据需求选择。
php 复制代码
```
// 设置序列化方法为 PHP 内置序列化
$redis->setOption(Redis::OPT_SERIALIZER, Redis::SERIALIZER_PHP);
```
前缀

可以为所有键添加前缀，避免键冲突。
php 复制代码
```
$redis->setOption(Redis::OPT_PREFIX, 'myprefix:');
```
读写分离

在哨兵或集群模式下，可以配置读写分离，提升性能。
php 复制代码
```
$redis->setOption(Redis::OPT_READ_TIMEOUT, 60);
```

客户端属性

持久化选项

设置连接是否持久化。
php 复制代码
```
$redis->setOption(Redis::OPT_PERSISTENT, true);
```

SSL 连接

如果 Redis 服务器支持 SSL，可以通过扩展进行连接。

php 复制代码

// 需要 PHP Redis 扩展编译时启用 SSL 支持
$redis->connect('rediss://127.0.0.1:6379');

PHP Redis扩展详解

目录

简介

什么是 PHP Redis 扩展？

为什么选择 phpredis？

安装

通过 PECL 安装

通过源码安装

使用 Composer 安装

检查安装是否成功

基本使用

连接 Redis 服务器

基本命令操作

字符串（String）

哈希（Hash）

列表（List）

集合（Set）

有序集合（Sorted Set）

示例代码

高级特性

事务

发布/订阅（Pub/Sub）

管道（Pipelining）

Lua 脚本

连接池

哨兵（Sentinel）与集群（Cluster）

配置选项

连接选项

客户端配置

客户端属性

为什么选择 `phpredis`？