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'),
    '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' => env('REDIS_URL', 'tcp://127.0.0.1:6379?database=0'),
    ],
    'cache' => [
        'url' => env('REDIS_URL', 'tcp://127.0.0.1:6379?database=1'),
    ],
],

配置连接方案

默认情况下,Redis 客户端在连接到 Redis 服务器时将使用 tcp 方案。但是,您可以通过在 Redis 服务器的配置数组中设置 scheme 配置选项来使用 TLS / SSL 加密:

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

集群

如果您的应用程序正在使用一组 Redis 服务器,则应在 Redis 配置的 clusters 键内定义这些集群。默认情况下,此配置键不存在,因此您需要在应用程序的 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'),
    // ...
],

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

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

Redis 门面别名

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

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

phpredis

默认情况下,Laravel 使用 phpredis 扩展与 Redis 进行通信。Laravel 通过 redis.client 配置选项决定与 Redis 进行通信的客户端,该配置选项通常反映 REDIS_CLIENT 环境变量的值:

'redis' => [
    'client' => env('REDIS_CLIENT', 'phpredis'),
    // ...
],

除了默认的 schemehostportdatabasepassword 服务器配置选项之外,phpredis 支持以下附加连接参数:namepersistentpersistent_idprefixread_timeoutretry_intervaltimeoutcontext。您可以将这些选项中的任何一个添加到 config/database.php 配置文件中的 Redis 服务器配置中:

'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 扩展还可以配置使用各种序列化和压缩算法。这些算法可以通过 Redis 配置的 options 数组进行配置:

'redis' => [
    'client' => env('REDIS_CLIENT', 'phpredis'),
    'options' => [
        'serializer' => Redis::SERIALIZER_MSGPACK,
        'compression' => Redis::COMPRESSION_LZ4,
    ],
    // ...
],

目前支持的序列化算法包括:Redis::SERIALIZER_NONE(默认),Redis::SERIALIZER_PHPRedis::SERIALIZER_JSONRedis::SERIALIZER_IGBINARYRedis::SERIALIZER_MSGPACK

支持的压缩算法包括:Redis::COMPRESSION_NONE(默认),Redis::COMPRESSION_LZFRedis::COMPRESSION_ZSTDRedis::COMPRESSION_LZ4

操作 Redis

您可以通过在 Redis 门面 上调用各种方法来与 Redis 进行交互。Redis 门面支持动态方法,这意味着您可以调用门面上的任何 Redis 命令,并且该命令将直接传递给 Redis。在下面的示例中,我们将通过在 Redis Facade 上调用 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);

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

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

使用多个 Redis 连接

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

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

要获取默认 Redis 连接的实例,可以调用 connection 方法而不附加任何其他参数:

$redis = Redis::connection();

事务

Redis 门面的 transaction 方法提供了一个方便的包装器,用于 Redis 的原生 MULTIEXEC 命令。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 脚本(作为字符串)传递给这个方法。其次,您应该传递执行脚本与之交互的键的数量(作为整数)。然后,您应该传递那些键的名称。最后,您可以传递任何其他需要在脚本内部访问的附加参数。

在下面的示例中,我们将递增一个计数器,检查其新值,并且如果第一个计数器的值大于五,则递增第二个计数器。最后,我们将返回第一个计数器的值:

$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 命令。您可以使用 pipeline 方法而不是为每个命令向 Redis 服务器发起一次网络请求。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);
    }
});Redis::pipeline(function ($pipe) {
    for ($i = 0; $i < 1000; $i++) {
        $pipe->set("key:$i", $i);
    }
});

Pub / Sub

Laravel 提供了一个方便的接口来使用 Redis 的 publishsubscribe 命令。这些 Redis 命令允许您在给定的“频道”上监听消息。您可以从另一个应用程序或甚至使用其他编程语言在频道上发布消息,从而在应用程序和进程之间实现轻松的通信。

首先,让我们使用 subscribe 方法设置一个频道监听器。因为调用 subscribe 方法会启动一个长时间运行的过程,所以我们将此方法调用放在 Artisan 命令 中:

<?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.
     *
     * @return void
     */
    public function handle()
    {
        Redis::subscribe(['test-channel'], function ($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;
});

Vote Vote Cancel Collect Collect Cancel

<< 上一篇: 填充

>> 下一篇: 快速入门