Redis

简介

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 服务器都必须包含 name、host 和 port，除非你使用单一 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 客户端会使用 tcp 协议连接 Redis 服务器；如果你希望使用 TLS/SSL 加密，可以在 Redis 服务器的配置数组中指定 scheme 选项：

'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 集群是一个很好的默认选择，它能优雅地处理故障转移。

当使用 Predis 时，Laravel 也支持客户端分片（client-side sharding）。然而，客户端分片不支持故障转移，因此它主要适用于那些可以从其他主数据源获取的临时缓存数据。

如果你希望使用客户端分片而非原生 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),
],

Unix Socket 连接

Redis 也可以配置为使用 Unix 套接字而非 TCP，这样可以减少与同一服务器上的 Redis 实例通信时的 TCP 开销，从而提高性能。要使用 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(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 facade 的各种方法与 Redis 进行交互。Redis facade 支持动态方法，这意味着你可以在 facade 上调用任何 Redis 命令，命令会被直接传递给 Redis。例如，我们可以通过调用 Redis facade 的 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 facade 上调用 Redis 的任意命令。Laravel 使用魔术方法将命令传递给 Redis 服务器。如果 Redis 命令需要参数，你应将参数传递给 facade 的对应方法：

use Illuminate\Support\Facades\Redis;

Redis::set('name', 'Taylor');

$values = Redis::lrange('names', 5, 10);

或者，你可以使用 Redis facade 的 command 方法向服务器发送命令，第一个参数为命令名，第二个参数为命令参数数组：

$values = Redis::command('lrange', ['name', 5, 10]);

使用多个 Redis 连接

你可以在应用的 config/database.php 配置文件中定义多个 Redis 连接/服务器。要获取特定 Redis 连接的实例，可以使用 Redis facade 的 connection 方法：

$redis = Redis::connection('connection-name');

如果想获取默认 Redis 连接的实例，可以直接调用 connection 方法而不传入任何参数：

$redis = Redis::connection();

事务

Redis facade 的 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 方法需要几个参数：首先传入 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 官方文档。

命令流水线

有时你可能需要执行数十条 Redis 命令。与其为每条命令都向 Redis 服务器发起一次网络请求，不如使用 pipeline 方法。pipeline 方法接收一个参数：一个闭包，该闭包会接收一个 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);
    }
});

通过使用 pipeline，你可以显著提高批量操作的性能。

发布 / 订阅

Laravel 提供了一个便捷的接口来使用 Redis 的发布（publish）和订阅（subscribe）命令。这些 Redis 命令允许你监听指定“频道”上的消息。你可以从另一个应用程序，甚至使用其他编程语言向频道发布消息，从而轻松实现应用程序和进程之间的通信。

首先，我们使用 subscribe 方法设置一个频道监听器。由于调用 subscribe 方法会启动一个长时间运行的进程，因此通常将其放在 Artisan 命令中：

<?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 = '订阅 Redis 频道';

    /**
     * 执行控制台命令
     */
    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;
});

这种方式可以灵活监听单个频道或多个频道的消息，实现高效的消息通信。

种子

MongoDB