Redis
简介
Redis 是一个开源、高级的键值存储系统。它通常被称为数据结构服务器，因为键可以包含 字符串、哈希、列表、集合 和 有序集合。
在 Laravel 中使用 Redis 之前，我们建议您通过 PECL 安装并使用 PhpRedis PHP 扩展。与“用户态”PHP 软件包相比，该扩展安装稍显复杂，但对于大量使用 Redis 的应用程序来说，它能提供更好的性能。如果您正在使用 Laravel Sail，该扩展已预装在您的应用程序 Docker 容器中。
如果您无法安装 PhpRedis 扩展，可以通过 Composer 安装 predis/predis 软件包。Predis 是一个完全用 PHP 编写的 Redis 客户端，不需要任何额外的扩展。
1composer require predis/predis配置
您可以通过 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],重试和退避配置
retry_interval、max_retries、backoff_algorithm、backoff_base 和 backoff_cap 选项可用于配置 PhpRedis 客户端如何尝试重新连接到 Redis 服务器。支持的退避算法包括：default、decorrelated_jitter、equal_jitter、exponential、uniform 和 constant。
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 'max_retries' => env('REDIS_MAX_RETRIES', 3), 9 'backoff_algorithm' => env('REDIS_BACKOFF_ALGORITHM', 'decorrelated_jitter'),10 'backoff_base' => env('REDIS_BACKOFF_BASE', 100),11 'backoff_cap' => env('REDIS_BACKOFF_CAP', 1000),12],Predis 3.4.0 及更高版本通过 Retry 类支持内置的重试和退避配置。使用 retry 选项并配合以下策略之一进行配置：NoBackoff、EqualBackoff 或 ExponentialBackoff。
1use Predis\Retry; 2use Predis\Retry\Strategy\ExponentialBackoff; 3 4'default' => [ 5 'url' => env('REDIS_URL'), 6 // ... 7 'retry' => new Retry( 8 new ExponentialBackoff( 9 env('REDIS_BACKOFF_BASE', 100),10 env('REDIS_BACKOFF_CAP', 1000),11 true, // Enables jitter12 ),13 env('REDIS_MAX_RETRIES', 3)14 )15],Unix 套接字连接
Redis 连接也可以配置为使用 Unix 套接字代替 TCP。这可以通过消除与应用程序在同一服务器上的 Redis 实例连接时的 TCP 开销来提高性能。要将 Redis 配置为使用 Unix 套接字，请将 REDIS_HOST 环境变量设置为 Redis 套接字的路径，并将 REDIS_PORT 环境变量设置为 0。
1REDIS_HOST=/run/redis/redis.sock2REDIS_PORT=0PhpRedis 序列化与压缩
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 门面 (facade) 上调用各种方法来与 Redis 交互。Redis 门面支持动态方法，这意味着您可以在门面上调用任何 Redis 命令，该命令将直接传递给 Redis。在此示例中，我们将通过在 Redis 门面上调用 get 方法来调用 Redis 的 GET 命令。
1<?php 2 3namespace App\Http\Controllers; 4 5use Illuminate\Support\Facades\Redis; 6use Illuminate\View\View; 7 8class UserController extends Controller 9{10 /**11 * Show the profile for the given user.12 */13 public function show(string $id): View14 {15 return view('user.profile', [16 'user' => Redis::get('user:profile:'.$id)17 ]);18 }19}如上所述，您可以在 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 键值进行交互和检查。Redis 脚本使用 Lua 编程语言 编写。
eval 方法起初可能看起来有点令人畏惧，但我们将通过一个基本示例来破冰。eval 方法需要几个参数。首先，您应该将 Lua 脚本（作为字符串）传递给该方法。其次，您应该传递脚本与之交互的键的数量（作为整数）。第三，您应该传递这些键的名称。最后，您可以传递脚本内需要访问的任何其他附加参数。
在此示例中，我们将递增一个计数器，检查其新值，如果第一个计数器的值大于 5，则递增第二个计数器。最后，我们将返回第一个计数器的值。
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 脚本的更多信息。
命令流水线 (Pipelining)
有时您可能需要执行数十个 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});