Redis 是一个开源的、高级的键值存储。它通常被称为数据结构服务器，因为键可以包含 字符串、哈希、列表、集合 和 有序集合。
在使用Redis与Laravel之前，我们建议您通过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'),
'options' => [
'cluster' => env('REDIS_CLUSTER', 'redis'),
'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
],
'default' => [
'url' => env('REDIS_URL'),
'host' => env('REDIS_HOST', '127.0.0.1'),
'username' => env('REDIS_USERNAME'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', '6379'),
'database' => env('REDIS_DB', '0'),
],
'cache' => [
'url' => env('REDIS_URL'),
'host' => env('REDIS_HOST', '127.0.0.1'),
'username' => env('REDIS_USERNAME'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', '6379'),
'database' => env('REDIS_CACHE_DB', '1'),
],
],在你的配置文件中定义的每个 Redis 服务器都必须具有名称、主机和端口，除非你定义一个单独的 URL 来表示 Redis 连接：
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'options' => [
'cluster' => env('REDIS_CLUSTER', 'redis'),
'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
],
'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 加密：
'default' => [
'scheme' => 'tls',
'url' => env('REDIS_URL'),
'host' => env('REDIS_HOST', '127.0.0.1'),
'username' => env('REDIS_USERNAME'),
'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'),
'options' => [
'cluster' => env('REDIS_CLUSTER', 'redis'),
'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
],
'clusters' => [
'default' => [
[
'url' => env('REDIS_URL'),
'host' => env('REDIS_HOST', '127.0.0.1'),
'username' => env('REDIS_USERNAME'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', '6379'),
'database' => env('REDIS_DB', '0'),
],
],
],
// ...
],默认情况下，Laravel 将使用原生 Redis 集群，因为 options.cluster 配置值被设置为 redis。Redis 集群是一个很好的默认选项，因为它优雅地处理故障转移。
Laravel 在使用 Predis 时也支持客户端分片。然而，客户端分片不处理故障转移；因此，它主要适用于可从另一个主数据存储获取的瞬态缓存数据。
如果您想使用客户端分片而不是原生 Redis 集群，您可以移除 options.cluster 配置值，该值位于您的应用程序的 config/database.php 配置文件中：
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'clusters' => [
// ...
],
// ...
],如果你希望你的应用通过 Predis 包与 Redis 交互, 你应该确保 REDIS_CLIENT 环境变量的值是 predis:
'redis' => [
'client' => env('REDIS_CLIENT', 'predis'),
// ...
],除了默认配置选项，Predis 还支持额外的 连接参数，可以为每个 Redis 服务器定义。要利用这些额外的配置选项，请将它们添加到你的应用程序的 config/database.php 配置文件中的 Redis 服务器配置里：
'default' => [
'url' => env('REDIS_URL'),
'host' => env('REDIS_HOST', '127.0.0.1'),
'username' => env('REDIS_USERNAME'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', '6379'),
'database' => env('REDIS_DB', '0'),
'read_write_timeout' => 60,
],默认情况下，Laravel 将使用 PhpRedis 扩展与 Redis 进行通信。Laravel 将用于与 Redis 通信的客户端由 redis.client 配置选项的值决定，该选项通常反映了 REDIS_CLIENT 环境变量的值：
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
// ...
],除了默认配置选项外, PhpRedis 还支持以下附加连接参数: name, persistent, persistent_id, prefix, read_timeout, retry_interval, max_retries, backoff_algorithm, backoff_base, backoff_cap, timeout, and context. 您可以将这些选项中的任何一个添加到 config/database.php 配置文件中的 Redis 服务器配置中:
'default' => [
'url' => env('REDIS_URL'),
'host' => env('REDIS_HOST', '127.0.0.1'),
'username' => env('REDIS_USERNAME'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', '6379'),
'database' => env('REDIS_DB', '0'),
'read_timeout' => 60,
'context' => [
// 'auth' => ['username', 'secret'],
// 'stream' => ['verify_peer' => false],
],
],retry_interval、max_retries、backoff_algorithm、backoff_base 和 backoff_cap 选项可用于配置 PhpRedis 客户端应如何尝试重新连接到 Redis 服务器。支持以下回退算法：default、decorrelated_jitter、equal_jitter、exponential、uniform 和 constant：
'default' => [
'url' => env('REDIS_URL'),
'host' => env('REDIS_HOST', '127.0.0.1'),
'username' => env('REDIS_USERNAME'),
'password' => env('REDIS_PASSWORD'),
'port' => env('REDIS_PORT', '6379'),
'database' => env('REDIS_DB', '0'),
'max_retries' => env('REDIS_MAX_RETRIES', 3),
'backoff_algorithm' => env('REDIS_BACKOFF_ALGORITHM', 'decorrelated_jitter'),
'backoff_base' => env('REDIS_BACKOFF_BASE', 100),
'backoff_cap' => env('REDIS_BACKOFF_CAP', 1000),
],Redis 连接也可以配置为使用 Unix 套接字而不是 TCP。这可以通过消除与您的应用程序在同一服务器上的 Redis 实例连接的 TCP 开销来提供更高的性能。要配置 Redis 使用 Unix 套接字，将您的 REDIS_HOST 环境变量设置为 Redis 套接字的路径，并将 REDIS_PORT 环境变量设置为 0：
REDIS_HOST=/run/redis/redis.sock
REDIS_PORT=0PhpRedis 扩展也可以配置使用多种序列化器和压缩算法。这些算法可以通过你的 Redis 配置的 options 数组进行配置：
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'options' => [
'cluster' => env('REDIS_CLUSTER', 'redis'),
'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
'serializer' => Redis::SERIALIZER_MSGPACK,
'compression' => Redis::COMPRESSION_LZ4,
],
// ...
],目前支持的序列化器包括: 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 门面上的 get 方法来调用 Redis 的 GET 命令:
<?php
namespace App\Http\Controllers;
use Illuminate\Support\Facades\Redis;
use Illuminate\View\View;
class UserController extends Controller
{
/**
* Show the profile for the given user.
*/
public function show(string $id): View
{
return view('user.profile', [
'user' => Redis::get('user:profile:'.$id)
]);
}
}如上所述，你可以在 Redis 外观上调用任何 Redis 的命令。 Laravel 使用魔术方法将命令传递给 Redis 服务器。 如果 Redis 命令期望参数，你应该将这些参数传递给该外观的相应方法：
use Illuminate\Support\Facades\Redis;
Redis::set('name', 'Taylor');
$values = Redis::lrange('names', 5, 10);或者，您可以使用 Redis 门面的 command 方法将命令传递给服务器，该方法接受命令的名称作为其第一个参数，以及一个值数组作为其第二个参数：
$values = Redis::command('lrange', ['name', 5, 10]);你的应用程序的 config/database.php 配置文件允许你定义多个 Redis 连接/服务器。你可以使用 Redis facade 的 connection 方法获取特定 Redis 连接：
$redis = Redis::connection('connection-name');要获取默认 Redis 连接的实例，您可以调用 connection 方法而无需提供任何额外参数：
$redis = Redis::connection();Redis 门面的 transaction 方法为 Redis 原生的 MULTI 和 EXEC 命令提供了方便的封装。 transaction 方法接受一个闭包作为其唯一参数。这个闭包将接收一个 Redis 连接实例，并可以向此实例发出任何命令。所有在闭包内发出的 Redis 命令都将在一个单一的原子事务中执行：
use Redis;
use Illuminate\Support\Facades;
Facades\Redis::transaction(function (Redis $redis) {
$redis->incr('user_visits', 1);
$redis->incr('total_visits', 1);
});[!警告]
在定义 Redis 事务时，你不能从 Redis 连接中检索任何值。请记住，你的事务作为单个原子操作执行，并且该操作直到你的整个闭包执行完其所有命令后才会执行。
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');[!WARNING]
请查阅 Redis 文档 以获取有关 Redis 脚本的更多信息。
有时您可能需要执行数十条 Redis 命令。您可以使用 pipeline 方法，而不是为每条命令都向 Redis 服务器进行一次网络往返。pipeline 方法接受一个参数：一个接收 Redis 实例的闭包。您可以向此 Redis 实例发出所有命令，它们将同时发送到 Redis 服务器，以减少到服务器的网络往返。这些命令仍将按照发出的顺序执行：
use Redis;
use Illuminate\Support\Facades;
Facades\Redis::pipeline(function (Redis $pipe) {
for ($i = 0; $i < 1000; $i++) {
$pipe->set("key:$i", $i);
}
});Laravel 提供了 publish 和 subscribe 这两个 Redis 命令的便捷接口。这些 Redis 命令允许你在一个指定的“频道”上监听消息。你可以从另一个应用程序，甚至使用另一种编程语言，向该频道发布消息，从而实现应用程序和进程之间的轻松通信。
首先，让我们使用subscribe方法来设置一个通道监听器。我们将把这个方法调用放在一个Artisan 命令中，因为调用subscribe方法会启动一个长时间运行的进程：
<?php
namespace App\Console\Commands;
use Illuminate\Console\Command;
use Illuminate\Support\Facades\Redis;
class RedisSubscribe extends Command
{
/**
* The name and signature of the console command.
*
* @var string
*/
protected $signature = 'redis:subscribe';
/**
* The console command description.
*
* @var string
*/
protected $description = 'Subscribe to a Redis channel';
/**
* Execute the console command.
*/
public function handle(): void
{
Redis::subscribe(['test-channel'], function (string $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 (string $message, string $channel) {
echo $message;
});
Redis::psubscribe(['users.*'], function (string $message, string $channel) {
echo $message;
});