Redis Cache Adapter

See also

こちらもご覧ください

This article explains how to configure the Redis adapter when using the Cache as an independent component in any PHP application. Read the Symfony Cache configuration article if you are using it in a Symfony application.

この記事では、任意の PHP アプリケーションで theCache を独立したコンポーネントとして使用する場合に Redis アダプターを構成する方法について説明します。 Symfony アプリケーションで使用している場合は、Symfony キャッシュ構成の記事を読んでください。

This adapter stores the values in-memory using one (or more) Redis server instances.

このアダプターは、1 つ (または複数) の Redis サーバー インスタンスを使用してメモリ内に値を格納します。

Unlike the APCu adapter, and similarly to the Memcached adapter, it is not limited to the current server's shared memory; you can store contents independent of your PHP environment. The ability to utilize a cluster of servers to provide redundancy and/or fail-over is also available.

APCu アダプタとは異なり、Memcached アダプタと同様に、現在のサーバーの共有メモリに限定されません。 PHP 環境から独立してコンテンツを保存できます。サーバーのクラスターを利用して、冗長性やフェイルオーバーを提供する機能も利用できます。

Caution

注意

Requirements: At least one Redis server must be installed and running to use this adapter. Additionally, this adapter requires a compatible extension or library that implements \Redis, \RedisArray, RedisCluster, or \Predis.

要件: このアダプターを使用するには、少なくとも 1 つの Redis サーバーがインストールされ、実行されている必要があります。さらに、このアダプターには、\Redis、\RedisArray、RedisCluster、または \Predis を実装する互換性のある拡張機能またはライブラリが必要です。

This adapter expects a Redis, RedisArray, RedisCluster, or Predis instance to be passed as the first parameter. A namespace and default cache lifetime can optionally be passed as the second and third parameters:

このアダプターは、R​​edis、RedisArray、RedisCluster、または Predis インスタンスが最初のパラメーターとして渡されることを想定しています。名前空間とデフォルトのキャッシュの有効期間は、オプションで 2 番目と 3 番目のパラメーターとして渡すことができます。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
 
use Symfony\Component\Cache\Adapter\RedisAdapter;

$cache = new RedisAdapter(

    // the object that stores a valid connection to your Redis system
    \Redis $redisConnection,

    // the string prefixed to the keys of the items stored in this cache
    $namespace = '',

    // the default lifetime (in seconds) for cache items that do not define their
    // own lifetime, with a value 0 causing items to be stored indefinitely (i.e.
    // until RedisAdapter::clear() is invoked or the server(s) are purged)
    $defaultLifetime = 0
);

Configure the Connection

The createConnection() helper method allows creating and configuring the Redis client class instance using a Data Source Name (DSN):

createConnection() ヘルパー メソッドを使用すると、データ ソース名 (DSN) を使用して Redis クライアント クラス インスタンスを作成および構成できます。
1
2
3
4
5
6
 
use Symfony\Component\Cache\Adapter\RedisAdapter;

// pass a single DSN string to register a single server with the client
$client = RedisAdapter::createConnection(
    'redis://localhost'
);

The DSN can specify either an IP/host (and an optional port) or a socket path, as well as a password and a database index. To enable TLS for connections, the scheme redis must be replaced by rediss (the second s means "secure").

DSN は、IP/ホスト (およびオプションのポート) またはソケット パスのいずれか、およびパスワードとデータベース インデックスを指定できます。接続に TLS を有効にするには、スキーム redis を redis に置き換える必要があります (2 番目の s は「安全」を意味します)。

Note

ノート

A Data Source Name (DSN) for this adapter must use either one of the following formats.

このアダプターのデータ ソース名 (DSN) は、次のいずれかの形式を使用する必要があります。
1
 
redis[s]://[pass@][ip|host|socket[:port]][/db-index]
 
1
 
redis[s]:[[user]:pass@]?[ip|host|socket[:port]][&params]

Values for placeholders [user], [:port], [/db-index] and [&params] are optional.

Below are common examples of valid DSNs showing a combination of available values:

以下は、使用可能な値の組み合わせを示す有効な DSN の一般的な例です。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
 
use Symfony\Component\Cache\Adapter\RedisAdapter;

// host "my.server.com" and port "6379"
RedisAdapter::createConnection('redis://my.server.com:6379');

// host "my.server.com" and port "6379" and database index "20"
RedisAdapter::createConnection('redis://my.server.com:6379/20');

// host "localhost", auth "abcdef" and timeout 5 seconds
RedisAdapter::createConnection('redis://abcdef@localhost?timeout=5');

