Redis
介绍
Redis 是一个开源的高级键值存储。由于键可以包含字符串、哈希、列表、集合和有序集合，它通常被称为数据结构服务器。
在使用 Laravel 的 Redis 之前，我们建议您通过 PECL 安装并使用 phpredis PHP 扩展。与“用户级”PHP 包相比，该扩展的安装更为复杂，但对于大量使用 Redis 的应用程序可能会带来更好的性能。如果您使用 Laravel Sail，此扩展已安装在您的应用程序的 Docker 容器中。
如果您无法安装 phpredis 扩展，可以通过 Composer 安装 predis/predis 包。Predis 是一个完全用 PHP 编写的 Redis 客户端，不需要任何额外的扩展：
composer require predis/predis配置
您可以通过 config/database.php 配置文件配置应用程序的 Redis 设置。在此文件中，您将看到一个 redis 数组，其中包含应用程序使用的 Redis 服务器：
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'default' => [
'host' => env('REDIS_HOST', '127.0.0.1'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', 6379),
'database' => env('REDIS_DB', 0),
],
'cache' => [
'host' => env('REDIS_HOST', '127.0.0.1'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', 6379),
'database' => env('REDIS_CACHE_DB', 1),
],
],配置文件中定义的每个 Redis 服务器都需要有一个名称、主机和端口，除非您定义了一个 URL 来表示 Redis 连接：
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'default' => [
'url' => 'tcp://127.0.0.1:6379?database=0',
],
'cache' => [
'url' => 'tls://user:password@127.0.0.1:6380?database=1',
],
],配置连接方案
默认情况下，Redis 客户端在连接到 Redis 服务器时将使用 tcp 方案；但是，您可以通过在 Redis 服务器的配置数组中指定 scheme 配置选项来使用 TLS / SSL 加密：
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'default' => [
'scheme' => 'tls',
'host' => env('REDIS_HOST', '127.0.0.1'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', 6379),
'database' => env('REDIS_DB', 0),
],
],集群
如果您的应用程序使用的是 Redis 服务器集群，您应该在 Redis 配置的 clusters 键中定义这些集群。此配置键默认不存在，因此您需要在应用程序的 config/database.php 配置文件中创建它：
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'clusters' => [
'default' => [
[
'host' => env('REDIS_HOST', 'localhost'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', 6379),
'database' => 0,
],
],
],
],默认情况下，集群将在您的节点之间执行客户端侧分片，允许您池化节点并创建大量可用 RAM。然而，客户端侧分片不处理故障转移；因此，它主要适用于从其他主数据存储中可用的临时缓存数据。
如果您希望使用本机 Redis 集群而不是客户端侧分片，可以通过在应用程序的 config/database.php 配置文件中将 options.cluster 配置值设置为 redis 来指定：
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'options' => [
'cluster' => env('REDIS_CLUSTER', 'redis'),
],
'clusters' => [
// ...
],
],Predis
如果您希望应用程序通过 Predis 包与 Redis 交互，您应该确保 REDIS_CLIENT 环境变量的值为 predis：
'redis' => [
'client' => env('REDIS_CLIENT', 'predis'),
// ...
],除了默认的 host、port、database 和 password 服务器配置选项外，Predis 支持其他连接参数，可以为每个 Redis 服务器定义这些参数。要使用这些额外的配置选项，请将它们添加到应用程序的 config/database.php 配置文件中的 Redis 服务器配置中：
'default' => [
'host' => env('REDIS_HOST', 'localhost'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', 6379),
'database' => 0,
'read_write_timeout' => 60,
],Redis Facade 别名
Laravel 的 config/app.php 配置文件包含一个 aliases 数组，该数组定义了框架将注册的所有类别名。默认情况下，不包含 Redis 别名，因为它会与 phpredis 扩展提供的 Redis 类名冲突。如果您使用 Predis 客户端并希望添加 Redis 别名，可以将其添加到应用程序的 config/app.php 配置文件中的 aliases 数组中：
'aliases' => Facade::defaultAliases()->merge([
'Redis' => Illuminate\Support\Facades\Redis::class,
])->toArray(),phpredis
默认情况下，Laravel 将使用 phpredis 扩展与 Redis 通信。Laravel 将用于与 Redis 通信的客户端由 redis.client 配置选项的值决定，该值通常反映 REDIS_CLIENT 环境变量的值：
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
// 其余的 Redis 配置...
],除了默认的 scheme、host、port、database 和 password 服务器配置选项外，phpredis 支持以下额外的连接参数：name、persistent、persistent_id、prefix、read_timeout、retry_interval、timeout 和 context。您可以将这些选项添加到 config/database.php 配置文件中的 Redis 服务器配置中：
'default' => [
'host' => env('REDIS_HOST', 'localhost'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', 6379),
'database' => 0,
'read_timeout' => 60,
'context' => [
// 'auth' => ['username', 'secret'],
// 'stream' => ['verify_peer' => false],
],
],phpredis 序列化与压缩
phpredis 扩展还可以配置为使用多种序列化和压缩算法。这些算法可以通过 Redis 配置的 options 数组进行配置：
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'options' => [
'serializer' => Redis::SERIALIZER_MSGPACK,
'compression' => Redis::COMPRESSION_LZ4,
],
// 其余的 Redis 配置...
],当前支持的序列化算法包括：Redis::SERIALIZER_NONE（默认）、Redis::SERIALIZER_PHP、Redis::SERIALIZER_JSON、Redis::SERIALIZER_IGBINARY 和 Redis::SERIALIZER_MSGPACK。
支持的压缩算法包括：Redis::COMPRESSION_NONE（默认）、Redis::COMPRESSION_LZF、Redis::COMPRESSION_ZSTD 和 Redis::COMPRESSION_LZ4。
与 Redis 交互
您可以通过调用 Redis facade 上的各种方法与 Redis 交互。Redis facade 支持动态方法，这意味着您可以在 facade 上调用任何 Redis 命令，并且该命令将直接传递给 Redis。在此示例中，我们将通过调用 Redis facade 上的 get 方法来调用 Redis 的 GET 命令：
<?php
namespace App\Http\Controllers;
use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\Redis;
class UserController extends Controller
{
/**
* 显示给定用户的个人资料。
*
* @param int $id
* @return \Illuminate\Http\Response
*/
public function show($id)
{
return view('user.profile', [
'user' => Redis::get('user:profile:'.$id)
]);
}
}如上所述，您可以在 Redis facade 上调用 Redis 的任何命令。Laravel 使用魔术方法将命令传递给 Redis 服务器。如果 Redis 命令需要参数，您应该将这些参数传递给 facade 的相应方法：
use Illuminate\Support\Facades\Redis;
Redis::set('name', 'Taylor');
$values = Redis::lrange('names', 5, 10);或者，您可以使用 Redis facade 的 command 方法将命令传递给服务器，该方法接受命令名称作为第一个参数，并接受一个值数组作为第二个参数：
$values = Redis::command('lrange', ['name', 5, 10]);使用多个 Redis 连接
应用程序的 config/database.php 配置文件允许您定义多个 Redis 连接/服务器。您可以使用 Redis facade 的 connection 方法获取特定 Redis 连接的连接：
$redis = Redis::connection('connection-name');要获取默认 Redis 连接的实例，您可以在不带任何附加参数的情况下调用 connection 方法：
$redis = Redis::connection();事务
Redis facade 的 transaction 方法提供了一个方便的包装器，用于 Redis 的本机 MULTI 和 EXEC 命令。transaction 方法接受一个闭包作为其唯一参数。此闭包将接收一个 Redis 连接实例，并可以向此实例发出任何命令。闭包中发出的所有 Redis 命令都将在单个原子事务中执行：
use Illuminate\Support\Facades\Redis;
Redis::transaction(function ($redis) {
$redis->incr('user_visits', 1);
$redis->incr('total_visits', 1);
});在定义 Redis 事务时，您可能无法从 Redis 连接中检索任何值。请记住，您的事务是作为单个原子操作执行的，并且该操作在整个闭包完成执行其命令之前不会执行。
Lua 脚本
eval 方法提供了另一种在单个原子操作中执行多个 Redis 命令的方法。然而，eval 方法的好处是能够在该操作期间与 Redis 键值进行交互和检查。Redis 脚本是用 Lua 编程语言 编写的。
eval 方法一开始可能有点吓人，但我们将通过一个基本示例来破冰。eval 方法期望几个参数。首先，您应该将 Lua 脚本（作为字符串）传递给该方法。其次，您应该传递脚本交互的键的数量（作为整数）。第三，您应该传递这些键的名称。最后，您可以传递脚本中需要访问的任何其他附加参数。
在此示例中，我们将递增一个计数器，检查其新值，并在第一个计数器的值大于五时递增第二个计数器。最后，我们将返回第一个计数器的值：
$value = Redis::eval(<<<'LUA'
local counter = redis.call("incr", KEYS[1])
if counter > 5 then
redis.call("incr", KEYS[2])
end
return counter
LUA, 2, 'first-counter', 'second-counter');请查阅 Redis 文档 以获取有关 Redis 脚本的更多信息。
管道命令
有时您可能需要执行数十个 Redis 命令。您可以使用 pipeline 方法，而不是为每个命令都进行一次到 Redis 服务器的网络传输。pipeline 方法接受一个参数：一个接收 Redis 实例的闭包。您可以向此 Redis 实例发出所有命令，并且它们将同时发送到 Redis 服务器，以减少到服务器的网络传输。命令仍将按照发出的顺序执行：
use Illuminate\Support\Facades\Redis;
Redis::pipeline(function ($pipe) {
for ($i = 0; $i < 1000; $i++) {
$pipe->set("key:$i", $i);
}
});发布/订阅
Laravel 提供了一个方便的接口，用于 Redis 的 publish 和 subscribe 命令。这些 Redis 命令允许您监听给定“频道”上的消息。您可以从另一个应用程序，甚至使用另一种编程语言向频道发布消息，从而实现应用程序和进程之间的轻松通信。
首先，让我们使用 subscribe 方法设置一个频道监听器。我们将此方法调用放在一个 Artisan 命令 中，因为调用 subscribe 方法会启动一个长时间运行的进程：
<?php
namespace App\Console\Commands;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\Redis;
class RedisSubscribe extends Command
{
/**
* 控制台命令的名称和签名。
*
* @var string
*/
protected $signature = 'redis:subscribe';
/**
* 控制台命令的描述。
*
* @var string
*/
protected $description = '订阅 Redis 频道';
/**
* 执行控制台命令。
*
* @return mixed
*/
public function handle()
{
Redis::subscribe(['test-channel'], function ($message) {
echo $message;
});
}
}现在我们可以使用 publish 方法向频道发布消息：
use Illuminate\Support\Facades\Redis;
Route::get('/publish', function () {
// ...
Redis::publish('test-channel', json_encode([
'name' => 'Adam Wathan'
]));
});通配符订阅
使用 psubscribe 方法，您可以订阅通配符频道，这对于捕获所有频道上的所有消息可能很有用。频道名称将作为第二个参数传递给提供的闭包：
Redis::psubscribe(['*'], function ($message, $channel) {
echo $message;
});
Redis::psubscribe(['users.*'], function ($message, $channel) {
echo $message;
});