キャッシュ¶

Cache エンジンの設定¶

static Cake\Cache\Cache::config($key, $config = null)¶

アプリケーションは、ブート処理中に任意の数の「エンジン」を設定できます。 キャッシュエンジンの設定は、 config/app.php で定義されています。

最適なパフォーマンスを得るには、CakePHP では2つのキャッシュエンジンを定義する必要があります。

• _cake_core_ は、ファイル構成の保存と、 国際化と地域化 ファイルの結果のパースに使用されます。
• _cake_model_ は、アプリケーション上のモデルに対するスキーマの説明を保存するために使用されます。

複数のエンジン設定を使用することで、必要に応じてストレージを段階的に変更できます。 例えば、以下のように config/app.php に設定できます。

// ...
'Cache' => [
    'short' => [
        'className' => 'File',
        'duration' => '+1 hours',
        'path' => CACHE,
        'prefix' => 'cake_short_'
    ],
    // 完全な名前空間つきの名前を使用。
    'long' => [
        'className' => 'Cake\Cache\Engine\FileEngine',
        'duration' => '+1 week',
        'probability' => 100,
        'path' => CACHE . 'long' . DS,
    ]
]
// ...

オプション設定は DSN を指定することもできます。 これは環境変数や PaaS プロバイダーと一緒に動作するときに便利です。

Cache::config('short', [
    'url' => 'memcached://user:password@cache-host/?timeout=3600&prefix=myapp_',
]);

DSN を使用するとき、追加のクエリー文字列要素としてパラメーターやオプションが定義できます。

実行時におけるキャッシュエンジンの設定もできます。

// 短い名前で
Cache::config('short', [
    'className' => 'File',
    'duration' => '+1 hours',
    'path' => CACHE,
    'prefix' => 'cake_short_'
]);

// 完全な名前空間つきの名前を使用。
Cache::config('long', [
    'className' => 'Cake\Cache\Engine\FileEngine',
    'duration' => '+1 week',
    'probability' => 100,
    'path' => CACHE . 'long' . DS,
]);

// オブジェクトで
$object = new FileEngine($config);
Cache::config('other', $object);

これらのエンジン設定の名前 ('short' や 'long') は Cake\Cache\Cache::write() と Cake\Cache\Cache::read() の $config パラメーターとして使われます。 キャッシュエンジンを設定する場合は、次の構文を使用してクラス名を参照することができます。

// 省略名 (App\ または Cake 名前空間の中)
Cache::config('long', ['className' => 'File']);

// プラグインの省略名
Cache::config('long', ['className' => 'MyPlugin.SuperCache']);

// 完全な名前空間
Cache::config('long', ['className' => 'Cake\Cache\Engine\FileEngine']);

// CacheEngineInterface を実装したオブジェクト
Cache::config('long', ['className' => $myCache]);

Cache::config('redis', [
    'className' => 'Redis',
    'duration' => '+1 hours',
    'prefix' => 'cake_redis_',
    'host' => '127.0.0.1',
    'port' => 6379,
    'fallback' => 'default',
]);

Cache::config('redis', [
    'className' => 'Redis',
    'duration' => '+1 hours',
    'prefix' => 'cake_redis_',
    'host' => '127.0.0.1',
    'port' => 6379,
    'fallback' => false
]);

キャッシュへの書き込み¶

static Cake\Cache\Cache::write($key, $value, $config = 'default')¶

Cache::write() はキャッシュに $value を書き込みます。 この値は後で $key で参照したり、削除したりすることができます。 オプションの設定を指定して、キャッシュを保存することもできます。 $config を指定しない場合、デフォルトが使用されます。 Cache::write() はあらゆるタイプのオブジェクトを格納することができ、 以下のようにモデルの結果を格納するのに理想的です。

if (($posts = Cache::read('posts')) === false) {
    $posts = $someService->getAllPosts();
    Cache::write('posts', $posts);
}

Cache::write() と Cache::read() を使用して、データベースへのアクセスを減らし、 posts を取得しています。

$result = Cache::writeMany([
    'article-' . $slug => $article,
    'article-' . $slug . '-comments' => $comments
]);

// $result は以下を含みます
['article-first-post' => true, 'article-first-post-comments' => true]

class IssueService
{
    public function allIssues($repo)
    {
        return Cache::remember($repo . '-issues', function () use ($repo) {
            return $this->fetchAll($repo);
        });
    }
}

キャッシュからの読み込み¶

static Cake\Cache\Cache::read($key, $config = 'default')¶

