Redis
简介
Redis 是一个开源的高级键值存储。它通常被称为数据结构服务器，因为键可以包含字符串、哈希、列表、集合和有序集合。
在 Laravel 中使用 Redis 之前，我们鼓励你通过 PECL 安装并使用 PhpRedis PHP 扩展。与「用户态」PHP 包相比，该扩展的安装更为复杂，但对于大量使用 Redis 的应用可能会带来更好的性能。如果你使用的是 Laravel Sail，此扩展已安装在你的应用 Docker 容器中。
如果你无法安装 PhpRedis 扩展，可以通过 Composer 安装 predis/predis 包。Predis 是一个完全用 PHP 编写的 Redis 客户端，不需要任何额外的扩展：
composer require predis/predis
典型使用场景：
- 缓存加速：使用 Redis 缓存数据库查询结果、API 响应或渲染后的视图，大幅减少数据库压力
- 会话存储：将用户会话数据存储在 Redis 中，实现多服务器间的分布式会话共享
- 队列驱动：使用 Redis 作为 Laravel 队列的底层驱动，高效处理异步任务（如邮件发送、报表生成）
- 实时通信：利用 Redis 的 Pub/Sub 功能实现应用间的实时消息推送，如聊天室、实时通知
- 计数器与限流：使用 Redis 的原子递增操作实现页面访问计数、API 速率限制
- 排行榜：利用 Redis 有序集合（Sorted Set）实现实时排行榜，如游戏积分、热门内容排名
配置
你可以通过 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'),
],
],
],
// ...
],
默认情况下，由于 options.cluster 配置值设置为 redis，Laravel 将使用原生 Redis 集群。Redis 集群是一个很好的默认选项，因为它能优雅地处理故障转移。
使用 Predis 时，Laravel 还支持客户端分片。然而，客户端分片不处理故障转移；因此，它主要适用于可从其他主数据存储获取的临时缓存数据。
如果你想使用客户端分片而不是原生 Redis 集群，可以在应用的 config/database.php 配置文件中移除 options.cluster 配置值：
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'clusters' => [
// ...
],
// ...
],
Predis
如果你希望应用通过 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,
],
PhpRedis
默认情况下，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 和 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),
],
Predis 3.4.0 及更高版本通过 Retry 类支持内置的重试和退避配置。你可以使用 max_retries 选项配置重试次数，并使用 retry 选项配置退避策略。retry 选项应是一个数组，以下列策略类之一为键：NoBackoff、EqualBackoff 或 ExponentialBackoff：
use Predis\Retry\Strategy\ExponentialBackoff;
'default' => [
'url' => env('REDIS_URL'),
// ...
'retry' => [
ExponentialBackoff::class => [
env('REDIS_BACKOFF_BASE', 100),
env('REDIS_BACKOFF_CAP', 1000),
true, // 启用抖动...
],
],
'max_retries' => env('REDIS_MAX_RETRIES', 3),
],
在 Redis 集群中使用 Predis 时，你可以在集群配置的 parameters 选项中定义重试配置：
use Predis\Retry\Strategy\NoBackoff;
'clusters' => [
'default' => [
// ...
],
],
'options' => [
'cluster' => env('REDIS_CLUSTER', 'redis'),
'parameters' => [
'retry' => [
NoBackoff::class => [],
],
'max_retries' => env('REDIS_MAX_RETRIES', 3),
],
],
Unix Socket 连接
Redis 连接也可以配置为使用 Unix socket 而不是 TCP。对于与应用在同一服务器上的 Redis 实例，这可以通过消除 TCP 开销来提高性能。要将 Redis 配置为使用 Unix socket，请将 REDIS_HOST 环境变量设置为 Redis socket 的路径，并将 REDIS_PORT 环境变量设置为 0：
REDIS_HOST=/run/redis/redis.sock
REDIS_PORT=0
PhpRedis 序列化与压缩
PhpRedis 扩展还可以配置为使用各种序列化器和压缩算法。这些算法可以通过 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。在这个例子中，我们将通过调用 Redis 门面上的 get 方法来调用 Redis 的 GET 命令：
<?php
namespace App\Http\Controllers;
use Illuminate\Support\Facades\Redis;
use Illuminate\View\View;
class UserController extends Controller
{
/**
* 显示给定用户的个人资料。
*/
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]);
使用多个 Redis 连接
应用的 config/database.php 配置文件允许你定义多个 Redis 连接/服务器。你可以使用 Redis 门面的 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 连接中获取任何值。请记住，你的事务作为单个原子操作执行，并且该操作在整个闭包完成执行其命令之前不会执行。
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 命令。与其为每个命令都进行一次网络往返到 Redis 服务器，不如使用 pipeline 方法。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 为 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 = 'Subscribe to a Redis channel';
/**
* 执行控制台命令。
*/
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;
});