PHP实现的Redis操作通用类示例

这篇文章将会深入解读PHP中的Redis操作通用类，并附上相关实例，帮助你更全面地理解其应用和操作。我们将会关注Redis的PHP操作类库，特别是在PHP中实现Redis连接、队列、集合、hash表和事务等方面的操作技巧。如果你是对这方面感兴趣的朋友，那么下面的内容将会为你提供有价值的参考。

让我们来看一下这个Redis操作类的基本结构和功能。这个类的主要作用是进行Redis操作，包括连接、认证、选择数据库等。在实例化对象时，我们可以设置连接的属性，如超时时间、选择的数据库等。这个类还具备自动重新连接的功能，如果连接超时，将会重新建立一个连接。

接下来，我们来看一下如何使用这个类进行Redis操作。我们需要通过`getInstance`方法获取实例化的对象。这个方法接受两个参数，一个是配置信息，另一个是连接属性。然后，我们就可以使用这个对象进行各种Redis操作了。

在Redis操作中，常见的操作包括连接、队列、集合、hash表和事务等。这个类库为我们提供了丰富的操作方法，我们可以使用这些方法来执行各种操作。例如，我们可以使用`connect`方法连接Redis服务器，使用`queue`方法进行队列操作，使用`set`和`get`方法进行hash表和集合操作等。我们还可以使用`auth`方法进行权限认证，选择特定的数据库等。

这个类库的设计非常灵活，我们可以根据需要进行定制和扩展。它还具备很好的性能和稳定性，可以满足大部分应用场景的需求。如果你正在寻找一个简单易用的Redis操作类库，那么这个类库将会是一个不错的选择。

在代码世界中，我们经常会遇到数据库交互的场景，尤其是当使用Redis这样的内存数据库时。以下是关于如何操作Redis中的哈希表的类方法描述。

该类拥有一个聪明的实例化策略。如果数据库实例尚未过期或已经开启对应的数据库连接，它将复用已存在的实例。否则，它将创建一个新的实例并连接到指定的数据库。这是通过检查时间戳和实例的过期时间来实现的。如果数据库ID不为零，还会选择相应的数据库。这是为了确保资源的高效利用和避免不必要的连接开销。

接下来，让我们看看如何使用此类与Redis进行交互：

当你需要执行原生的Redis操作时，可以通过`getRedis()`方法获取Redis实例。这样你就可以调用Redis的所有原生方法了。

对于哈希表操作，这个类提供了一系列的方法。例如：

`hGet`方法允许你获取哈希表中指定字段的值。只需提供缓存的key和字段名即可。

`hSet`方法允许你设置哈希表中指定字段的值。同样需要提供缓存的key、字段名和要设置的值。

`hExists`方法帮助你判断哈希表中指定字段是否存在。

`hdel`方法允许你删除哈希表中的指定字段，甚至支持批量删除。

`hLen`方法返回哈希表的元素个数。

还有一个特殊的`hSetNx`方法（虽然这里没有给出具体实现），它仅在字段不存在时设置值，如果字段已存在，则返回false。这提供了一种确保数据一致性的方式，避免无意中覆盖已存在的数据。

```php

/

为Hash表设定单个字段的值。若成功，返回true；否则，返回false。

@param string $key Hash表的键名

@param string $field 要设定的字段名

@param mixed $value 字段的值

@return bool

/

public function hSetNx($key, $field, $value)

{

return $this->redis->hSetNx($key, $field, $value);

}

/

为Hash表设定多个字段的值。

@param string $key Hash表的键名

@param array $value 包含字段和对应值的数组

@return array|bool 成功时返回设定的字段名数组，失败则返回false

/

public function hMset($key, $value)

{

if (!is_array($value)) {

return false;

}

return $this->redis->hMset($key, $value);

}

/

获取Hash表中多个字段的值。

@param string $key Hash表的键名

@param mixed $field 可以是字符串（表示单个字段名）或以逗号分隔的字段名列表

@return array|bool 成功时返回字段值的数组，失败则返回false

/

public function hMget($key, $field)

{

if (!is_array($field)) {

$field = explode(',', $field);

}

return $this->redis->hMget($key, $field);

}

/

为Hash表的指定字段进行累加操作，支持负数。

@param string $key Hash表的键名

@param int $field 要累加的字段名

@param int $value 累加的数值

@return bool 成功时返回true，失败则返回false

/

public function hIncrBy($key, $field, $value)

{

$value = intval($value); // 确保输入为整数类型

return $this->redis->hIncrBy($key, $field, $value);

}

/

返回Hash表的所有字段名。

@param string $key Hash表的键名

@return array|bool 成功时返回字段名的数组，失败则返回false

/

public function hKeys($key)

{

return $this->redis->hKeys($key);

}

/

返回Hash表的所有字段值，以索引数组形式。

@param string $key Hash表的键名

@return array|bool 成功时返回字段值的数组，失败则返回false

/

public function hVals($key)

{

return $this->redis->hVals($key);

}

/

让我们处理第一个函数 `zAdd`：

```php

