跳至内容
Laravel

Redis

简介

Redis 是一个开源的先进键值存储。它通常被称为数据结构服务器，因为键可以包含 字符串、哈希、列表、集合 和 有序集合.

在使用 Redis 与 Laravel 之前，我们建议您使用 PECL 安装并使用 PhpRedis PHP 扩展。与“用户层”PHP 包相比，该扩展安装起来更复杂，但对于大量使用 Redis 的应用程序，它可能会提供更好的性能。如果您使用的是 Laravel Sail，则该扩展已安装在您应用程序的 Docker 容器中。

如果您无法安装 PhpRedis 扩展，则可以通过 Composer 安装 predis/predis 包。Predis 是一个完全用 PHP 编写的 Redis 客户端，不需要任何额外的扩展。

composer require predis/predis:^2.0

配置

您可以通过 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 服务器都需要有一个名称、主机和端口，除非您定义一个表示 Redis 连接的单个 URL。

'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:[email protected]: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 还支持客户端分片。但是，客户端分片不处理故障转移；因此，它主要适合于可以从另一个主数据存储中获取的瞬态缓存数据。

如果您想使用客户端分片而不是原生 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、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],
    ],
],

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 App\Http\Controllers\Controller;
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]);

使用多个 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);
});
exclamation

在定义 Redis 事务时，您可能无法从 Redis 连接中检索任何值。请记住，您的事务将作为一个单独的原子操作执行，并且该操作只有在整个闭包完成执行其命令后才会执行。

Lua 脚本

eval 方法提供了另一种在单个原子操作中执行多个 Redis 命令的方法。但是，eval 方法的好处是能够在该操作期间与 Redis 键值交互和检查它们。Redis 脚本是用 Lua 编程语言 编写的。

eval 方法刚开始可能有点吓人，但我们将探讨一个基本的例子来打破僵局。eval 方法需要几个参数。首先，您应该将 Lua 脚本（作为字符串）传递给该方法。其次，您应该传递脚本交互的键数量（作为整数）。第三，您应该传递这些键的名称。最后，您可以传递任何其他您需要在脚本中访问的额外参数。

在这个例子中，我们将增加一个计数器，检查其新的值，并在第一个计数器的值大于 5 时增加第二个计数器。最后，我们将返回第一个计数器的值。

$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');
exclamation

有关 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
{
    /**
     * 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;
});