Laravel Redis

简介

Redis 是一个开源的、高级的键值对存储系统，经常被用作数据结构服务器，因为其支持字符串、Hash、列表、集合和有序集合等数据结构。了解更详细的Redis数据结构，可以参考我们的 Redis教程——数据类型

在 Laravel 中使用 Redis 之前，推荐通过 PECL 安装 PHP 扩展 PhpRedis，该扩展安装起来更麻烦，但是对重度使用 Redis 的应用而言性能更好。

作为替代方案，我们还可以通过 Composer 安装 predis/predis 包：

$ composer require predis/predis

注：Predis 已经被扩展包的原作者放弃，Laravel 将会在未来版本中移除对它的支持。

配置

应用的 Redis 配置位于配置文件 config/database.php。在这个文件中，可以看到包含被应用使用的 Redis 服务器的 redis 数组：

'redis' => [
    'client' => 'predis',
    'default' => [
        'host' => env('REDIS_HOST', '127.0.0.1'),
        'password' => env('REDIS_PASSWORD', null),
        'port' => env('REDIS_PORT', 6379),
        'database' => env('REDIS_DB', 0),
    ],
    'cache' => [
        'host' => env('REDIS_HOST', '127.0.0.1'),
        'password' => env('REDIS_PASSWORD', null),
        'port' => env('REDIS_PORT', 6379),
        'database' => env('REDIS_CACHE_DB', 1),
    ],
],

默认服务器配置可以满足开发需要，不过，我们可以基于自己的环境修改该数组。配置文件中定义的每个 Redis 服务器需要一个名字并指定该 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 客户端在连接到 Redis 服务器时将使用tcp方案；但是，我们可以通过scheme在 Redis 服务器配置中指定配置选项来使用 TLS / SSL 加密：

'redis' => [

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

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

],

配置集群

如果应用使用了 Redis 服务器集群，需要在 Redis 配置中通过 clusters 定义这些集群：

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

默认情况下，集群将会在节点之间进行客户端分区，从而允许你构建节点池并创建大量可用内存。不过，客户端分片并不处理故障转移，所以，非常适合从另一个主数据存储那里获取有效的缓存数据。如果你想要使用本地 Redis 集群，需要在 Redis 配置的 options 中进行指定：

'redis' => [
    'client' => env('REDIS_CLIENT', 'phpredis'),
    'options' => [
        'cluster' => env('REDIS_CLUSTER', 'redis'),
    ],
    'clusters' => [
        // ...
    ],
],

Predis

要使用 Predis 扩展，需要将环境变量 REDIS_CLIENT 的值从 phpredis 修改为 predis：

'redis' => [
    'client' => env('REDIS_CLIENT', 'predis'),
    // Rest of Redis configuration...
],

除了默认的 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

在环境变量 REDIS_CLIENT 和 config/database.php 中，PhpRedis 扩展被配置为默认值：

'redis' => [
    'client' => env('REDIS_CLIENT', 'phpredis'),
    // Rest of Redis configuration...
],

如果我们计划将 PhpRedis 扩展和 Redis Facade别名一起使用，需要将Facade别名重命名为其它值，比如 RedisManager，以便避免和 PhpRedis 扩展提供的 Redis 类冲突。可以在配置文件 app.php 中设置这个别名：

'RedisManager' => Illuminate\Support\Facades\Redis::class,

除了默认的 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 Facade

为了避免和 PhpRedis 扩展提供的 Redis 类命名冲突，需要在配置文件 app.php 的 aliases 数组中删除或者重命名 Illuminate\Support\Facades\Redis facade 别名。通常，我们可以移除这个别名，然后在和 Redis PHP 扩展一起使用时使用Facade对应的完整类名。

与 Redis 交互

我们可以通过调用 Redis Facade上的方法来与 Redis 进行交互，该门面支持动态方法，所以你可以调用任何 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
{
    /**
     * Show the profile for the given user.
     *
     * @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 实例的闭包。你可以将所有 Redis 命令发送到这个 Redis 实例，然后这些命令会在一次操作中被执行：

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

发布/订阅

Redis 还提供了调用 Redis 的 publish 和 subscribe 命令的接口。这些 Redis 命令允许我们在给定“频道”监听消息，你可以从另外一个应用发布消息到这个频道，甚至使用其它编程语言，从而允许我们在不同的应用/进程之间轻松通信。

首先，让我们使用 subscribe 方法通过 Redis 在一个频道上设置监听器。由于调用 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 mixed
     */
    public function handle()
    {
        Redis::subscribe(['test-channel'], function ($message) {
            echo $message;
        });
    }
}

现在，我们可以使用 publish 发布消息到该频道：

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

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

通配符订阅

使用 psubscribe 方法，我们可以订阅到一个通配符定义的频道，这在所有相应频道上获取所有消息时很有用。$channel 名将会作为第二个参数传递给提供的回调闭包：

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