/

在Redis有序集合中添加一个成员。

@param string $key 集合的键名

@param string $order 成员的排序序号

@param string $value 成员的值

@return boolean 操作成功与否的标志

/

public function addMemberToSortedSet($key, $order, $value) {

return $this->redis->zAdd($key, $order, $value);

}

```

接下来是第二个函数 `zinCry`：

```php

/

为指定成员的排序值增加一定的数值，可以为负数。

@param string $key 集合的键名

@param string $num 要增加的数值大小

@param string $value 成员的值

@return int 返回更新后的新排序值

/

public function updateMemberOrder($key, $num, $value) {

return $this->redis->zinCry($key, $num, $value);

}

```

然后是第三个函数 `zRem`：

```php

/

从有序集合中删除指定值的成员。

@param string $key 集合的键名

@param string $value 要删除的成员值

@return boolean 操作成功与否的标志

/

public function removeMemberByValue($key, $value) {

让我们看看`zRevRangeByScore`这个函数，它的作用是按照分数从高到低返回指定范围内的元素。

```php

/

获取按分数逆序排列的指定范围内的元素

@param string $key 元素的键值

@param mixed $start 分数范围的起始值，默认为负无穷大

@param mixed $end 分数范围的结束值，默认为正无穷大

@param array $option 其他选项，如limit等

@return array|bool 返回符合条件的元素数组，若无则返回false

/

public function zRevRangeByScore($key, $start = '-inf', $end = '+inf', $option = [])

{

return $this->redis->zRevRangeByScore($key, $start, $end, $option);

}

```

接下来是`zCount`函数，它用来计算集合中在指定分数范围内的元素数量。

```php

/

统计集合中在指定分数范围内的元素数量

@param string $key 元素的键值

@param mixed $start 分数范围的起始值

@param mixed $end 分数范围的结束值

@return int 返回符合条件的元素数量

/

public function zCount($key, $start, $end)

{

return $this->redis->zCount($key, $start, $end);

}

```

然后，我们有`zScore`函数，它用于获取指定元素的分数。

```php

/

获取指定元素的分数

@param string $key 元素的键值

@param mixed $value 元素的值

@return float|bool 返回元素的分数，若不存在则返回false

/

public function zScore($key, $value)

{

return $this->redis->zScore($key, $value);

}

```

接下来是`zRank`和`zRevRank`函数，它们分别返回集合中以分数递增和递减排序后，指定成员的排序号。

```php

/

获取集合中以分数递增排序后，指定成员的排序号（从0开始）

@param string $key 元素的键值

@param mixed $value 元素的值

@return int|bool 返回成员的排序号，若不存在则返回false

/

public function zRank($key, $value)

{

return $this->redis->zRank($key, $value);

}

/

获取集合中以分数递减排序后，指定成员的排序号（从0开始）

@param string $key 元素的键值

@param mixed $value 元素的值

@return int|bool 返回成员的排序号，若不存在则返回false

/

public function zRevRank($key, $value)

{

return $this->redis->zRevRank($key, $value);

}

```

我们有`zRemRangeByScore`函数，它删除集合中分数在指定范围内的元素。

```php

/

```php

/

Redis队列操作类

/

public function zCard($key) {

return $this->redis->getSetCardinality($key); // 获取集合中元素的数量

}

/

@param string $key 队列键名

@return int 返回队列长度

/

public function rPush($key, $value) {

}

/

@param string $key 队列键名

@return int 返回队列长度

/

public function rPushx($key, $value) {

}

/

@param string $key 队列键名

@return int 返回队列长度

/

public function lPush($key, $value) {

}

/

在 Redis 数据存储的世界里，我们经常会使用一系列命令来操作字符串、列表、集合等数据结构。下面是一些常见的 Redis 命令的 PHP 实现方式，以公众方法的形式存在于某个类中。

让我们看看如何处理列表操作。当你想要从队列的左侧删除并获取一个元素时，你可以使用 `lPop` 方法：

```php

/

删除并返回队列中的首元素

@param unknown $key 键名

@return mixed 返回被删除的元素，如果队列没有元素则返回false或null

/

public function lPop($key) {

return $this->redis->lPop($key);

}

```

相对应的，从队列的右侧进行类似操作，你可以使用 `rPop` 方法：

```php

/

删除并返回队列中的尾元素

@param unknown $key 键名

@return mixed 返回被删除的元素，如果队列没有元素则返回false或null

/

public function rPop($key) {

return $this->redis->rPop($key);

}

```

接下来，我们转向字符串操作。设置一个 key 和它的值，你可以使用 `set` 方法：

```php

/

设置一个key的值

@param unknown $key 键名

@param unknown $value 值

@return boolean 返回操作结果，成功返回true，失败返回false

/

public function set($key, $value) {

return $this->redis->set($key, $value);

}

```

获取一个 key 的值，你可以使用 `get` 方法：

```php

/

获取一个key的值

@param unknown $key 键名

@return mixed 返回键对应的值，如果键不存在则返回false或null

/

public function get($key) {

return $this->redis->get($key);

}

```

还有更多功能强大的操作，如设置一个带有过期时间的 key (`setex`)，以及只当 key 不存在时才设置 (`setnx`)，甚至批量设置多个 key (`mset`)。这些功能都使得 Redis 成为了一个强大且灵活的数据存储工具。

对于无序集合的操作，也有相应的命令。例如，你可以使用 `sMembers` 来获取集合中的所有元素：

```php

/

返回集合中所有元素

@param unknown $key 键名

@return array 返回集合中的所有元素，如果集合为空则返回空数组

/

public function sMembers($key) {

return $this->redis->sMembers($key);

}

```

还可以使用 `sDiff` 来求两个集合的差集：

```php

/

求两个集合的差集

@param unknown $key1 第一个集合的键名

@param unknown $key2 第二个集合的键名

@return array 返回差集结果，如果结果集为空则返回空数组

代码封装说明

一、集合操作

1. 添加元素到无序集合

```php

/

向Redis无序集合中添加元素

@param string|array $key 集合的标识符

@param string|array $value 要添加的元素，可以是单个值或值的数组

/

public function addElementToSet($key, $value) {

if (!is_array($value)) {

$values = array($value); // 如果不是数组，则转为数组处理

} else {

$values = $value; // 如果是数组则直接使用

}

foreach ($values as $row) {

$this->redis->sAdd($key, $row); // 使用Redis的sAdd方法添加元素到集合中

}

}

```

2. 获取无序集合的元素个数

```php

/

获取Redis无序集合的元素个数

@param string|array $key 集合的标识符

@return int 元素个数

/

public function getSetCardinality($key) {

return $this->redis->scard($key); // 使用Redis的scard方法获取元素个数

}

```

3. 从集合中删除元素

```php

/ 移除集合中的元素 移除成功返回true，失败返回false / public function removeElementFromSet($key, $value) { return $this->redis->srem($key, $value); } 移除成功返回true，失败返回false二、数据库管理操作命令选择数据库切换数据库ID号成功返回bool值public function selectDatabase($dbId) { $this->dbId = $dbId; return $this->redis->select($dbId); }清空当前数据库成功返回bool值public function clearDatabase() { return $this->redis->flushDB(); }返回当前库状态返回包含信息的数组public function getDatabaseInfo() { return $this->redis->info(); }同步保存数据到磁盘成功返回bool值public function saveDataSync() { return $this->redis->save(); }异步保存数据到磁盘成功返回bool值public function saveDataAsync() { return $this->redis->bgSave(); }三、其他操作返回保存到磁盘的时间成功返回时间戳public function getLastSaveTime() { return $this->redis->lastSave(); }搜索符合规则的key支持多个字符匹配一个字符表示全部返回匹配的key数组public function searchKeys($pattern) { return $this->redis->keys($pattern); }删除指定的key成功删除返回true否则返回falsepublic function deleteKey($key) { return $this->redis->del($key); }判断一个key是否存在存在返回true不存在返回falsepublic function keyExists($key) { return $this->redis->exists($key); }为一个key设定过期时间单位秒设定成功返回true否则返回falsepublic function setKeyExpiration($key, $expireTimeInSeconds) { return $this->redis->expire($key, $expireTimeInSeconds); }返回一个key还有多久过期单位秒无过期时间则返回-1public function getKeyRemainingTTL($key) { return $this->redis->ttl($key); }设定一个key的过期时间给定一个时间戳设定成功返回true否则返回falsepublic function setKeyExpirationAt($key, $expirationTimestamp) { return $this->redis->expireAt($key, $expirationTimestamp); }关闭服务器链接成功关闭连接返回true否则返回falsepublic function closeConnection() { return $this->redis->close(); }关闭所有连接静态方法遍历所有实例关闭它们的连接public static function closeAllConnections() { foreach(static::$_instance as $o) { if($o instanceof self) $o->close(); } }这里不关闭连接因为session写入会在所有对象销毁之后进行以保持session的持续性总的来说这些封装提供了简洁高效的接口来操作Redis数据库无需直接操作底层的Redis命令即可实现各种数据库操作"""

在数据库操作结束时，一个关键的任务就是确保数据库连接得到妥善关闭。我们有一个特殊的析构函数 `__destruct()`，它的任务就是关闭与 Redis 数据库的连接。这是通过 `$this->redis->close()` 来实现的，确保所有的资源都被释放。

除了关闭连接外，我们的系统还提供了多种方法来获取和操作数据库的状态。例如，`dbSize()` 方法能够迅速返回当前数据库中 key 的数量，这对于监控数据库状态非常有用。如果你需要一个随机的 key 来执行某些操作，那么 `randomKey()` 方法就能满足你的需求，它会返回一个随机的 key 值。

我们还能获取关于当前数据库的一些基本信息。通过 `getDbId()`，我们可以得到当前数据库的 ID；而 `getAuth()` 和 `getHost()` 以及 `getPort()` 则分别提供了数据库的认证信息、主机地址和端口号。如果你需要获取所有这些信息，那么 `getConnInfo()` 方法就能一次性返回包含所有信息的数组。

除了基本的数据库操作和信息获取，我们还提供了与事务相关的方法，其中包括一种特殊的机制来监控 key 的变化。这就是所谓的乐观锁机制。在这种机制下，一个或多个 key 会被添加一个乐观锁。如果在锁定期间，这些 key 的值发生了改变，那么就无法为这些 key 设定新的值。你需要重新获取这些 key 的值，以确保你的操作是基于的数据库状态。

关于`watch`方法：

```php

public function watch($key) {

return $this->redis->watch($key); // 开始监视一个key，确保在执行事务期间，该key不会被其他客户端修改。

}

```

取消当前链接对所有key的监视时，如果已执行了`EXEC`或`DISCARD`命令，则无需再执行`UNWATCH`。这是关于`unwatch`方法的描述：

```php

public function unwatch() {

return $this->redis->unwatch(); // 取消之前监视的所有key。

}

```

关于事务处理，我们可以开启一个事务，选择使用`MULTI`或`PIPELINE`模式。默认的`MULTI`模式保证了原子性操作，而管道模式虽然速度更快，但可能无法保证数据的完整性。这是关于`multi`方法的描述：

```php

public function multi($type = \Redis::MULTI) {

return $this->redis->multi($type); // 开启一个事务，可以选择MULTI或PIPELINE模式。

}

```

执行事务时，即使其中某个命令失败，整个事务中的其他命令依然会被执行。这是关于`exec`方法的描述：

```php

public function exec() {

return $this->redis->exec(); // 执行事务中的所有命令。

}

```

当需要回滚一个事务时，可以使用`discard`方法：

```php

public function discard() {

return $this->redis->discard(); // 回滚事务中的所有命令。

}

```

测试当前连接是否有效时，可以使用`ping`方法：如果连接有效则返回"+PONG"，否则返回false。这是关于`ping`方法的描述：

```php

public function ping() {

return $this->redis->ping(); // 测试当前连接是否有效。如果有效返回'+PONG'，否则返回false。

}

推送消息功能

```php

public function pushMessage($lkey, $msg) {

if (is_array($msg)) {

$msg = json_encode($msg); // 将数组格式的消息转化为JSON字符串

}

$key = md5($msg); // 使用MD5算法生成唯一的消息标识键

// 若存在相同消息，则删除旧记录，以当前消息为准

// 之后，执行新消息的推送操作

$this->lPush($lkey, $key); // 将消息标识键推送到指定列表或集合中

$this->setex($key, 3600, $msg); // 设置消息键的过期时间（此处为1小时）并存储消息内容

return $key; // 返回生成的唯一消息标识键

}

```

批量删除Key的命令

对于想要批量删除Redis中的key，我们可以使用以下功能：

```php

public function delKeys($keys, $dbId) {

$redisInfo = $this->getConnInfo(); // 获取Redis连接信息

$cmdArr = array(

'redis-cli', // Redis命令行客户端工具

'-a', // 代表认证密码参数开始，下面的参数为认证密码值

$redisInfo['auth'], // Redis认证密码

'-h', // Redis服务器主机名参数开始

$redisInfo['host'], // Redis服务器主机名

'-p', // Redis服务器端口参数开始

$redisInfo['port'], // Redis服务器端口号

'-n', // 选择使用的数据库编号参数开始，下面的参数为数据库编号值