Redis

• Introduction
• Configuration
  • Clusters
  • Predis
  • phpredis
• 与 Redis 交互
  • Transactions
  • 流水线命令
• 发布/订阅

#Introduction

Redis 是一种开源的高级键值存储。它通常被称为数据结构服务器，因为键可以包含strings,hashes,lists,sets， 和排序集.

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

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

composer require predis/predis

#Configuration

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

'redis' => [

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

    'default' => [
        'host' => env('REDIS_HOST', '127.0.0.1'),
        'password' => env('REDIS_PASSWORD'),
        'port' => env('REDIS_PORT', 6379),
        'database' => env('REDIS_DB', 0),
    ],

    'cache' => [
        'host' => env('REDIS_HOST', '127.0.0.1'),
        'password' => env('REDIS_PASSWORD'),
        'port' => env('REDIS_PORT', 6379),
        'database' => env('REDIS_CACHE_DB', 1),
    ],

],

配置文件中定义的每个 Redis 服务器都需要有名称、主机和端口，除非您定义单个 URL 来表示 Redis 连接：

'redis' => [

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

    '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 服务器时的方案；但是，您可以通过指定一个scheme Redis 服务器配置数组中的配置选项：

'redis' => [

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

    'default' => [
        'scheme' => 'tls',
        'host' => env('REDIS_HOST', '127.0.0.1'),
        'password' => env('REDIS_PASSWORD'),
        'port' => env('REDIS_PORT', 6379),
        'database' => env('REDIS_DB', 0),
    ],

],

#Clusters

如果您的应用程序正在使用 Redis 服务器集群，您应该在一个clusters Redis 配置的键。默认情况下不存在此配置密钥，因此您需要在应用程序的config/database.php 配置文件：

'redis' => [

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

    'clusters' => [
        'default' => [
            [
                'host' => env('REDIS_HOST', 'localhost'),
                'password' => env('REDIS_PASSWORD'),
                'port' => env('REDIS_PORT', 6379),
                'database' => 0,
            ],
        ],
    ],

],

默认情况下，集群将在您的节点之间执行客户端分片，从而允许您汇集节点并创建大量可用 RAM。但是，客户端分片不处理故障转移；因此，它主要适用于可从另一个主要数据存储中获得的临时缓存数据。

如果您想使用本机 Redis 集群而不是客户端分片，您可以通过设置options.cluster 配置值为redis 在你的应用程序中config/database.php 配置文件：

'redis' => [

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

    'options' => [
        'cluster' => env('REDIS_CLUSTER', 'redis'),
    ],

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

],

#Predis

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

'redis' => [

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

    // ...
],

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

'default' => [
    'host' => env('REDIS_HOST', 'localhost'),
    'password' => env('REDIS_PASSWORD'),
    'port' => env('REDIS_PORT', 6379),
    'database' => 0,
    'read_write_timeout' => 60,
],

Redis Facade 别名

Laravel 的config/app.php 配置文件包含一个aliases 定义将由框架注册的所有类别名的数组。默认情况下，没有Redis 包含别名是因为它会与Redis phpredis 扩展提供的类名。如果您正在使用 Predis 客户端并想添加一个Redis 别名，您可以将其添加到aliases 应用程序中的数组config/app.php 配置文件：

'aliases' => Facade::defaultAliases()->merge([
    'Redis' => Illuminate\Support\Facades\Redis::class,
])->toArray(),

#phpredis

默认情况下，Laravel 将使用 phpredis 扩展与 Redis 通信。 Laravel 将用来与 Redis 通信的客户端由redis.client 配置选项，它通常反映了REDIS_CLIENT 环境变量：

'redis' => [

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

    // Rest of Redis configuration...
],

除了默认scheme,host,port,database， 和password 服务器配置选项，phpredis 支持以下附加连接参数：name,persistent,persistent_id,prefix,read_timeout,retry_interval,timeout， 和context.您可以将这些选项中的任何一个添加到您的 Redis 服务器配置中config/database.php 配置文件：

'default' => [
    'host' => env('REDIS_HOST', 'localhost'),
    'password' => env('REDIS_PASSWORD'),
    'port' => env('REDIS_PORT', 6379),
    'database' => 0,
    'read_timeout' => 60,
    'context' => [
        // 'auth' => ['username', 'secret'],
        // 'stream' => ['verify_peer' => false],
    ],
],

phpredis 序列化和压缩

phpredis 扩展也可以配置为使用各种序列化和压缩算法。这些算法可以通过配置options 您的 Redis 配置数组：

'redis' => [

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

    'options' => [
        'serializer' => Redis::SERIALIZER_MSGPACK,
        'compression' => Redis::COMPRESSION_LZ4,
    ],

    // Rest of Redis configuration...
],

目前支持的序列化算法包括：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 facade.这Redis facade 支持动态方法，这意味着你可以调用任何Redis命令 在外观上，命令将直接传递给 Redis。在这个例子中，我们将调用 RedisGET 通过调用命令get 上的方法Redis 正面：

<?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 命令需要参数，您应该将这些参数传递给 facade 的相应方法：

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 连接的连接Redis 门面的connection 方法：

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

要获取默认 Redis 连接的实例，您可以调用connection 没有任何附加参数的方法：

$redis = Redis::connection();

#Transactions

这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);
});

Warning
定义 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');

Warning
请咨询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 方法。我们将把这个方法调用放在一个工匠命令 自从打电话给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;
});