Redis-Laravel 文档-果果开发

简介

Redis 是一个开源的高级键值存储系统。它常被称为数据结构服务器，因为其键可以包含字符串、哈希、列表、集合以及有序集合。

在 Laravel 中使用 Redis 之前，我们建议您通过 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((string) 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((string) 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((string) 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),
],

在发生临时连接失败后，Laravel 会自动对安全的读取命令进行一次重试。您可以使用 command_retries 选项来配置所有 Redis 命令的重试次数：

'default' => [
    // ...
    'command_retries' => env('REDIS_COMMAND_RETRIES', 0),
],

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 套接字而非 TCP。对于连接到与应用程序在同一服务器上的 Redis 实例，这可以通过消除 TCP 开销来提升性能。要将 Redis 配置为使用 Unix 套接字，请将 REDIS_HOST 环境变量设置为 Redis 套接字的路径，并将 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((string) 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 脚本（以字符串形式）传递给该方法。其次，您应传递脚本所操作的键的数量（以整数形式）。第三，您应传递这些键的名称。最后，您可以传递脚本内需要访问的任何其他附加参数。

在此示例中，我们将递增一个计数器，检查其新值，并在第一个计数器的值大于 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');

如需了解更多关于 Redis 脚本的信息，请参阅 Redis 文档。

命令管道（Pipelining）

有时您可能需要执行数十条 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;
});