イントロダクション
Redisはオープンソースの進歩的なキー／値保存システムです。キーに文字列、ハッシュ、リスト、セット、ソート済みセットが使用できるため、データ構造サーバとしてよく名前が上がります。
LaravelでRedis使用するには、PECLを使用してPhpRedis PHP拡張をインストールすることを推奨します。インストール方法は複雑ですが、Redisをヘビーユースするアプリケーションではより良いパフォーマンスが得られます
もしくは、Composerでpredis/predisパッケージをインストールすることもできます。
composer require predis/predis設定
アプリケーションのRedis設定はconfig/database.phpファイルにあります。このファイルの中にredis配列があり、アプリケーションで使用されるRadisサーバの設定を含んでいます。
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
'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接続を表すシングルURLを定義していない場合、各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サーバへの接続に、tcpスキームをRedisクライアントは使用します。しかし、Redisサーバ接続設定のscheme設定オプションを指定すれば、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,
],
],
],
],デフォルトでクラスタはノード間のクライアントサイドシェアリングを実行し、ノードをプールし、利用可能な大きいRAMを作成できるようにします。しかしながら、クライアントサイドシェアリングはフェイルオーバーを処理しません。そのため、他のプライマリデータ保存域からのキャッシュデータを使用できるようにするため適しています。ネイティブな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'),
// 残りのRedis設定…
],デフォルトの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
PhpRedis拡張は、config/database.phpの中でREDIS_CLIENT環境変数のデフォルトとして設定されています。
'redis' => [
'client' => env('REDIS_CLIENT', 'phpredis'),
// 残りのRedis設定…
],Redisファサードエイリアスに加えPhpRedis拡張を使用する予定であれば、Redisクラスとの衝突を避けるために、RedisManagerのような他の名前にリネームする必要があります。app.php`設定ファイルのエイリアスセクションで行えます。
'RedisManager' => Illuminate\Support\Facades\Redis::class,デフォルトのhost、port、database、passwordオプションに加え、PhpRedisはpersistent、prefix、read_timeout、timeout、context追加オプションをサポートしています。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,
'context' => [
// 'auth' => ['username', 'secret'],
// 'stream' => ['verify_peer' => false],
],
],Redisファサード
Redis
PHP拡張自身と名前が衝突するのを避けるため、app設定ファイルのaliases配列からIlluminate\Support\Facades\Redisファサードエイリアスを削除かリネームする必要があります。一般的には、このエイリアスを完全に取り除き、Redis
PHP拡張を使用するときに完全なクラス名を指定することで、ファサードを参照するに留めるべきです。
Redisの操作
Redisファサードのバラエティー豊かなメソッドを呼び出し、Redisを操作できます。Redisファサードは動的メソッドをサポートしています。つまりファサードでどんなRedisコマンドでも呼び出すことができ、そのコマンドは直接Redisへ渡されます。以下の例ではRedisの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ファサードでどんなRedisコマンドでも呼び出すことができます。Laravelはmagicメソッドを使いコマンドをRedisサーバへ送りますので、Redisコマンドで期待されている引数を渡してください。
Redis::set('name', 'Taylor');
$values = Redis::lrange('names', 5, 10);サーバにコマンドを送る別の方法はcommandメソッドを使う方法です。最初の引数にコマンド名、第２引数に値の配列を渡します。
$values = Redis::command('lrange', ['name', 5, 10]);複数のRedis接続の使用
RedisインスタンスをRedis::connectionメソッドの呼び出しで取得できます。
$redis = Redis::connection();これによりデフォルトのRedisサーバのインスタンスが取得できます。さらに、Redis設定で定義した、特定のサーバやクラスタを取得するために、connectionメソッドへ接続名やクラスタ名を渡すこともできます。
$redis = Redis::connection('my-connection');パイプラインコマンド
サーバに対し多くのコマンドを送る必要がある場合はパイプラインを使うべきでしょう。pipelineメソッドは引数をひとつだけ取り、Redisインスタンスを取る「クロージャ」です。このRedisインスタンスは全コマンドをサーバへストリーミングするので、良いパフォーマンスが得られます。
Redis::pipeline(function ($pipe) {
for ($i = 0; $i < 1000; $i++) {
$pipe->set("key:$i", $i);
}
});publish／subscribe
さらにLaravelは、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
{
/**
* コンソールコマンドの名前と使用法
*
* @var string
*/
protected $signature = 'redis:subscribe';
/**
* コンソールコマンドの説明
*
* @var string
*/
protected $description = 'Subscribe to a Redis channel';
/**
* コンソールコマンドの実行
*
* @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;
});