Cache::read() は、 $key 配下に格納されたキャッシュされた値を $config から読み込むために使用されます。 $config が null の場合、 デフォルトの設定が使用されます。 Cache::read() は、有効なキャッシュであれば キャッシュされた値を返し、キャッシュが期限切れになっているか存在しない場合は false を返します。 キャッシュの内容は false と評価される可能性があるので、必ず厳密な比較演算子 === または !== を使用してください。

例:

$cloud = Cache::read('cloud');

if ($cloud !== false) {
    return $cloud;
}

// クラウドデータを生成する
// ...

// キャッシュにデータを保存する
Cache::write('cloud', $cloud);
return $cloud;

$result = Cache::readMany([
    'article-' . $slug,
    'article-' . $slug . '-comments'
]);
// $result は以下を含みます
['article-first-post' => '...', 'article-first-post-comments' => '...']

キャッシュからの削除¶

static Cake\Cache\Cache::delete($key, $config = 'default')¶

Cache::delete() を使うと、キャッシュされたオブジェクトをストアから完全に削除できます。

// キーの削除
Cache::delete('my_key');

$result = Cache::deleteMany([
    'article-' . $slug,
    'article-' . $slug . '-comments'
]);
// $result は以下を含みます
['article-first-post' => true, 'article-first-post-comments' => true]

キャッシュデータのクリア¶

static Cake\Cache\Cache::clear($check, $config = 'default')¶

キャッシュ設定から、すべてのキャッシュされた値を破棄します。Apcu、Memcached、Wincache などのエンジンでは、キャッシュ設定のプレフィックスを使用してキャッシュエントリーを削除します。 異なるキャッシュ設定には異なる接頭辞が付いていることを確認してください。

// 有効期限切れのキーのみをクリアする。
Cache::clear(true);

// すべてのキーをクリアする。
Cache::clear(false);

static Cake\Cache\Cache::gc($config)¶

キャッシュ設定内のガベージコレクトエントリー。これは主に FileEngine で使用されます。 キャッシュされたデータを手動で削除する必要のある任意のキャッシュエンジンによって実装される必要があります。

キャッシュを使用してカウンターを保存する¶

static Cake\Cache\Cache::increment($key, $offset = 1, $config = 'default')¶

static Cake\Cache\Cache::decrement($key, $offset = 1, $config = 'default')¶

アプリケーション内のカウンターは、キャッシュに保存するのに適しています。 例として、コンテストの残りの「枠」の単純なカウントダウンをキャッシュに格納することができます。 Cache クラスは簡単な方法でカウンター値をインクリメント/デクリメントするアトミックな方法を公開しています。 競合のリスクを軽減し、同時に2人のユーザーが値を1つ下げて誤った値にする可能性があるため、 これらの値にはアトミック操作が重要です。

整数値を設定した後、 increment() および decrement() を使用して整数値を操作できます。

Cache::write('initial_count', 10);

// 設定した後に
Cache::decrement('initial_count');

// または
Cache::increment('initial_count');

キャッシュを使用して共通のクエリー結果を格納する¶

まれにしか変更されない、またはキャッシュに大量の読み込みが行われるような結果をキャッシュすることによって、 アプリケーションのパフォーマンスを大幅に向上させることができます。 この完璧な例は、 Cake\ORM\Table::find() の結果です。 この Query オブジェクトを使用すると、 cache() メソッドを使用して結果をキャッシュできます。 詳細は、 ロードされた結果をキャッシュする セクションを参照してください。

グループの使用¶

たまに、複数のキャッシュエントリーを特定のグループまたは名前空間に属するようにマークしたい場合があります。 同じグループ内のすべてのエントリーで共有される情報が変更されるたびに、キーを大量に無効化したいというのは 一般的な要件です。これは、キャッシュ設定でグループを宣言することで可能です。

Cache::config('site_home', [
    'className' => 'Redis',
    'duration' => '+999 days',
    'groups' => ['comment', 'article']
]);

Cake\Cache\Cache::clearGroup($group, $config = 'default')¶

ホームページに生成された HTML をキャッシュに保存したいが、 コメントや投稿がデータベースに追加されるたびにこのキャッシュを自動的に無効にしたいとします。 comment と article グループを追加することで、このキャッシュ設定に保存されているキーに、 両方のグループ名で効果的にタグを付けできます。

たとえば、新しい投稿が追加されるたびに、 article グループに関連付けられたすべてのエントリーを 削除するように Cache エンジンに指示できます。