// socket "/var/run/redis.sock" and auth "bad-pass"
RedisAdapter::createConnection('redis://bad-pass@/var/run/redis.sock');

// host "redis1" (docker container) with alternate DSN syntax and selecting database index "3"
RedisAdapter::createConnection('redis:?host[redis1:6379]&dbindex=3');

// providing credentials with alternate DSN syntax
RedisAdapter::createConnection('redis:default:verysecurepassword@?host[redis1:6379]&dbindex=3');

// a single DSN can also define multiple servers
RedisAdapter::createConnection(
    'redis:?host[localhost]&host[localhost:6379]&host[/var/run/redis.sock:]&auth=my-password&redis_cluster=1'
);

Redis Sentinel, which provides high availability for Redis, is also supported when using the PHP Redis Extension v5.2+ or the Predis library. Use the redis_sentinel parameter to set the name of your service group:

Redis の高可用性を提供する Redis Sentinel は、PHP Redis 拡張機能 v5.2+ または Predis ライブラリを使用する場合にもサポートされます。 redis_sentinel パラメータを使用して、サービス グループの名前を設定します。
1
2
3
4
5
6
7
8
9
10
11
12
13
 
RedisAdapter::createConnection(
    'redis:?host[redis1:26379]&host[redis2:26379]&host[redis3:26379]&redis_sentinel=mymaster'
);

// providing credentials
RedisAdapter::createConnection(
    'redis:default:verysecurepassword@?host[redis1:26379]&host[redis2:26379]&host[redis3:26379]&redis_sentinel=mymaster'
);

// providing credentials and selecting database index "3"
RedisAdapter::createConnection(
    'redis:default:verysecurepassword@?host[redis1:26379]&host[redis2:26379]&host[redis3:26379]&redis_sentinel=mymaster&dbindex=3'
);

Note

ノート

See the RedisTrait for more options you can pass as DSN parameters.

DSN パラメータとして渡すことができるその他のオプションについては、RedisTrait を参照してください。

Configure the Options

The createConnection() helper method also accepts an array of options as its second argument. The expected format is an associative array of key => value pairs representing option names and their respective values:

createConnection() ヘルパー メソッドも、2 番目の引数としてオプションの配列を受け入れます。予想される形式は、オプション名とそれぞれの値を表すキー => 値のペアの連想配列です。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
 
use Symfony\Component\Cache\Adapter\RedisAdapter;

$client = RedisAdapter::createConnection(

    // provide a string dsn
    'redis://localhost:6379',

    // associative array of configuration options
    [
        'class' => null,
        'persistent' => 0,
        'persistent_id' => null,
        'timeout' => 30,
        'read_timeout' => 0,
        'retry_interval' => 0,
        'tcp_keepalive' => 0,
        'lazy' => null,
        'redis_cluster' => false,
        'redis_sentinel' => null,
        'dbindex' => 0,
        'failover' => 'none',
        'ssl' => null,
    ]

);

Available Options

