Redis

• 介绍
  • 配置
  • Predis
  • PhpRedis
• 与 Redis 交互
  • 管道命令
• 发布/订阅

介绍

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

在将 Redis 与 Laravel 一起使用之前，您需要通过 Composer 安装 predis/predis 包：

composer require predis/predis

或者，您可以通过 PECL 安装 PhpRedis PHP 扩展。该扩展的安装更为复杂，但对于大量使用 Redis 的应用程序可能会带来更好的性能。

配置

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

'redis' => [

    'client' => 'predis',

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

],

默认的服务器配置应足以用于开发。然而，您可以根据环境自由修改此数组。配置文件中定义的每个 Redis 服务器都需要有一个名称、主机和端口。

配置集群

如果您的应用程序使用的是 Redis 服务器集群，您应该在 Redis 配置的 clusters 键中定义这些集群：

'redis' => [

    'client' => 'predis',

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

],

默认情况下，集群将在您的节点之间执行客户端侧分片，允许您池化节点并创建大量可用的 RAM。然而，请注意，客户端侧分片不处理故障转移；因此，主要适用于可从其他主数据存储中获取的缓存数据。如果您希望使用原生 Redis 集群，您应该在 Redis 配置的 options 键中指定：

'redis' => [

    'client' => 'predis',

    'options' => [
        'cluster' => 'redis',
    ],

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

],

Predis

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

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

PhpRedis

如果您通过 PECL 安装了 PhpRedis PHP 扩展，您需要在 config/app.php 配置文件中重命名 Redis 别名。

要使用 PhpRedis 扩展，您应该将 Redis 配置的 client 选项更改为 phpredis。此选项位于 config/database.php 配置文件中：

'redis' => [

    'client' => 'phpredis',

    // 其余的 Redis 配置...
],

除了默认的 host、port、database 和 password 服务器配置选项外，PhpRedis 支持以下额外的连接参数：persistent、prefix、read_timeout 和 timeout。您可以将这些选项添加到 config/database.php 配置文件中的 Redis 服务器配置中：

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

与 Redis 交互

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

<?php

namespace App\Http\Controllers;

use App\Http\Controllers\Controller;
use Illuminate\Support\Facades\Redis;

class UserController extends Controller
{
    /**
     * 显示给定用户的个人资料。
     *
     * @param  int  $id
     * @return Response
     */
    public function showProfile($id)
    {
        $user = Redis::get('user:profile:'.$id);

        return view('user.profile', ['user' => $user]);
    }
}

当然，如上所述，您可以在 Redis facade 上调用任何 Redis 命令。Laravel 使用魔术方法将命令传递给 Redis 服务器，因此传递 Redis 命令期望的参数：

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

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

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

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

使用多个 Redis 连接

您可以通过调用 Redis::connection 方法获取 Redis 实例：

$redis = Redis::connection();

这将为您提供默认的 Redis 服务器实例。您还可以将连接或集群名称传递给 connection 方法，以获取 Redis 配置中定义的特定服务器或集群：

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

管道命令

当您需要在一次操作中向服务器发送多个命令时，应使用管道。pipeline 方法接受一个参数：一个接收 Redis 实例的 Closure。您可以向此 Redis 实例发出所有命令，它们将全部在单个操作中执行：

Redis::pipeline(function ($pipe) {
    for ($i = 0; $i < 1000; $i++) {
        $pipe->set("key:$i", $i);
    }
});

发布/订阅

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

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

<?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 频道';

    /**
     * 执行控制台命令。
     *
     * @return mixed
     */
    public function handle()
    {
        Redis::subscribe(['test-channel'], function ($message) {
            echo $message;
        });
    }
}

现在我们可以使用 publish 方法向频道发布消息：

Route::get('publish', function () {
    // 路由逻辑...

    Redis::publish('test-channel', json_encode(['foo' => 'bar']));
});

通配符订阅

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

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

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