Laravel 5.0 Redis

イントロダクション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].

RedisをLaravelで使いはじめる前に、Composerによりpredis/predisパッケージ(~1.0)をインストールする必要があります。Before using Redis with Laravel, you will need to install the predis/predis package (~1.0) via Composer.

注意： PECLでRedis PHP拡張をインストールしている場合、config/app.phpファイルのRedisエイリアスをリネームする必要があります。Note: If you have the Redis PHP extension installed via PECL, you will need to rename the alias for Redis in your config/app.php file.

設定Configuration

アプリケーションのRedis設定はconfig/database.phpファイルにあります。このファイルの中にredis配列があり、アプリケーションで使用されるRadisサーバーの設定を含んでいます。The Redis configuration for your application is stored in the config/database.php file. Within this file, you will see a redis array containing the Redis servers used by your application:

'redis' => [

	'cluster' => true,

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

],

デフォルトサーバー設定は、開発時には十分でしょう。ですが、ご自由に自分の環境に合わせてこの配列を変更してください。ただ各Redisサーバーに名前を与え、使用するホストとポートを指定するだけです。The default server configuration should suffice for development. However, you are free to modify this array based on your environment. Simply give each Redis server a name, and specify the host and port used by the server.

ノードをプールしたり、巨大なRAMを使用可能にしたりするため、clusterオプションはRedisノード間に渡りクライアントサイドで共有する指示をLaravel Redisクライアントに対し行います。しかし注意すべきは、クライアントサイドの共有ではフェイルオーバーが処理されないことです。そのため主な使い方は、他のプライマリーのデーター域から、キャッシュデーターを使用できるようにすることでしょう。The cluster option will tell the Laravel Redis client to perform client-side sharding across your Redis 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.

Redisサーバーが認証を求めている場合、Redisサーバー設定のpasswordオプションへキー／値のペアを指定してください。If your Redis server requires authentication, you may supply a password by adding a password key / value pair to your Redis server configuration array.

使用法Usage

Redis::connectionメソッドを呼び出すだけで、Redisインスタンスが取得されます。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. If you are not using server clustering, you may pass the server name to the connection method to get a specific server as defined in your Redis configuration:

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

Redisクライアントのインスタンスを一度取得してしまえば、どんなRedisコマンドでも、発行できます。LaravelではコマンドをRedisサーバーに渡すため、マジックメソッドが使用できます。Once you have an instance of the Redis client, we may issue any of the Redis commands[http://redis.io/commands] to the instance. Laravel uses magic methods to pass the commands to the Redis server:

$redis->set('name', 'Taylor');

$name = $redis->get('name');

$values = $redis->lrange('names', 5, 10);

コマンドへの引数は単純にマジックメソッドに渡されていることに注目してください。もちろんマジックメソッドを使用したくなければ、サーバーにコマンドを送信するためcommandメソッドを使用できます。Notice the arguments to the command are simply passed into the magic method. Of course, you are not required to use the magic methods, you may also pass commands to the server using the command method:

$values = $redis->command('lrange', [5, 10]);

コマンドをデフォルト接続に対し実行する場合は、静的なマジックメソッドをRedisクラスに対し使用してください。When you are simply executing commands against the default connection, just use static magic methods on the Redis class:

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

$name = Redis::get('name');

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

注目： RadisのキャッシュとセッションドライバーはLaravelに含まれています。Note: Redis cache[/docs/{{version}}/cache] and session[/docs/{{version}}/session] drivers are included with Laravel.

パイプラインPipelining

多くのコマンドを一度にサーバーへ送る必要がある時はパイプラインを使用すべきです。pipelineコマンドを使ってください。Pipelining should be used when you need to send many commands to the server in one operation. To get started, use the pipeline command:

大量のコマンドをサーバーへ送信Piping Many Commands To Your Servers

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