Predis 技术文档

缪乾宁

于 2024-10-18 10:57:11 发布

阅读量955

点赞数 12

本文链接：https://blog.csdn.net/gitblog_01284/article/details/143039278

版权

Predis 技术文档

predis A flexible and feature-complete Redis client for PHP. 项目地址: https://gitcode.com/gh_mirrors/pr/predis

本文档旨在为您提供全面的指南，以深入了解并高效使用Predis——一个专为PHP设计的灵活且功能完备的Redis客户端。Predis支持PHP 7.2及以上版本，并提供了从Redis 3.0到7.2的全面支持。

安装指南

使用Composer安装

最简便的方式是通过Composer来管理依赖，执行以下命令即可添加Predis作为项目依赖：

composer require predis/predis

手动加载

对于不使用Composer的环境，可以直接加载Predis的自动加载器：

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

项目使用说明

连接到Redis

Predis默认连接到本机的6379端口，您可以通过构造函数参数改变这些默认值：

$client = new Predis\Client(); // 默认连接到127.0.0.1:6379
$client->set('exampleKey', 'exampleValue'); 
$value = $client->get('exampleKey'); // 获取值

指定其他主机或端口：

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

或者使用URI方式：

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

支持密码保护的服务器以及TLS/SSL加密连接也是可用的。

配置客户端

您可以传递额外的选项配置客户端的行为，例如设置键前缀：

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

集群与复制支持

集群：通过指定['cluster' => 'predis']或['cluster' => 'redis']来启用集群模式，适应不同的集群逻辑。
复制：若想使用主从复制，同样在选项中进行配置，Predis将自动识别读写操作，将读操作分散到从节点上。

项目API使用文档

Predis支持Redis的大多数命令，并提供了封装好的方法。例如，使用事务：

$client->transaction(function ($tx) {
    $tx-> incr('counter');
});

以及Lua脚本的抽象：

 luaScript = 'return redis.call("INCR", KEYS[1])';
$response = $client->evalsha($luaScript, 1, 'myCounter');

自定义命令与扩展

开发者可以轻松定义新的命令或者覆盖现有命令，通过实现Predis\Command\CommandInterface接口来创建自己的命令类。

class CustomCommand extends Predis\Command\Command {
    public function getId() { return 'myCustomCmd'; }
}
$client->createCommand(CustomCommand::ID)->execute();

总结

Predis为PHP开发者提供了一个强大而灵活的工具集来与Redis交互。通过以上步骤，您应该能够成功安装Predis，并开始利用它的各种特性进行高效的Redis数据库操作。记得查阅官方文档获取更详细的API参考和高级用法，以充分利用这个库的所有潜能。

predis A flexible and feature-complete Redis client for PHP. 项目地址: https://gitcode.com/gh_mirrors/pr/predis