Redis
简介
Redis 是一个开源的、先进的键值存储。它通常被称为数据结构服务器，因为键可以包含字符串、哈希、列表、集合和有序集合。
在使用 Laravel 的 Redis 之前，我们建议您通过 PECL 安装并使用 PhpRedis PHP 扩展。与“用户级”PHP 包相比，该扩展安装起来更复杂，但对于大量使用 Redis 的应用程序，可能会产生更好的性能。如果您正在使用 Laravel Sail，则此扩展已安装在您应用程序的 Docker 容器中。
如果您无法安装 PhpRedis 扩展，您可以 Composer 安装 predis/predis 包。Predis 是一个完全用 PHP 编写的 Redis 客户端，不需要任何额外的扩展
1composer require predis/predis:^2.0配置
您可以通过 config/database.php 配置文件配置应用程序的 Redis 设置。在此文件中，您将看到一个 redis 数组，其中包含您的应用程序使用的 Redis 服务器
1'redis' => [ 2 3 'client' => env('REDIS_CLIENT', 'phpredis'), 4 5 'options' => [ 6 'cluster' => env('REDIS_CLUSTER', 'redis'), 7 'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'), 8 ], 9 10 'default' => [11 'url' => env('REDIS_URL'),12 'host' => env('REDIS_HOST', '127.0.0.1'),13 'username' => env('REDIS_USERNAME'),14 'password' => env('REDIS_PASSWORD'),15 'port' => env('REDIS_PORT', '6379'),16 'database' => env('REDIS_DB', '0'),17 ],18 19 'cache' => [20 'url' => env('REDIS_URL'),21 'host' => env('REDIS_HOST', '127.0.0.1'),22 'username' => env('REDIS_USERNAME'),23 'password' => env('REDIS_PASSWORD'),24 'port' => env('REDIS_PORT', '6379'),25 'database' => env('REDIS_CACHE_DB', '1'),26 ],27 28],您在配置文件中定义的每个 Redis 服务器都需要有一个名称、主机和端口，除非您定义单个 URL 来表示 Redis 连接
1'redis' => [ 2 3 'client' => env('REDIS_CLIENT', 'phpredis'), 4 5 'options' => [ 6 'cluster' => env('REDIS_CLUSTER', 'redis'), 7 'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'), 8 ], 9 10 'default' => [11 'url' => 'tcp://127.0.0.1:6379?database=0',12 ],13 14 'cache' => [16 ],17 18],配置连接方案
默认情况下，Redis 客户端在连接到您的 Redis 服务器时将使用 tcp 方案；但是，您可以通过在 Redis 服务器的配置数组中指定 scheme 配置选项来使用 TLS / SSL 加密
1'default' => [2 'scheme' => 'tls',3 'url' => env('REDIS_URL'),4 'host' => env('REDIS_HOST', '127.0.0.1'),5 'username' => env('REDIS_USERNAME'),6 'password' => env('REDIS_PASSWORD'),7 'port' => env('REDIS_PORT', '6379'),8 'database' => env('REDIS_DB', '0'),9],集群
如果您的应用程序正在使用 Redis 服务器集群，您应该在 Redis 配置的 clusters 键中定义这些集群。默认情况下，此配置键不存在，因此您需要在应用程序的 config/database.php 配置文件中创建它
1'redis' => [ 2 3 'client' => env('REDIS_CLIENT', 'phpredis'), 4 5 'options' => [ 6 'cluster' => env('REDIS_CLUSTER', 'redis'), 7 'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'), 8 ], 9 10 'clusters' => [11 'default' => [12 [13 'url' => env('REDIS_URL'),14 'host' => env('REDIS_HOST', '127.0.0.1'),15 'username' => env('REDIS_USERNAME'),16 'password' => env('REDIS_PASSWORD'),17 'port' => env('REDIS_PORT', '6379'),18 'database' => env('REDIS_DB', '0'),19 ],20 ],21 ],22 23 // ...24],默认情况下，Laravel 将使用原生 Redis 集群，因为 options.cluster 配置值设置为 redis。Redis 集群是一个很好的默认选项，因为它能优雅地处理故障转移。
Laravel 在使用 Predis 时也支持客户端分片。但是，客户端分片不处理故障转移；因此，它主要适用于可从另一个主数据存储获得的瞬态缓存数据。
如果您想使用客户端分片而不是原生 Redis 集群，您可以删除应用程序 config/database.php 配置文件中的 options.cluster 配置值
1'redis' => [ 2 3 'client' => env('REDIS_CLIENT', 'phpredis'), 4 5 'clusters' => [ 6 // ... 7 ], 8 9 // ...10],Predis
如果您希望您的应用程序通过 Predis 包与 Redis 交互，您应确保 REDIS_CLIENT 环境变量的值为 predis
1'redis' => [2 3 'client' => env('REDIS_CLIENT', 'predis'),4 5 // ...6],除了默认配置选项外，Predis 还支持其他 连接参数，这些参数可以为您的每个 Redis 服务器定义。要使用这些额外的配置选项，请将它们添加到应用程序 config/database.php 配置文件中的 Redis 服务器配置中
1'default' => [2 'url' => env('REDIS_URL'),3 'host' => env('REDIS_HOST', '127.0.0.1'),4 'username' => env('REDIS_USERNAME'),5 'password' => env('REDIS_PASSWORD'),6 'port' => env('REDIS_PORT', '6379'),7 'database' => env('REDIS_DB', '0'),8 'read_write_timeout' => 60,9],PhpRedis
默认情况下，Laravel 将使用 PhpRedis 扩展与 Redis 通信。Laravel 将用于与 Redis 通信的客户端由 redis.client 配置选项的值决定，该选项通常反映 REDIS_CLIENT 环境变量的值
1'redis' => [2 3 'client' => env('REDIS_CLIENT', 'phpredis'),4 5 // ...6],除了默认配置选项外，PhpRedis 还支持以下其他连接参数：name、persistent、persistent_id、prefix、read_timeout、retry_interval、max_retries、backoff_algorithm、backoff_base、backoff_cap、timeout 和 context。您可以将其中任何选项添加到 config/database.php 配置文件中的 Redis 服务器配置中
1'default' => [ 2 'url' => env('REDIS_URL'), 3 'host' => env('REDIS_HOST', '127.0.0.1'), 4 'username' => env('REDIS_USERNAME'), 5 'password' => env('REDIS_PASSWORD'), 6 'port' => env('REDIS_PORT', '6379'), 7 'database' => env('REDIS_DB', '0'), 8 'read_timeout' => 60, 9 'context' => [10 // 'auth' => ['username', 'secret'],11 // 'stream' => ['verify_peer' => false],12 ],13],PhpRedis 序列化和压缩
PhpRedis 扩展也可以配置为使用各种序列化器和压缩算法。这些算法可以通过 Redis 配置的 options 数组进行配置
1'redis' => [ 2 3 'client' => env('REDIS_CLIENT', 'phpredis'), 4 5 'options' => [ 6 'cluster' => env('REDIS_CLUSTER', 'redis'), 7 'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'), 8 'serializer' => Redis::SERIALIZER_MSGPACK, 9 'compression' => Redis::COMPRESSION_LZ4,10 ],11 12 // ...13],当前支持的序列化器包括：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 外观模式 上的各种方法与 Redis 交互。Redis 外观模式支持动态方法，这意味着您可以在外观模式上调用任何 Redis 命令，该命令将直接传递给 Redis。在此示例中，我们将通过调用 Redis 外观模式上的 get 方法来调用 Redis GET 命令
1<?php 2 3namespace App\Http\Controllers; 4 5use App\Http\Controllers\Controller; 6use Illuminate\Support\Facades\Redis; 7use Illuminate\View\View; 8 9class UserController extends Controller10{11 /**12 * Show the profile for the given user.13 */14 public function show(string $id): View15 {16 return view('user.profile', [17 'user' => Redis::get('user:profile:'.$id)18 ]);19 }20}如上所述，您可以在 Redis 外观模式上调用任何 Redis 命令。Laravel 使用魔术方法将命令传递到 Redis 服务器。如果 Redis 命令需要参数，您应该将这些参数传递给外观模式的相应方法
1use Illuminate\Support\Facades\Redis;2 3Redis::set('name', 'Taylor');4 5$values = Redis::lrange('names', 5, 10);或者，您可以使用 Redis 外观模式的 command 方法将命令传递到服务器，该方法接受命令名称作为其第一个参数，值数组作为其第二个参数
1$values = Redis::command('lrange', ['name', 5, 10]);使用多个 Redis 连接
您的应用程序的 config/database.php 配置文件允许您定义多个 Redis 连接 / 服务器。您可以使用 Redis 外观模式的 connection 方法获取与特定 Redis 连接的连接
1$redis = Redis::connection('connection-name');要获取默认 Redis 连接的实例，您可以调用不带任何额外参数的 connection 方法
1$redis = Redis::connection();事务
Redis 外观模式的 transaction 方法为 Redis 的原生 MULTI 和 EXEC 命令提供了一个方便的包装器。transaction 方法接受一个闭包作为其唯一参数。此闭包将接收一个 Redis 连接实例，并可以向该实例发出它想要的任何命令。闭包中发出的所有 Redis 命令将在单个原子事务中执行
1use Redis;2use Illuminate\Support\Facades;3 4Facades\Redis::transaction(function (Redis $redis) {5 $redis->incr('user_visits', 1);6 $redis->incr('total_visits', 1);7});在定义 Redis 事务时，您可能无法从 Redis 连接中检索任何值。请记住，您的事务作为单个原子操作执行，并且该操作在您的整个闭包完成执行其命令之前不会执行。
Lua 脚本
eval 方法提供了另一种在单个原子操作中执行多个 Redis 命令的方法。但是，eval 方法的好处是能够在操作期间与 Redis 键值交互并检查它们。Lua 编程语言 编写 Redis 脚本。
eval 方法乍一看可能有点吓人，但我们将探索一个基本示例来打破僵局。eval 方法需要多个参数。首先，您应该将 Lua 脚本（作为字符串）传递给该方法。其次，您应该传递脚本与之交互的键的数量（作为整数）。第三，您应该传递这些键的名称。最后，您可以传递您需要在脚本中访问的任何其他附加参数。
在此示例中，我们将递增一个计数器，检查其新值，如果第一个计数器的值大于五，则递增第二个计数器。最后，我们将返回第一个计数器的值
1$value = Redis::eval(<<<'LUA'2 local counter = redis.call("incr", KEYS[1])3 4 if counter > 5 then5 redis.call("incr", KEYS[2])6 end7 8 return counter9LUA, 2, 'first-counter', 'second-counter');有关 Redis 脚本的更多信息，请查阅 Redis 文档。
管道命令
有时您可能需要执行数十个 Redis 命令。与其为每个命令向 Redis 服务器进行网络往返，不如使用 pipeline 方法。pipeline 方法接受一个参数：接收 Redis 实例的闭包。您可以向此 Redis 实例发出所有命令，它们将同时发送到 Redis 服务器，以减少到服务器的网络往返次数。命令仍将按发出顺序执行
1use Redis;2use Illuminate\Support\Facades;3 4Facades\Redis::pipeline(function (Redis $pipe) {5 for ($i = 0; $i < 1000; $i++) {6 $pipe->set("key:$i", $i);7 }8});发布 / 订阅
Laravel 为 Redis publish 和 subscribe 命令提供了一个方便的接口。这些 Redis 命令允许您监听给定“通道”上的消息。您可以从另一个应用程序发布消息到该通道，甚至可以使用另一种编程语言，从而实现应用程序和进程之间的轻松通信。
首先，让我们使用 subscribe 方法设置通道监听器。我们将此方法调用放在 Artisan 命令 中，因为调用 subscribe 方法会启动一个长时间运行的进程
1<?php 2 3namespace App\Console\Commands; 4 5use Illuminate\Console\Command; 6use Illuminate\Support\Facades\Redis; 7 8class RedisSubscribe extends Command 9{10 /**11 * The name and signature of the console command.12 *13 * @var string14 */15 protected $signature = 'redis:subscribe';16 17 /**18 * The console command description.19 *20 * @var string21 */22 protected $description = 'Subscribe to a Redis channel';23 24 /**25 * Execute the console command.26 */27 public function handle(): void28 {29 Redis::subscribe(['test-channel'], function (string $message) {30 echo $message;31 });32 }33}现在我们可以使用 publish 方法将消息发布到通道
1use Illuminate\Support\Facades\Redis;2 3Route::get('/publish', function () {4 // ...5 6 Redis::publish('test-channel', json_encode([7 'name' => 'Adam Wathan'8 ]));9});通配符订阅
使用 psubscribe 方法，您可以订阅通配符通道，这对于捕获所有通道上的所有消息可能很有用。通道名称将作为第二个参数传递给提供的闭包
1Redis::psubscribe(['*'], function (string $message, string $channel) {2 echo $message;3});4 5Redis::psubscribe(['users.*'], function (string $message, string $channel) {6 echo $message;7});