Laravel 的 Redis 使用指南

简介

Redis 是一个开源的高级键值对存储库。它的键值可以包含 字符串哈希列表集合有序集合 这些数据类型,因此它通常被称为数据结构服务器。

在使用 Laravel 的 Redis 之前,你需要通过 Composer 安装 predis/predis 扩展包:

  1. composer require predis/predis

或者,你可以通过 PECL 安装 PhpRedis PHP 扩展。这个扩展安装起来比较复杂,但对于大量使用 Redis 的应用程序来说可能会产生更好的性能。

配置

应用程序的 Redis 配置都在配置文件 config/database.php 中。在这个文件里,你可以看到 redis 数组里面包含了应用程序使用的 Redis 服务器:

  1. 'redis' => [
  2. 'client' => 'predis',
  3. 'default' => [
  4. 'host' => env('REDIS_HOST', 'localhost'),
  5. 'password' => env('REDIS_PASSWORD', null),
  6. 'port' => env('REDIS_PORT', 6379),
  7. 'database' => 0,
  8. ],
  9. ],

默认的服务器配置应该足以进行开发。当然,你也可以根据使用的环境来随意更改这个数组。只需在配置文件中给每个 Redis 服务器指定名称、host 和 port 即可。

集群配置

如果你的程序使用 redis 服务器集群,你应该在 redis 配置文件中使用 clusters 键来定义这些集群:

  1. 'redis' => [
  2. 'client' => 'predis',
  3. 'clusters' => [
  4. 'default' => [
  5. [
  6. 'host' => env('REDIS_HOST', 'localhost'),
  7. 'password' => env('REDIS_PASSWORD', null),
  8. 'port' => env('REDIS_PORT', 6379),
  9. 'database' => 0,
  10. ],
  11. ],
  12. ],
  13. ],

默认情况下,集群可以实现跨节点间客户端共享,允许你实现节点池以及创建大量可用内存。这里要注意,客户端共享不会处理失败的情况;因此,这个功能主要适用于从另一个主数据库获取的缓存数据。如果要使用 redis 原生集群,要在配置文件的 options 键中如下指定:

  1. 'redis' => [
  2. 'client' => 'predis',
  3. 'options' => [
  4. 'cluster' => 'redis',
  5. ],
  6. 'clusters' => [
  7. // ...
  8. ],
  9. ],

Predis

除了默认的 Hostportdatabasepassword 这些服务配置选项之外,Predis 还支持为每个 redis 服务器定义其他的 连接参数。如果要使用这些额外的配置选项,就将它们添加到配置文件 config/database.php 的 Redis 服务器配置中:

  1. 'default' => [
  2. 'host' => env('REDIS_HOST', 'localhost'),
  3. 'password' => env('REDIS_PASSWORD', null),
  4. 'port' => env('REDIS_PORT', 6379),
  5. 'database' => 0,
  6. 'read_write_timeout' => 60,
  7. ],

PhpRedis

{note} 如果你是通过 PECL 安装 Redis PHP 扩展,就需要重命名 config/app.php 文件里 Redis 的别名。

如果要使用 Phpredis 扩展,就需要将配置文件 config/database.php 中 Redis 配置的 client 选项更改为 phpredis

  1. 'redis' => [
  2. 'client' => 'phpredis',
  3. // Rest of Redis configuration...
  4. ],

除了默认的 Hostportdatabasepassword 这些服务配置项之外,Phpredis 还支持以下几个额外的连接参数:persistentprefixread_timeouttimeout。你可以将这些选项加到配置文件 config/database.php 中 redis 服务器配置项下:

  1. 'default' => [
  2. 'host' => env('REDIS_HOST', 'localhost'),
  3. 'password' => env('REDIS_PASSWORD', null),
  4. 'port' => env('REDIS_PORT', 6379),
  5. 'database' => 0,
  6. 'read_timeout' => 60,
  7. ],

与 Redis 交互

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

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

也就是说,你可以在 Redis facade 上调用任何的 Redis 命令。Laravel 使用魔术方法将传递命令给 Redis 服务器,因此只需传递 Redis 命令所需的参数即可:

  1. Redis::set('name', 'Taylor');
  2. $values = Redis::lrange('names', 5, 10);

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

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

使用多个 Redis 连接

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

  1. $redis = Redis::connection();

这会返回一个默认的 redis 服务器的实例。你也可以将连接或者集群的名称传递给 connection 方法,来获取在 Redis 配置文件中定义的特定的服务器或者集群:

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

管道命令

如果你需要在一个操作中向服务器发送很多命令,推荐你使用管道命令。pipeline 方法接收一个带有 Redis 实例的 闭包 。你可以将所有的命令发送给这个 Redis 实例,它们都会一次过执行完:

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

发布与订阅

Laravel 为 Redis 的 publishsubscribe 提供了方便的接口。这些 Redis 命令让你可以监听指定「频道」上的消息。你可以从另一个应用程序发布消息给另一个应用程序,甚至使用其它编程语言,让应用程序和进程之间能够轻松进行通信。

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

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

现在,我们可以使用 publish 方法发布消息到频道:

  1. Route::get('publish', function () {
  2. // Route logic...
  3. Redis::publish('test-channel', json_encode(['foo' => 'bar']));
  4. });

通配符订阅

使用 psubscribe 方法可以订阅通配符频道,可以用来在所有频道上获取所有消息。$channel 名称将作为第二个参数传递给提供的回调 闭包

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

译者署名

用户名 头像 职能 签名
@daydaygo Laravel 的 Redis 使用指南 - 图1 翻译 Coder at Work
@大袋鼠 Laravel 的 Redis 使用指南 - 图2 校对 暮光博客
@JokerLinly Laravel 的 Redis 使用指南 - 图3 Review Stay Hungry. Stay Foolish.

{note} 欢迎任何形式的转载,但请务必注明出处,尊重他人劳动共创开源社区。

转载请注明:本文档由 Laravel China 社区 laravel-china.org 组织翻译,详见 翻译召集帖

文档永久地址: https://d.laravel-china.org