后盾人

Appearance

Redis ​

介绍 ​

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

在将 Redis 与 Laravel 一起使用之前，我们鼓励您通过 PECL 安装和使用 PhpRedis PHP 扩展。与“用户空间”PHP 包相比，该扩展的安装更复杂，但对于大量使用 Redis 的应用程序可能会产生更好的性能。如果您使用的是 Laravel Sail，则此扩展已安装在应用程序的 Docker 容器中。

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

shell
composer require predis/predis:^2.0

配置 ​

您可以通过 config/database.php 配置文件配置应用程序的 Redis 设置。在此文件中，您将看到一个 redis 数组，其中包含您的应用程序使用的 Redis 服务器:

php
    '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 连接:

php
    '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 加密:

php
    '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'),
    ],

Clusters 集群 ​

如果您的应用程序正在使用 Redis 服务器集群，则应在 Redis 配置的 clusters key 中定义这些集群。默认情况下，此配置键不存在，因此您需要在应用程序的 config/database.php 配置文件中创建它:

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 配置值:

php
    'redis' => [

        'client' => env('REDIS_CLIENT', 'phpredis'),

        'clusters' => [
            // ...
        ],

        // ...
    ],

Predis ​

如果您希望应用程序通过 Predis 包与 Redis 交互，则应确保 REDIS_CLIENT 环境变量的值为 predis:

php
    'redis' => [

        'client' => env('REDIS_CLIENT', 'predis'),

        // ...
    ],

除了默认配置选项之外，Predis 还支持可能为每个 Redis 服务器定义的其他连接参数。要使用这些额外的配置选项，请将它们添加到应用程序的 config/database.php 配置文件中的 Redis 服务器配置中:

php
    '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 环境变量的值:

php
    'redis' => [

        'client' => env('REDIS_CLIENT', 'phpredis'),

        // ...
    ],

除了默认配置选项外，PhpRedis 还支持以下其他连接参数:name、persistent、persistent_id、prefix、read_timeout、retry_interval、timeout 和 context。您可以在 config/database.php 配置文件中将这些选项中的任何一个添加到您的 Redis 服务器配置中:

php
    '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 数组进行配置:

php
    '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 交互 ​

您可以通过调用 Redisfacade的各种方法来与 Redis 交互。Redis Facade 支持动态方法，这意味着您可以在 Facade 上调用任何 Redis 命令，该命令将直接传递给 Redis。在此示例中，我们将通过调用 Redis Facade上的 get 方法来调用 Redis GET 命令:

php
    <?php

    namespace App\Http\Controllers;

    use App\Http\Controllers\Controller;
    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 命令需要参数，则应将这些参数传递给 Facade 的相应方法:

php
    use Illuminate\Support\Facades\Redis;

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

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

或者，您可以使用 Redis Facade 的 command 方法将命令传递给服务器，该方法接受命令名称作为其第一个参数，并接受一个值数组作为其第二个参数:

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

使用多个 Redis 连接 ​

应用程序的 config/database.php 配置文件允许您定义多个 Redis 连接/服务器。您可以使用 Redis Facade 的连接方法获取与特定 Redis 连接的连接:

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

要获取默认 Redis 连接的实例，您可以调用 connection 方法，而无需任何其他参数:

php
    $redis = Redis::connection();

交易 ​

Redis Facade的事务方法为 Redis 的原生 MULTI 和 EXEC 命令提供了一个方便的包装器。transaction 方法接受 closure 作为其唯一参数。此 closure 将接收一个 Redis 连接实例，并可能向该实例发出它想要的任何命令。在 closure 中发出的所有 Redis 命令都将在单个原子事务中执行:

php
    use Redis;
    use Illuminate\Support\Facades;

    Facades\Redis::transaction(function (Redis $redis) {
        $redis->incr('user_visits', 1);
        $redis->incr('total_visits', 1);
    });

WARNING

定义 Redis 事务时，您不能从 Redis 连接中检索任何值。请记住，你的事务是作为一个单一的原子操作来执行的，在你的整个 closure 完成执行其命令之前，该操作不会执行。

Lua 脚本 ​

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

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

在此示例中，我们将递增一个计数器，检查其新值，如果第一个计数器的值大于 5，则递增第二个计数器。最后，我们将返回第一个计数器的值:

php
    $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 服务器进行网络访问。管道方法接受一个参数:接收 Redis 实例的闭包。您可以向此 Redis 实例发出所有命令，这些命令都将同时发送到 Redis 服务器，以减少对服务器的网络访问。命令仍将按照发出的顺序执行:

php
    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 命令允许您侦听给定 “channel” 上的消息。您可以从其他应用程序甚至使用其他编程语言将消息发布到通道，从而允许应用程序和进程之间轻松通信。

首先，让我们使用 subscribe 方法设置一个 channel listener。我们将此方法调用放在 Artisan 命令中，因为调用 subscribe 方法会开始一个长时间运行的进程:

php
    <?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 方法将消息发布到频道:

php
    use Illuminate\Support\Facades\Redis;

    Route::get('/publish', function () {
        // ...

        Redis::publish('test-channel', json_encode([
            'name' => 'Adam Wathan'
        ]));
    });

通配符订阅 ​

使用 psubscribe 方法，您可以订阅通配符通道，这对于捕获所有通道上的所有消息可能很有用。通道名称将作为第二个参数传递给提供的闭包:

php
    Redis::psubscribe(['*'], function (string $message, string $channel) {
        echo $message;
    });

    Redis::psubscribe(['users.*'], function (string $message, string $channel) {
        echo $message;
    });

后盾人版权所有 © 2018-2024 创作不易请尊重他人劳动成果，未经授权禁止转载！