// src/Model/Table/ArticlesTable.php
public function afterSave($event, $entity, $options = [])
{
    if ($entity->isNew()) {
        Cache::clearGroup('article', 'site_home');
    }
}

static Cake\Cache\Cache::groupConfigs($group = null)¶

groupConfigs() を使用すると、グループと設定の間のマッピングを取得できます。 つまり、同じグループを持ちます。

// src/Model/Table/ArticlesTable.php

/**
 * すべてのキャッシュ設定をクリアする前述の例のバリエーション
 * 同じグループを持つ
 */
public function afterSave($event, $entity, $options = [])
{
    if ($entity->isNew()) {
        $configs = Cache::groupConfigs('article');
        foreach ($configs['article'] as $config) {
            Cache::clearGroup('article', $config);
        }
    }
}

グループは、同じエンジンと同じ接頭辞を使用して、すべてのキャッシュ設定で共有されます。 グループを使用していて、グループの削除を使用する場合は、すべての設定の共通プレフィックスを選択します。

全体的にキャッシュを有効または無効にする¶

static Cake\Cache\Cache::disable¶

キャッシュの有効期限に関連する問題を把握しようとするときに、 キャッシュの読み込みと書き込みをすべて無効にする必要があります。 enable() と disable() を使ってこれを行うことができます。

// すべてのキャッシュ読み取りとキャッシュ書き込みを無効にする。
Cache::disable();

無効にすると、すべての読み込みと書き込みは null を返却します。

static Cake\Cache\Cache::enable¶

無効にすると、 enable() を使用してキャッシュを再び有効にすることができます。

// すべてのキャッシュの読み込みと書き込みを再び有効にする。
Cache::enable();

static Cake\Cache\Cache::enabled¶

もしキャッシュの状態を確認する必要がある場合は、 enabled() を使用してください。

キャッシュエンジンの作成¶

独自の Cache エンジンは App\Cache\Engine やプラグインの $plugin\Cache\Engine の中に提供することができます。キャッシュエンジンはキャッシュディレクトリー内になければなりません。 MyCustomCacheEngine という名前のキャッシュエンジンがあれば、 src/Cache/Engine/MyCustomCacheEngine.php に置かれます。また、プラグインの一部として、 plugins/MyPlugin/src/Cache/Engine/MyCustomCacheEngine.php に置かれます。 プラグインのキャッシュ設定は、プラグインのドット構文を使用する必要があります。

Cache::config('custom', [
    'className' => 'MyPlugin.MyCustomCache',
    // ...
]);

カスタムキャッシュエンジンは、いくつかの抽象メソッドを定義するだけでなく、 いくつかの初期化メソッドを提供する Cake\Cache\CacheEngine を拡張する必要があります。

キャッシュエンジンに必要な API は次のとおりです。

class Cake\Cache\CacheEngine¶

Cache で使用されるすべてのキャッシュエンジンの基本クラス。

Cake\Cache\CacheEngine::write($key, $value)¶

戻り値:	成功時に boolean

キーの値をキャッシュに書き込み、データが正常にキャッシュされた場合は true を返し、失敗した場合は false を返します。

Cake\Cache\CacheEngine::read($key)¶

戻り値:	キャッシュ値または失敗時に false 。

キャッシュからキーを読み取ります。 エントリーが期限切れまたは存在しないことを示す場合は false を返します。

Cake\Cache\CacheEngine::delete($key)¶

戻り値:	Boolean 成功時に true

キャッシュからキーを削除します。 エントリーが存在しなかったか、削除できなかったことを示す場合は false を返します。

Cake\Cache\CacheEngine::clear($check)¶

戻り値:	Boolean 成功時に true

キャッシュからすべてのキーを削除します。 $check が true の場合、各値が実際に期限切れであることを検証する必要があります。

Cake\Cache\CacheEngine::clearGroup($group)¶

戻り値:	Boolean 成功時に true

同じグループに属するキャッシュからすべてのキーを削除します。

Cake\Cache\CacheEngine::decrement($key, $offset = 1)¶

戻り値:	Boolean 成功時に true

キー配下の数字をデクリメントし、デクリメントされた値を返します。

Cake\Cache\CacheEngine::increment($key, $offset = 1)¶

戻り値:	Boolean 成功時に true

キー配下の数字をインクリメントし、インクリメントされた値を返します。

Cake\Cache\CacheEngine::gc()¶

必須ではありませんが、リソースの有効期限が切れたときにクリーンアップするために使用されます。 FileEngine はこれを使用して、期限切れのコンテンツを含むファイルを削除します。