Skip to content

Redis

介绍

Redis 是一个开源的高级键值存储。它通常被称为数据结构服务器,因为键可以包含字符串哈希列表集合有序集合。在使用 Redis 和 Laravel 之前,你需要通过 Composer 安装 predis/predis 包 (~1.0)。

配置

应用程序的 Redis 配置位于 config/database.php 配置文件中。在这个文件中,你会看到一个 redis 数组,其中包含应用程序使用的 Redis 服务器:

php
'redis' => [

    'cluster' => false,

    'default' => [
        'host'     => '127.0.0.1',
        'port'     => 6379,
        'database' => 0,
    ],

],

默认的服务器配置应该足以用于开发。然而,你可以根据环境自由修改这个数组。只需为每个 Redis 服务器命名,并指定服务器使用的主机和端口。

cluster 选项将告诉 Laravel Redis 客户端在你的 Redis 节点之间执行客户端分片,允许你池化节点并创建大量可用的 RAM。然而,请注意,客户端分片不处理故障转移;因此,主要适用于可以从其他主数据存储中获取的缓存数据。

此外,你可以在 Redis 连接定义中定义一个 options 数组值,允许你指定一组 Predis 客户端选项

如果你的 Redis 服务器需要身份验证,你可以通过在 Redis 服务器配置数组中添加 password 配置项来提供密码。

lightbulb

如果你通过 PECL 安装了 Redis PHP 扩展,你需要在 config/app.php 文件中重命名 Redis 的别名。

基本用法

你可以通过调用 Redis facade 上的各种方法与 Redis 交互。Redis facade 支持动态方法,这意味着你可以在 facade 上调用任何 Redis 命令,命令将直接传递给 Redis。在这个例子中,我们将通过调用 Redis facade 上的 get 方法来调用 Redis 上的 GET 命令:

php
<?php

namespace App\Http\Controllers;

use Redis;
use App\Http\Controllers\Controller;

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 命令期望的参数:

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

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

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

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

使用多个 Redis 连接

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

php
$redis = Redis::connection();

这将为你提供默认的 Redis 服务器实例。如果你不使用服务器集群,你可以将服务器名称传递给 connection 方法以获取 Redis 配置中定义的特定服务器:

php
$redis = Redis::connection('other');

命令管道

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

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

发布/订阅

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

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

php
<?php

namespace App\Console\Commands;

use Redis;
use Illuminate\Console\Command;

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 方法向频道发布消息:

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

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

通配符订阅

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

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

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