イントロダクションIntroduction
Redisはオープンソースの進歩的なキー／値保存システムです。キーに文字列、ハッシュ、リスト、セット、ソート済みセットが使用できるため、データ構造サーバとしてよく名前が上がります。Redis[http://redis.io] is an open source, advanced key-value store. It is often referred to as a data structure server since keys can contain strings[http://redis.io/topics/data-types#strings], hashes[http://redis.io/topics/data-types#hashes], lists[http://redis.io/topics/data-types#lists], sets[http://redis.io/topics/data-types#sets], and sorted sets[http://redis.io/topics/data-types#sorted-sets].
LaravelでRedisを使用する前に、predis/predisパッケージをComposerでインストールする必要があります。Before using Redis with Laravel, you will need to install the predis/predis package via Composer:
composer require predis/predis
もしくは、PhpRedis PHP拡張をPECLでインストールすることもできます。この拡張のインストールはより複雑ですが、Redisを頻繁に使用するアプリケーションでは、よりパフォーマンスが良くなります。Alternatively, you may install the PhpRedis[https://github.com/phpredis/phpredis] PHP extension via PECL. The extension is more complex to install but may yield better performance for applications that make heavy use of Redis.
設定Configuration
アプリケーションのRedis設定はconfig/database.phpファイルにあります。このファイルの中にredis配列があり、アプリケーションで使用されるRadisサーバの設定を含んでいます。The Redis configuration for your application is located in the config/database.php configuration file. Within this file, you will see a redis array containing the Redis servers utilized by your application:
'redis' => [
'client' => 'predis',
'default' => [
'host' => env('REDIS_HOST', 'localhost'),
'password' => env('REDIS_PASSWORD', null),
'port' => env('REDIS_PORT', 6379),
'database' => 0,
],
],
デフォルトのサーバ設定は、開発時には十分でしょう。しかしご自由に自分の環境に合わせてこの配列を変更してください。各Redisサーバは名前、ホスト、ポートの指定が必要です。The default server configuration should suffice for development. However, you are free to modify this array based on your environment. Each Redis server defined in your configuration file is required to have a name, host, and port.
クラスタ設定Configuring Clusters
アプリケーションでRedisサーバのクラスタを使用している場合は、Redis設定のclustersキーで定義する必要があります。If your application is utilizing a cluster of Redis servers, you should define these clusters within a clusters key of your Redis configuration:
'redis' => [
'client' => 'predis',
'clusters' => [
'default' => [
[
'host' => env('REDIS_HOST', 'localhost'),
'password' => env('REDIS_PASSWORD', null),
'port' => env('REDIS_PORT', 6379),
'database' => 0,
],
],
],
],
デフォルトでクラスタはノード間のクライアントサイドシェアリングを実行し、ノードをプールし、利用可能な大きいRAMを作成できるようにします。しかしながら、クライアントサイドシェアリングはフェイルオーバーを処理しません。そのため、他のプライマリデータ保存域からのキャッシュデータを使用できるようにするのに適しています。ネイティブなRedisクラスタリングを使用したい場合は、Redis設置のoptionsキーでこれを指定してください。By default, clusters will perform client-side sharding across your nodes, allowing you to pool nodes and create a large amount of available RAM. However, note that client-side sharding does not handle failover; therefore, is primarily suited for cached data that is available from another primary data store. If you would like to use native Redis clustering, you should specify this in the options key of your Redis configuration:
'redis' => [
'client' => 'predis',
'options' => [
'cluster' => 'redis',
],
'clusters' => [
// ...
],
],
PredisPredis
デフォルトのhost、port、database、passwordオプションに加え、Predisは各Redisサーバに対する接続パラメータを定義する機能をサポートしています。これらの追加設定オプションを使うには、config/database.php設定ファイルのRedisサーバ設定へ単に追加してください。In addition to the default host, port, database, and password server configuration options, Predis supports additional connection parameters[https://github.com/nrk/predis/wiki/Connection-Parameters] that may be defined for each of your Redis servers. To utilize these additional configuration options, simply add them to your Redis server configuration in the config/database.php configuration file:
'default' => [
'host' => env('REDIS_HOST', 'localhost'),
'password' => env('REDIS_PASSWORD', null),
'port' => env('REDIS_PORT', 6379),
'database' => 0,
'read_write_timeout' => 60,
],
PhpRedisPhpRedis
Note: PhpRedis PHP拡張をPECL経由でインストールした場合は、
config/app.php設定ファイル中のRedisエイリアスをリネームする必要があります。{note} If you have the PhpRedis PHP extension installed via PECL, you will need to rename theRedisalias in yourconfig/app.phpconfiguration file.
PhpRedis拡張を使用するには、Redis設定のclientオプションをphpredisへ変更してください。このオプションはconfig/database.php設定ファイルにあります。To utilize the PhpRedis extension, you should change the client option of your Redis configuration to phpredis. This option is found in your config/database.php configuration file:
'redis' => [
'client' => 'phpredis',
// 残りのRedis設定…
],
デフォルトのhost、port、database、passwordオプションに加え、PhpRedisはpersistent、prefix、read_timeout、timeout追加オプションをサポートしています。config/database.php設定ファイル中のRedisサーバ設定に、これらのオプションを追加してください。In addition to the default host, port, database, and password server configuration options, PhpRedis supports the following additional connection parameters: persistent, prefix, read_timeout and timeout. You may add any of these options to your Redis server configuration in the config/database.php configuration file:
'default' => [
'host' => env('REDIS_HOST', 'localhost'),
'password' => env('REDIS_PASSWORD', null),
'port' => env('REDIS_PORT', 6379),
'database' => 0,
'read_timeout' => 60,
],
Redisの操作Interacting With Redis
Redisファサードのバラエティー豊かなメソッドを呼び出し、Redisを操作できます。Redisファサードは動的メソッドをサポートしています。つまりファサードでどんなRedisコマンドでも呼び出すことができ、そのコマンドは直接Redisへ渡されます。以下の例ではRedisのGETコマンドをRedisファサードのgetメソッドで呼び出しています。You may interact with Redis by calling various methods on the Redis facade[/docs/{{version}}/facades]. The Redis facade supports dynamic methods, meaning you may call any Redis command[http://redis.io/commands] on the facade and the command will be passed directly to Redis. In this example, we will call the Redis GET command by calling the get method on the Redis facade:
<?php
namespace App\Http\Controllers;
use Illuminate\Support\Facades\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ファサードでどんなRedisコマンドでも呼び出すことができます。Laravelはmagicメソッドを使いコマンドをRedisサーバへ送りますので、Redisコマンドで期待されている引数を渡してください。Of course, as mentioned above, you may call any of the Redis commands on the Redis facade. Laravel uses magic methods to pass the commands to the Redis server, so simply pass the arguments the Redis command expects:
Redis::set('name', 'Taylor');
$values = Redis::lrange('names', 5, 10);
サーバにコマンドを送る別の方法はcommandメソッドを使う方法です。最初の引数にコマンド名、第２引数に値の配列を渡します。Alternatively, you may also pass commands to the server using the command method, which accepts the name of the command as its first argument, and an array of values as its second argument:
$values = Redis::command('lrange', ['name', 5, 10]);
複数のRedis接続の使用Using Multiple Redis Connections
RedisインスタンスをRedis::connectionメソッドの呼び出しで取得できます。You may get a Redis instance by calling the Redis::connection method:
$redis = Redis::connection();
これによりデフォルトのRedisサーバのインスタンスが取得できます。さらに、Redis設定で定義した、特定のサーバやクラスタを取得するために、connectionメソッドへ接続名やクラスタ名を渡すこともできます。This will give you an instance of the default Redis server. You may also pass the connection or cluster name to the connection method to get a specific server or cluster as defined in your Redis configuration:
$redis = Redis::connection('my-connection');
パイプラインコマンドPipelining Commands
一回の操作でサーバに対し多くのコマンドを送る必要がある場合はパイプラインを使うべきでしょう。pipelineメソッドは引数をひとつだけ取り、Redisインスタンスを取る「クロージャ」です。このRedisインスタンスで全コマンドを発行し、一回の操作で全部実行できます。Pipelining should be used when you need to send many commands to the server in one operation. The pipeline method accepts one argument: a Closure that receives a Redis instance. You may issue all of your commands to this Redis instance and they will all be executed within a single operation:
Redis::pipeline(function ($pipe) {
for ($i = 0; $i < 1000; $i++) {
$pipe->set("key:$i", $i);
}
});
publish／subscribePub / Sub
さらにLaravelは、Redisのpublishとsubscribeコマンドの便利なインターフェイスも提供しています。これらのRedisコマンドは、指定した「チャンネル」のメッセージをリッスンできるようにしてくれます。他のアプリケーションからこのチャンネルにメッセージを公開するか、他の言語を使うこともでき、これによりアプリケーション／プロセス間で簡単に通信できます。Laravel provides a convenient interface to the Redis publish and subscribe commands. These Redis commands allow you to listen for messages on a given "channel". You may publish messages to the channel from another application, or even using another programming language, allowing easy communication between applications and processes.
最初にsubscribeメソッドでRedisを経由するチャンネルのリスナを準備します。subscribeメソッドは長時間動作するプロセスですので、このメソッドはArtisanコマンドの中で呼び出します。First, let's setup a channel listener using the subscribe method. We'll place this method call within an Artisan command[/docs/{{version}}/artisan] since calling the subscribe method begins a long-running process:
<?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メソッドを使いチャンネルへメッセージを公開できます。Now we may publish messages to the channel using the publish method:
Route::get('publish', function () {
// Route logic...
Redis::publish('test-channel', json_encode(['foo' => 'bar']));
});
ワイルドカード購入Wildcard Subscriptions
psubscribeメソッドでワイルドカードチャネルに対し購入できます。全チャンネルの全メッセージを補足するために便利です。$channel名は指定するコールバック「クロージャ」の第２引数として渡されます。Using the psubscribe method, you may subscribe to a wildcard channel, which may be useful for catching all messages on all channels. The $channel name will be passed as the second argument to the provided callback Closure:
Redis::psubscribe(['*'], function ($message, $channel) {
echo $message;
});
Redis::psubscribe(['users.*'], function ($message, $channel) {
echo $message;
});