# Laravel 的 Redis 使用指南 - [簡介](#introduction) - [配置](#configuration) - [Predis](#predis) - [PhpRedis](#phpredis) - [基本用法](#interacting-with-redis) - [管道化命令](#pipelining-commands) - [發布與訂閱](#pubsub) <a name="introduction"></a> ## 簡介 [Redis](http://redis.io) 是一款開源且先進的鍵值對數據庫。由于它的鍵指向的數據包含了 [字符串](http://redis.io/topics/data-types#strings)、[哈希](http://redis.io/topics/data-types#hashes)、[列表](http://redis.io/topics/data-types#lists)、[集合](http://redis.io/topics/data-types#sets) 和 [有序集合](http://redis.io/topics/data-types#sorted-sets) 這些數據類型，因此常被用作數據結構服務器。 在使用 Redis 之前，你需要通過 Composer 安裝 `predis/predis` 擴展包： composer require predis/predis 還有一種選擇，你可以通過 PECL 安裝 [PhpRedis](https://github.com/phpredis/phpredis) PHP 擴展。這個擴展安裝起來更復雜，但是你可以在你的程序重度使用 redis 時獲得一定的性能提升。 <a name="configuration"></a> ### 配置 應用程序的 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 服務器指定名稱、host 和 port 即可。 > 譯者注： 關于 Redis 多連接的配置，請參閱 - [Laravel 下配置 Redis 讓緩存、Session 各自使用不同的 Redis 數據庫](https://laravel-china.org/topics/2466)。 #### 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, ], ], ], ], 默認情況下，集群可以實現跨節點間客戶端共享，允許你實現節點池以及創建大量可用內存。然而，注意客戶端共享并沒有處理失敗情況；因此，主要適用于從另一個主要的數據源來建立緩存數據。如果你喜歡使用 redis 原生集群，你需要在配置文件中配置 `options` 鍵： 'redis' => [ 'client' => 'predis', 'options' => [ 'cluster' => 'redis', ], 'clusters' => [ // ... ], ], <a name="predis"></a> ### Predis 除了默認的 `Host`，`port`，`database` 和 `password` 服務配置項之外，Predis 還可以為每個 redis 定義其他的 [連接參數](https://github.com/nrk/predis/wiki/Connection-Parameters)。要使用這些額外的配置選項，只需將它們添加到你的 `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, ], <a name="phpredis"></a> ### PhpRedis > {note} 如果你是通過 PECL 安裝 Redis PHP 擴展，則需要重命名 `config/app.php` 文件里的 Redis 別名。 要使用 Phpredis 擴展，你需要將 `client` 選項配置為 `phpredis`。這個選項可以在 `config/database.php` 配置文件中找到： 'redis' => [ 'client' => 'phpredis', // Rest of Redis configuration... ], 除了默認的 `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, ], <a name="interacting-with-redis"></a> ## 基本用法 你可以通過調用 `Redis` [facade](/docs/{{version}}/facades) 的各種方法與 `Redis` 進行交互。`Redis` facade 支持動態方法，意思就是指你可以在該 facade 調用任何 [Redis 命令](http://redis.io/commands)，該命令會直接傳遞給 Redis。在本例中，我們會通過 `Redis` facade 的 `get` 方法來調用 Redis 的 `GET` 命令： <?php namespace App\Http\Controllers; use Illuminate\Support\Facades\Redis; use App\Http\Controllers\Controller; 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'); <a name="pipelining-commands"></a> ### 管道化命令 當你想要在單次操作中發送多個命令至服務器時則可以使用管道化命令。 `pipeline` 方法接收一個參數：帶有 Redis 實例的 `閉包` 。你可以發送所有的命令至此 Redis 實例，它們都會在單次操作中運行： Redis::pipeline(function ($pipe) { for ($i = 0; $i < 1000; $i++) { $pipe->set("key:$i", $i); } }); <a name="pubsub"></a> ## 發布與訂閱 Laravel 也對 Redis 的 `publish` 及 `subscribe` 提供了方便的接口。這些 Redis 命令讓你可以監聽指定「頻道」的消息。你可以從另一個應用程序發布消息至頻道，甚至使用另一種編程語言，讓應用程序或進程之間容易溝通。 首先，讓我們通過 `Redis` 來使用 `subscribe` 方法在一個頻道設置偵聽器。我們會將方法調用放置于一個 [Artisan 命令](/docs/{{version}}/artisan) 中，因為調用 `subscribe` 方法會啟動一個長時間運行的進程： <?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; }); ## 譯者署名 | 用戶名 | 頭像 | 職能 | 簽名 | |---|---|---|---| | [@daydaygo](https://github.com/daydaygo) | <img class="avatar-66 rm-style" src="http://qiniu.daydaygo.top/lol-timo-panda.png"> | 翻譯 | [Coder at Work](http://blog.daydaygo.top) | | [@大袋鼠](https://github.com/FaithPatrick) | <img class="avatar-66 rm-style" src="https://avatars1.githubusercontent.com/u/17744239"> | 校對 | [暮光博客](https://muguang.me/) |