键值对存储系统 Redis 在 Laravel 中的使用
由 学院君 创建于2年前, 最后更新于 10个月前
版本号 #2
19390 views
5 likes
0 collects
简介
Redis 是一个开源的、高级的键值对存储系统&＃xff0c;经常被用作数据结构服务器&＃xff0c;因为其支持字符串、Hash、列表、集合和有序集合等数据结构。
在 Laravel 中使用 Redis 之前&＃xff0c;需要通过 Composer 安装 predis/predis 包&＃xff1a;
composer require predis/predis
作为替代方案&＃xff0c;你还可以通过 PECL 安装 PHP 扩展 PhpRedis。该扩展安装起来更麻烦&＃xff0c;但是对重度使用 Redis 的应用而言性能更好。
配置
应用的 Redis 配置位于配置文件 config/database.php。在这个文件中&＃xff0c;可以看到包含被应用使用的 Redis 服务器的 redis 数组&＃xff1a;
&＃39;redis&＃39; &＃61;> [
&＃39;client&＃39; &＃61;> &＃39;predis&＃39;,
&＃39;default&＃39; &＃61;> [
&＃39;host&＃39; &＃61;> env(&＃39;REDIS_HOST&＃39;, &＃39;localhost&＃39;),
&＃39;password&＃39; &＃61;> env(&＃39;REDIS_PASSWORD&＃39;, null),
&＃39;port&＃39; &＃61;> env(&＃39;REDIS_PORT&＃39;, 6379),
&＃39;database&＃39; &＃61;> 0,
],
],
默认服务器配置可以满足开发需要&＃xff0c;不过&＃xff0c;你可以基于自己的环境修改该数组。配置文件中定义的每个 Redis 服务器需要一个名字并指定该 Redis 服务器使用的主机和接口。
配置集群
如果应用使用了 Redis 服务器集群&＃xff0c;需要在 Redis 配置中通过 clusters 定义这些集群&＃xff1a;
&＃39;redis&＃39; &＃61;> [
&＃39;client&＃39; &＃61;> &＃39;predis&＃39;,
&＃39;clusters&＃39; &＃61;> [
&＃39;default&＃39; &＃61;> [
[
&＃39;host&＃39; &＃61;> env(&＃39;REDIS_HOST&＃39;, &＃39;localhost&＃39;),
&＃39;password&＃39; &＃61;> env(&＃39;REDIS_PASSWORD&＃39;, null),
&＃39;port&＃39; &＃61;> env(&＃39;REDIS_PORT&＃39;, 6379),
&＃39;database&＃39; &＃61;> 0,
],
],
],
],
默认情况下&＃xff0c;集群将会在节点之间进行客户端分区&＃xff0c;从而允许你构建节点池并创建大量可用内存。不过&＃xff0c;客户端分片并不处理故障转移&＃xff0c;所以&＃xff0c;非常适合从另一个主数据存储那里获取有效的缓存数据。如果你想要使用本地 Redis 集群&＃xff0c;需要在 Redis 配置的 options 中进行指定&＃xff1a;
&＃39;redis&＃39; &＃61;> [
&＃39;client&＃39; &＃61;> &＃39;predis&＃39;,
&＃39;options&＃39; &＃61;> [
&＃39;cluster&＃39; &＃61;> &＃39;redis&＃39;,
],
&＃39;clusters&＃39; &＃61;> [
// ...
],
],
Predis
除了默认的 host、port、database 和 password 服务器配置选项&＃xff0c;Predis 还支持额外的用于定义每个 Redis 服务器的连接参数&＃xff0c;要使用这些额外的配置项&＃xff0c;只需在配置文件 config/database.php 中将它们添加到 Redis 服务器配置中&＃xff1a;
&＃39;default&＃39; &＃61;> [
&＃39;host&＃39; &＃61;> env(&＃39;REDIS_HOST&＃39;, &＃39;localhost&＃39;),
&＃39;password&＃39; &＃61;> env(&＃39;REDIS_PASSWORD&＃39;, null),
&＃39;port&＃39; &＃61;> env(&＃39;REDIS_PORT&＃39;, 6379),
&＃39;database&＃39; &＃61;> 0,
&＃39;read_write_timeout&＃39; &＃61;> 60,
],
PhpRedis
注&＃xff1a;如果你通过 PECL 安装了 PHP 扩展 PhpRedis&＃xff0c;需要在配置文件 config/app.php 中重命名 Redis 别名。
要使用 PhpRedis 扩展&＃xff0c;需要在Redis 配置中将 client 选项修改为 phpredis&＃xff0c;该选项位于配置文件 config/database&＃xff1a;
&＃39;redis&＃39; &＃61;> [
&＃39;client&＃39; &＃61;> &＃39;phpredis&＃39;,
// Rest of Redis configuration...
],
除了默认的 host、port、database 和 password 服务器配置选项&＃xff0c;PhpRedis 还支持额外的连接参数&＃xff1a;persistent、prefix、read_timeout 和 timeout&＃xff0c;你可以在配置文件 config/database.php 中将它们添加到 Redis 服务器配置中&＃xff1a;
&＃39;default&＃39; &＃61;> [
&＃39;host&＃39; &＃61;> env(&＃39;REDIS_HOST&＃39;, &＃39;localhost&＃39;),
&＃39;password&＃39; &＃61;> env(&＃39;REDIS_PASSWORD&＃39;, null),
&＃39;port&＃39; &＃61;> env(&＃39;REDIS_PORT&＃39;, 6379),
&＃39;database&＃39; &＃61;> 0,
&＃39;read_timeout&＃39; &＃61;> 60,
],
与 Redis 交互
你可以通过调用 Redis 门面上的方法来与 Redis 进行交互&＃xff0c;该门面支持动态方法&＃xff0c;所以你可以调用任何 Redis 命令&＃xff0c;对应命令将会直接传递给 Redis&＃xff0c;在本例中&＃xff0c;我们通过调用 Redis 门面上的 get 方法来调用 Redis 上的 GET 命令&＃xff1a;
namespace App\Http\Controllers;
use Illuminate\Support\Facades\Redis;
use App\Http\Controllers\Controller;
class UserController extends Controller{
/**
* 显示指定用户属性
*
* &＃64;param int $id
* &＃64;return Response
* &＃64;translator laravelacademy.org
*/
public function showProfile($id)
{
$user &＃61; Redis::get(&＃39;user:profile:&＃39;.$id);
return view(&＃39;user.profile&＃39;, [&＃39;user&＃39; &＃61;> $user]);
}
}
当然&＃xff0c;如上所述&＃xff0c;可以在 Redis 门面上调用任何 Redis 命令。Laravel 使用魔术方法将命令传递给 Redis 服务器&＃xff0c;所以只需简单传递参数和 Redis 命令如下&＃xff1a;
Redis::set(&＃39;name&＃39;, &＃39;Taylor&＃39;);
$values &＃61; Redis::lrange(&＃39;names&＃39;, 5, 10);
此外&＃xff0c;还可以使用 command 方法传递命令到服务器&＃xff0c;该方法接收命令名作为第一个参数&＃xff0c;参数值数组作为第二个参数&＃xff1a;
$values &＃61; Redis::command(&＃39;lrange&＃39;, [&＃39;name&＃39;, 5, 10]);
注&＃xff1a;如果要使用 Redis 作为缓存驱动&＃xff0c;可以参考缓存文档&＃xff1b;如果要使用 Redis 作为队列驱动&＃xff0c;可以参考队列文档。
使用多个 Redis 连接
你可以通过调用 Redis::connection 方法获取Redis 实例&＃xff1a;
$redis &＃61; Redis::connection();
这将会获取默认 Redis 服务器实例&＃xff0c;你还可以传递服务器名或集群名到 connection 方法来获取 Redis 配置中定义的指定服务器或集群&＃xff1a;
$redis &＃61; Redis::connection(&＃39;my-connection&＃39;);
管道命令
当你需要在一次操作中发送多个命令到服务器的时候应该使用管道&＃xff0c;pipeline 方法接收一个参数&＃xff1a;接收 Redis 实例的闭包。你可以将所有 Redis 命令发送到这个 Redis 实例&＃xff0c;然后这些命令会在一次操作中被执行&＃xff1a;
Redis::pipeline(function ($pipe) {
for ($i &＃61; 0; $i <1000; $i&＃43;&＃43;) {
$pipe->set("key:$i", $i);
}
});
发布/订阅
Redis 还提供了调用 Redis 的 publish 和 subscribe 命令的接口。这些 Redis 命令允许你在给定“频道”监听消息&＃xff0c;你可以从另外一个应用发布消息到这个频道&＃xff0c;甚至使用其它编程语言&＃xff0c;从而允许你在不同的应用/进程之间轻松通信。
首先&＃xff0c;让我们使用 subscribe 方法通过 Redis 在一个频道上设置监听器。由于调用 subscribe 方法会开启一个常驻进程&＃xff0c;我们将在 Artisan 命令中调用该方法&＃xff1a;
namespace App\Console\Commands;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\Redis;
class RedisSubscribe extends Command
{
/**
* 控制台命令名称
*
* &＃64;var string
*/
protected $signature &＃61; &＃39;redis:subscribe&＃39;;
/**
* 控制台命令描述
*
* &＃64;var string
*/
protected $description &＃61; &＃39;Subscribe to a Redis channel&＃39;;
/**
* 执行控制台命令
*
* &＃64;return mixed
*/
public function handle()
{
Redis::subscribe([&＃39;test-channel&＃39;], function($message) {
echo $message;
});
}
}
现在&＃xff0c;我们可以使用 publish 发布消息到该频道&＃xff1a;
Route::get(&＃39;publish&＃39;, function () {
// 路由逻辑...
Redis::publish(&＃39;test-channel&＃39;, json_encode([&＃39;foo&＃39; &＃61;> &＃39;bar&＃39;]));
});
通配符订阅
使用 psubscribe 方法&＃xff0c;你可以订阅到一个通配符定义的频道&＃xff0c;这在所有相应频道上获取所有消息时很有用。$channel 名将会作为第二个参数传递给提供的回调闭包&＃xff1a;
Redis::psubscribe([&＃39;*&＃39;], function($message, $channel) {
echo $message;
});
Redis::psubscribe([&＃39;users.*&＃39;], function($message, $channel) {
echo $message;
});
注&＃xff1a;要使用 Redis 作为事件广播服务端&＃xff0c;可以参考广播文档。
京公网安备 11010802041100号