Redis

介绍
配置
与 Redis 交互
- 交易
- 流水线命令
发布/订阅

介绍

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

在 Laravel 中使用 Redis 之前，我们建议您通过 PECL 安装并使用PhpRedis PHP 扩展。与“用户级” PHP 软件包相比，该扩展的安装更为复杂，但对于大量使用 Redis 的应用程序来说，可能会带来更好的性能。如果您使用的是Laravel Sail，则此扩展已安装在应用程序的 Docker 容器中。

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

1composer require predis/predis:^2.0

composer require predis/predis:^2.0

配置

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

 1'redis' => [
 2 
 3    'client' => env('REDIS_CLIENT', 'phpredis'),
 4 
 5    'options' => [
 6        'cluster' => env('REDIS_CLUSTER', 'redis'),
 7        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
 8    ],
 9 
10    'default' => [
11        'url' => env('REDIS_URL'),
12        'host' => env('REDIS_HOST', '127.0.0.1'),
13        'username' => env('REDIS_USERNAME'),
14        'password' => env('REDIS_PASSWORD'),
15        'port' => env('REDIS_PORT', '6379'),
16        'database' => env('REDIS_DB', '0'),
17    ],
18 
19    'cache' => [
20        'url' => env('REDIS_URL'),
21        'host' => env('REDIS_HOST', '127.0.0.1'),
22        'username' => env('REDIS_USERNAME'),
23        'password' => env('REDIS_PASSWORD'),
24        'port' => env('REDIS_PORT', '6379'),
25        'database' => env('REDIS_CACHE_DB', '1'),
26    ],
27 
28],

'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 连接：

 1'redis' => [
 2 
 3    'client' => env('REDIS_CLIENT', 'phpredis'),
 4 
 5    'options' => [
 6        'cluster' => env('REDIS_CLUSTER', 'redis'),
 7        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
 8    ],
 9 
10    'default' => [
11        'url' => 'tcp://127.0.0.1:6379?database=0',
12    ],
13 
14    'cache' => [
15        'url' => 'tls://user:password@127.0.0.1:6380?database=1',
16    ],
17 
18],

'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 服务器时将使用该方案；但是，您可以通过scheme在 Redis 服务器的配置数组中指定配置选项来使用 TLS / SSL 加密：

1'default' => [
2    'scheme' => 'tls',
3    'url' => env('REDIS_URL'),
4    'host' => env('REDIS_HOST', '127.0.0.1'),
5    'username' => env('REDIS_USERNAME'),
6    'password' => env('REDIS_PASSWORD'),
7    'port' => env('REDIS_PORT', '6379'),
8    'database' => env('REDIS_DB', '0'),
9],

'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 服务器集群，则应在clustersRedis 配置的键中定义这些集群。此配置键默认不存在，因此您需要在应用程序的config/database.php配置文件中创建它：

 1'redis' => [
 2 
 3    'client' => env('REDIS_CLIENT', 'phpredis'),
 4 
 5    'options' => [
 6        'cluster' => env('REDIS_CLUSTER', 'redis'),
 7        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
 8    ],
 9 
10    'clusters' => [
11        'default' => [
12            [
13                'url' => env('REDIS_URL'),
14                'host' => env('REDIS_HOST', '127.0.0.1'),
15                'username' => env('REDIS_USERNAME'),
16                'password' => env('REDIS_PASSWORD'),
17                'port' => env('REDIS_PORT', '6379'),
18                'database' => env('REDIS_DB', '0'),
19            ],
20        ],
21    ],
22 
23    // ...
24],

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

    // ...
],

默认情况下，由于options.cluster配置值设置为，Laravel 将使用原生 Redis 集群redis。Redis 集群是一个很好的默认选项，因为它可以优雅地处理故障转移。

Laravel 在使用 Predis 时也支持客户端分片。然而，客户端分片不支持故障转移；因此，它主要适用于可从其他主数据存储获取的临时缓存数据。