class (type: string, default: null)
Specifies the connection library to return, either \Redis or \Predis\Client. If none is specified, it will return \Redis if the redis extension is available, and \Predis\Client otherwise. Explicitly set this to \Predis\Client for Sentinel if you are running into issues when retrieving master information.
返す接続ライブラリを \Redis または \Predis\Client のいずれかで指定します。何も指定されていない場合、redis 拡張機能が利用可能な場合は \Redis を返し、それ以外の場合は \Predis\Client を返します。マスター情報を取得するときに問題が発生している場合は、これを \Predis\Client for Sentinel に明示的に設定します。
persistent (type: int, default: 0)
Enables or disables use of persistent connections. A value of 0 disables persistent connections, and a value of 1 enables them.
永続的な接続の使用を有効または無効にします。値 0 は永続接続を無効にし、値 1 はそれらを有効にします。
persistent_id (type: string|null, default: null)
Specifies the persistent id string to use for a persistent connection.
永続的な接続に使用する永続的な ID 文字列を指定します。
timeout (type: int, default: 30)
Specifies the time (in seconds) used to connect to a Redis server before the connection attempt times out.
接続試行がタイムアウトするまでに Redis サーバーへの接続に使用される時間 (秒単位) を指定します。
read_timeout (type: int, default: 0)
Specifies the time (in seconds) used when performing read operations on the underlying network resource before the operation times out.
基になるネットワーク リソースで読み取り操作を実行するときに、操作がタイムアウトするまでの時間 (秒単位) を指定します。
retry_interval (type: int, default: 0)
Specifies the delay (in milliseconds) between reconnection attempts in case the client loses connection with the server.
クライアントがサーバーとの接続を失った場合の再接続試行間の遅延 (ミリ秒単位) を指定します。
tcp_keepalive (type: int, default: 0)
Specifies the TCP-keepalive timeout (in seconds) of the connection. This requires phpredis v4 or higher and a TCP-keepalive enabled server.
接続の TCP キープアライブ タイムアウト (秒単位) を指定します。これには、phpredis v4 以降と TCP キープアライブ対応サーバーが必要です。
lazy (type: bool, default: null)
Enables or disables lazy connections to the backend. It's false by default when using this as a stand-alone component and true by default when using it inside a Symfony application.
バックエンドへの遅延接続を有効または無効にします。これをスタンドアロン コンポーネントとして使用する場合はデフォルトで false であり、Symfony アプリケーション内で使用する場合はデフォルトで true です。
redis_cluster (type: bool, default: false)
Enables or disables redis cluster. The actual value passed is irrelevant as long as it passes loose comparison checks: `redis_cluster=1` will suffice.
redis クラスターを有効または無効にします。渡される実際の値は、緩やかな比較チェックに合格する限り、無関係です: `redis_cluster=1` で十分です。
redis_sentinel (type: string, default: null)
Specifies the master name connected to the sentinels.
センチネルに接続されたマスター名を指定します。
dbindex (type: int, default: 0)
Specifies the database index to select.
選択するデータベース インデックスを指定します。
failover (type: string, default: none)
Specifies failover for cluster implementations. For \RedisCluster valid options are none (default), error, distribute or slaves. For \Predis\ClientInterface valid options are slaves or distribute.
クラスター実装のフェイルオーバーを指定します。 \RedisCluster の場合、有効なオプションは none (デフォルト)、error、distribute、または slaves です。
ssl (type: bool, default: null)
SSL context options. See php.net/context.ssl for more information.
SSL コンテキスト オプション。詳細については、php.net/context.ssl を参照してください。

Note

ノート

When using the Predis library some additional Predis-specific options are available. Reference the Predis Connection Parameters documentation for more information.

Predis ライブラリを使用する場合、いくつかの追加の Predis 固有のオプションを利用できます。詳細については、Predis 接続パラメーターのドキュメントを参照してください。

Working with Tags

In order to use tag-based invalidation, you can wrap your adapter in TagAwareAdapter, but when Redis is used as backend, it's often more interesting to use the dedicated RedisTagAwareAdapter. Since tag invalidation logic is implemented in Redis itself, this adapter offers better performance when using tag-based invalidation:

タグベースの無効化を使用するために、アダプターを TagAwareAdapter でラップできますが、Redis をバックエンドとして使用する場合は、専用の RedisTagAwareAdapter を使用する方が興味深いことがよくあります。タグ無効化ロジックは Redis 自体に実装されているため、このアダプターは、タグベースの無効化を使用する場合により優れたパフォーマンスを提供します。
1
2
3
4
5
 
use Symfony\Component\Cache\Adapter\RedisAdapter;
use Symfony\Component\Cache\Adapter\RedisTagAwareAdapter;

$client = RedisAdapter::createConnection('redis://localhost');
$cache = new RedisTagAwareAdapter($client);

Configuring Redis

When using Redis as cache, you should configure the maxmemory and maxmemory-policy settings. By setting maxmemory, you limit how much memory Redis is allowed to consume. If the amount is too low, Redis will drop entries that would still be useful and you benefit less from your cache. Setting the maxmemory-policy to allkeys-lru tells Redis that it is ok to drop data when it runs out of memory, and to first drop the oldest entries (least recently used). If you do not allow Redis to drop entries, it will return an error when you try to add data when no memory is available. An example setting could look as follows:

Redis をキャッシュとして使用する場合、maxmemory および maxmemory-policy 設定を構成する必要があります。 maxmemory を設定することにより、Redis が消費できるメモリの量を制限します。量が少なすぎる場合、Redis はまだ有用なエントリを削除し、キャッシュからのメリットがなくなります。 maxmemory-policy を allkeys-lru に設定すると、Redis は、メモリが不足したときにデータを削除しても問題なく、最も古いエントリ (最も使用頻度の低い) を最初に削除できることを伝えます。 Redis がエントリをドロップすることを許可しない場合、使用可能なメモリがないときにデータを追加しようとすると、エラーが返されます。設定例は次のようになります。
1
2
 
maxmemory 100mb
maxmemory-policy allkeys-lru

Read more about this topic in the official Redis LRU Cache Documentation.

このトピックの詳細については、公式の Redis LRU キャッシュ ドキュメントを参照してください。