如果您想使用客户端分片而不是原生 Redis 集群，您可以删除options.cluster应用程序config/database.php配置文件中的配置值：

 1'redis' => [
 2 
 3    'client' => env('REDIS_CLIENT', 'phpredis'),
 4 
 5    'clusters' => [
 6        // ...
 7    ],
 8 
 9    // ...
10],

'redis' => [

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

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

    // ...
],

普雷迪斯

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

1'redis' => [
2 
3    'client' => env('REDIS_CLIENT', 'predis'),
4 
5    // ...
6],

'redis' => [

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

    // ...
],

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

1'default' => [
2    'url' => env('REDIS_URL'),
3    'host' => env('REDIS_HOST', '127.0.0.1'),
4    'username' => env('REDIS_USERNAME'),
5    'password' => env('REDIS_PASSWORD'),
6    'port' => env('REDIS_PORT', '6379'),
7    'database' => env('REDIS_DB', '0'),
8    'read_write_timeout' => 60,
9],

'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：

1'redis' => [
2 
3    'client' => env('REDIS_CLIENT', 'phpredis'),
4 
5    // ...
6],

'redis' => [

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

    // ...
],

除了默认配置选项外，PhpRedis 还支持以下附加连接参数：name、persistent、persistent_id、prefix、read_timeout、retry_interval、max_retries、backoff_algorithm、、和。您可以在配置文件中将backoff_base以下任何选项添加到 Redis 服务器配置中：backoff_captimeoutcontextconfig/database.php

 1'default' => [
 2    'url' => env('REDIS_URL'),
 3    'host' => env('REDIS_HOST', '127.0.0.1'),
 4    'username' => env('REDIS_USERNAME'),
 5    'password' => env('REDIS_PASSWORD'),
 6    'port' => env('REDIS_PORT', '6379'),
 7    'database' => env('REDIS_DB', '0'),
 8    'read_timeout' => 60,
 9    'context' => [
10        // 'auth' => ['username', 'secret'],
11        // 'stream' => ['verify_peer' => false],
12    ],
13],

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

Unix 套接字连接

Redis 连接也可以配置为使用 Unix 套接字而非 TCP。这样可以消除与应用程序位于同一服务器上的 Redis 实例的连接 TCP 开销，从而提高性能。要将 Redis 配置为使用 Unix 套接字，请将REDIS_HOST环境变量设置为 Redis 套接字的路径，并将REDIS_PORT环境变量设置为0：

1REDIS_HOST=/run/redis/redis.sock
2REDIS_PORT=0

REDIS_HOST=/run/redis/redis.sock
REDIS_PORT=0

PhpRedis 序列化和压缩

PhpRedis 扩展还可以配置使用各种序列化器和压缩算法。这些算法可以通过optionsRedis 配置的数组进行配置：

 1'redis' => [
 2 
 3    'client' => env('REDIS_CLIENT', 'phpredis'),
 4 
 5    'options' => [
 6        'cluster' => env('REDIS_CLUSTER', 'redis'),
 7        'prefix' => env('REDIS_PREFIX', Str::slug(env('APP_NAME', 'laravel'), '_').'_database_'),
 8        'serializer' => Redis::SERIALIZER_MSGPACK,
 9        'compression' => Redis::COMPRESSION_LZ4,
10    ],
11 
12    // ...
13],

'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_JSONRedis::SERIALIZER_IGBINARYRedis::SERIALIZER_MSGPACK

支持的压缩算法包括：（Redis::COMPRESSION_NONE默认）Redis::COMPRESSION_LZF、、Redis::COMPRESSION_ZSTD和Redis::COMPRESSION_LZ4。

与 Redis 交互

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

 1<?php
 2 
 3namespace App\Http\Controllers;
 4 
 5use Illuminate\Support\Facades\Redis;
 6use Illuminate\View\View;
 7 
 8class UserController extends Controller
 9{
10    /**
11     * Show the profile for the given user.
12     */
13    public function show(string $id): View
14    {
15        return view('user.profile', [
16            'user' => Redis::get('user:profile:'.$id)
17        ]);
18    }
19}

<?php

namespace App\Http\Controllers;

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 命令需要参数，则应将参数传递给外观层对应的方法：

1use Illuminate\Support\Facades\Redis;
2 
3Redis::set('name', 'Taylor');
4 
5$values = Redis::lrange('names', 5, 10);

use Illuminate\Support\Facades\Redis;

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

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

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

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

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

使用多个 Redis 连接

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

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

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

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

1$redis = Redis::connection();

$redis = Redis::connection();

交易

FacadeRedis的transaction方法提供了一个便捷的 Redis 原生命令包装器MULTI。EXEC该transaction方法接受一个闭包作为其唯一参数。该闭包将接收一个 Redis 连接实例，并可以向该实例发出任何所需的命令。所有在闭包中发出的 Redis 命令都将在单个原子事务中执行：

1use Redis;
2use Illuminate\Support\Facades;
3 
4Facades\Redis::transaction(function (Redis $redis) {
5    $redis->incr('user_visits', 1);
6    $redis->incr('total_visits', 1);
7});

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，则增加第二个计数器的值。最后，我们将返回第一个计数器的值：

1$value = Redis::eval(<<<'LUA'
2    local counter = redis.call("incr", KEYS[1])
3 
4    if counter > 5 then
5        redis.call("incr", KEYS[2])
6    end
7 
8    return counter
9LUA, 2, 'first-counter', 'second-counter');

$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 文档。

流水线命令

pipeline有时您可能需要执行数十个 Redis 命令。您可以使用该方法，而不必为每个命令都与 Redis 服务器进行网络通信。该pipeline方法接受一个参数：一个接收 Redis 实例的闭包。您可以向此 Redis 实例发出所有命令，它们将同时发送到 Redis 服务器，以减少与服务器的网络通信次数。这些命令仍将按照发出的顺序执行：

1use Redis;
2use Illuminate\Support\Facades;
3 
4Facades\Redis::pipeline(function (Redis $pipe) {
5    for ($i = 0; $i < 1000; $i++) {
6        $pipe->set("key:$i", $i);
7    }
8});

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方法会启动一个长时间运行的进程：

 1<?php
 2 
 3namespace App\Console\Commands;
 4 
 5use Illuminate\Console\Command;
 6use Illuminate\Support\Facades\Redis;
 7 
 8class RedisSubscribe extends Command
 9{
10    /**
11     * The name and signature of the console command.
12     *
13     * @var string
14     */
15    protected $signature = 'redis:subscribe';
16 
17    /**
18     * The console command description.
19     *
20     * @var string
21     */
22    protected $description = 'Subscribe to a Redis channel';
23 
24    /**
25     * Execute the console command.
26     */
27    public function handle(): void
28    {
29        Redis::subscribe(['test-channel'], function (string $message) {
30            echo $message;
31        });
32    }
33}

<?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：

1use Illuminate\Support\Facades\Redis;
2 
3Route::get('/publish', function () {
4    // ...
5 
6    Redis::publish('test-channel', json_encode([
7        'name' => 'Adam Wathan'
8    ]));
9});

use Illuminate\Support\Facades\Redis;

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

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

通配符订阅

使用该psubscribe方法，你可以订阅一个通配符频道，这在捕获所有频道上的所有消息时很有用。频道名称将作为第二个参数传递给提供的闭包：

1Redis::psubscribe(['*'], function (string $message, string $channel) {
2    echo $message;
3});
4 
5Redis::psubscribe(['users.*'], function (string $message, string $channel) {
6    echo $message;
7});

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

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

序幕

入门

架构概念

基础知识

深入挖掘

安全

数据库

Eloquent ORM

测试

Packages

Redis

介绍

配置

配置连接方案

集群

普雷迪斯

PhpRedis

Unix 套接字连接

PhpRedis 序列化和压缩

与 Redis 交互

使用多个 Redis 连接

交易

Lua脚本

流水线命令

发布/订阅

通配符订阅

本页内容