Laravel 11.x キャッシュ

イントロダクションIntroduction

アプリケーションによって実行されるデータ取得または処理タスクの一部は、ＣＰＵに負荷がかかるか、完了するまでに数秒かかる場合があります。この場合、取得したデータを一時的にキャッシュして、同じデータに対する後続のリクエストですばやく取得できるようにするのが一般的です。キャッシュするデータは通常、MemcachedやRedisなどの非常に高速なデータストアに保存します。Some of the data retrieval or processing tasks performed by your application could be CPU intensive or take several seconds to complete. When this is the case, it is common to cache the retrieved data for a time so it can be retrieved quickly on subsequent requests for the same data. The cached data is usually stored in a very fast data store such as Memcached[https://memcached.org] or Redis[https://redis.io].

幸いLaravelはさまざまなキャッシュバックエンドに表現力豊かで統一されたAPIを提供し、その超高速データ取得を利用してWebアプリケーションを高速化できるようにします。Thankfully, Laravel provides an expressive, unified API for various cache backends, allowing you to take advantage of their blazing fast data retrieval and speed up your web application.

設定Configuration

アプリケーションのキャッシュ設定ファイルは、config/cache.phpにあります。アプリケーション全体でデフォルトとして使用するキャッシュストアをこのファイルで指定します。Laravelは、Memcached、Redis、DynamoDB、リレーショナルデータベースなど一般的なキャッシュバックエンドをサポートしています。さらに、ファイルベースのキャッシュドライバも利用でき、arrayキャッシュドライバと"null"キャッシュドライバは、自動テストに便利なキャッシュバックエンドを提供します。Your application's cache configuration file is located at config/cache.php. In this file, you may specify which cache store you would like to be used by default throughout your application. Laravel supports popular caching backends like Memcached[https://memcached.org], Redis[https://redis.io], DynamoDB[https://aws.amazon.com/dynamodb], and relational databases out of the box. In addition, a file based cache driver is available, while array and "null" cache drivers provide convenient cache backends for your automated tests.

キャッシュ設定ファイルには、他にも様々なオプションがあるので確認してください。Laravelはデフォルトで、databaseキャッシュドライバを使用するように設定してあり、シリアライズ済みのキャッシュオブジェクトをアプリケーションのデータベースに保存します。The cache configuration file also contains a variety of other options that you may review. By default, Laravel is configured to use the database cache driver, which stores the serialized, cached objects in your application's database.

ドライバ要件Driver Prerequisites

データベースDatabase

databaseキャッシュドライバを使用する場合、キャッシュデータを格納するデータベーステーブルが必要になります。通常、これはLaravelの0001_01_01_000001_create_cache_table.php データベースマイグレーションにデフォルトで含まれていますが、アプリケーションにこのマイグレーションが含まれていない場合は、make:cache-table Artisanコマンドを使用して生成してください。When using the database cache driver, you will need a database table to contain the cache data. Typically, this is included in Laravel's default 0001_01_01_000001_create_cache_table.php database migration[/docs/{{version}}/migrations]; however, if your application does not contain this migration, you may use the make:cache-table Artisan command to create it:

php artisan make:cache-table

php artisan migrate

MemcachedMemcached

Memcachedドライバを使用するには、Memcached PECLパッケージがインストールされている必要があります。すべてのMemcachedサーバをconfig/cache.php設定ファイルにリストしてください。このファイルには、設定しやすいようにmemcached.serversエントリがはじめから用意しています。Using the Memcached driver requires the Memcached PECL package[https://pecl.php.net/package/memcached] to be installed. You may list all of your Memcached servers in the config/cache.php configuration file. This file already contains a memcached.servers entry to get you started:

'memcached' => [
    // …

    'servers' => [
        [
            'host' => env('MEMCACHED_HOST', '127.0.0.1'),
            'port' => env('MEMCACHED_PORT', 11211),
            'weight' => 100,
        ],
    ],
],

必要に応じて、hostオプションをUNIXソケットパスに設定できます。これを行う場合は、portオプションを0に設定する必要があります。If needed, you may set the host option to a UNIX socket path. If you do this, the port option should be set to 0:

'memcached' => [
    // …

    'servers' => [
        [
            'host' => '/var/run/memcached/memcached.sock',
            'port' => 0,
            'weight' => 100
        ],
    ],
],

RedisRedis

LaravelでRedisキャッシュを使用する前に、PECL経由でPhpRedis PHP拡張をインストールするか、Composer経由でpredis/predisパッケージ（~2.0）をインストールする必要があります。Laravel Sailはあらかじめ、この拡張機能をふくんでいます。さらに、Laravel ForgeやLaravel Vaporなどの公式Laravelデプロイメントプラットフォームには、デフォルトでPhpRedis拡張をインストールしています。Before using a Redis cache with Laravel, you will need to either install the PhpRedis PHP extension via PECL or install the predis/predis package (~2.0) via Composer. Laravel Sail[/docs/{{version}}/sail] already includes this extension. In addition, official Laravel deployment platforms such as Laravel Forge[https://forge.laravel.com] and Laravel Vapor[https://vapor.laravel.com] have the PhpRedis extension installed by default.

Redisの設定の詳細については、Laravelドキュメントページを参照してください。For more information on configuring Redis, consult its Laravel documentation page[/docs/{{version}}/redis#configuration].

DynamoDBDynamoDB

DynamoDBキャッシュドライバを使用する前に、すべてのキャッシュデータを格納するDynamoDBテーブルを作成する必要があります。通常、このテーブルはcacheという名前にします。ただし、cache設定ファイル内のstores.dynamodb.table設定値に基づいてテーブル名を付ける必要があります。テーブル名はDYNAMODB_CACHE_TABLE環境変数で設定することもできます。Before using the DynamoDB[https://aws.amazon.com/dynamodb] cache driver, you must create a DynamoDB table to store all of the cached data. Typically, this table should be named cache. However, you should name the table based on the value of the stores.dynamodb.table configuration value within the cache configuration file. The table name may also be set via the DYNAMODB_CACHE_TABLE environment variable.

このテーブルには、アプリケーションのcache設定ファイル内のstores.dynamodb.attributes.key設定項目の値に対応する名前の、文字列パーティションキーもあります。デフォルトでは、パーティションキーはkeyという名前にする必要があります。This table should also have a string partition key with a name that corresponds to the value of the stores.dynamodb.attributes.key configuration item within your application's cache configuration file. By default, the partition key should be named key.

通常、DynamoDBは期限切れのアイテムをテーブルから積極的に削除しません。そのため、テーブルでTTL (Time to Live)を有効にする必要があります。テーブルのTTLを設定する場合、TTL属性名をexpires_atに設定します。Typically, DynamoDB will not proactively remove expired items from a table. Therefore, you should enable Time to Live (TTL)[https://docs.aws.amazon.com/amazondynamodb/latest/developerguide/TTL.html] on the table. When configuring the table's TTL settings, you should set the TTL attribute name to expires_at.

次に、LaravelアプリケーションがDynamoDBと通信できるように、AWS SDKをインストールします。Next, install the AWS SDK so that your Laravel application can communicate with DynamoDB:

composer require aws/aws-sdk-php

加えて、DynamoDBキャッシュストアの設定オプションへ値を確実に指定してください。AWS_ACCESS_KEY_IDやAWS_SECRET_ACCESS_KEYなどのオプションは、アプリケーションの.env設定ファイルで定義する必要があります。In addition, you should ensure that values are provided for the DynamoDB cache store configuration options. Typically these options, such as AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY, should be defined in your application's .env configuration file:

'dynamodb' => [
    'driver' => 'dynamodb',
    'key' => env('AWS_ACCESS_KEY_ID'),
    'secret' => env('AWS_SECRET_ACCESS_KEY'),
    'region' => env('AWS_DEFAULT_REGION', 'us-east-1'),
    'table' => env('DYNAMODB_CACHE_TABLE', 'cache'),
    'endpoint' => env('DYNAMODB_ENDPOINT'),
],

キャッシュ使用法Cache Usage

キャッシュインスタンスの取得Obtaining a Cache Instance

キャッシュ保存域インスタンスを取得するには、Cacheファサードを使用できます。これは、このドキュメント全体で使用します。Cacheファサードは、Laravelキャッシュ契約の基盤となる実装への便利で簡潔なアクセスを提供します。To obtain a cache store instance, you may use the Cache facade, which is what we will use throughout this documentation. The Cache facade provides convenient, terse access to the underlying implementations of the Laravel cache contracts:

<?php

namespace App\Http\Controllers;

use Illuminate\Support\Facades\Cache;

class UserController extends Controller
{
    /**
     * アプリケーションのすべてのユーザーのリストを表示
     */
    public function index(): array
    {
        $value = Cache::get('key');

        return [
            // …
        ];
    }
}

複数のキャッシュ保存域へのアクセスAccessing Multiple Cache Stores

Cacheファサードを使用すると、storeメソッドを介してさまざまなキャッシュ保存域にアクセスできます。storeメソッドに渡されるキーは、cache設定ファイルのstores設定配列にリストされている保存域の１つに対応している必要があります。Using the Cache facade, you may access various cache stores via the store method. The key passed to the store method should correspond to one of the stores listed in the stores configuration array in your cache configuration file:

$value = Cache::store('file')->get('foo');

Cache::store('redis')->put('bar', 'baz', 600); // １０分

キャッシュからのアイテム取得Retrieving Items From the Cache

Cacheファサードのgetメソッドは、キャッシュからアイテムを取得するために使用します。アイテムがキャッシュに存在しない場合、nullを返します。必要に応じて、アイテムが存在しない場合に返されるデフォルト値を指定する２番目の引数をgetメソッドに渡すことができます。The Cache facade's get method is used to retrieve items from the cache. If the item does not exist in the cache, null will be returned. If you wish, you may pass a second argument to the get method specifying the default value you wish to be returned if the item doesn't exist:

$value = Cache::get('key');

$value = Cache::get('key', 'default');

デフォルト値としてクロージャを渡すこともできます。指定されたアイテムがキャッシュに存在しない場合、クロージャの結果が返されます。クロージャを渡すことで、データベースまたは他の外部サービスからのデフォルト値の取得を延期できるようになります。You may even pass a closure as the default value. The result of the closure will be returned if the specified item does not exist in the cache. Passing a closure allows you to defer the retrieval of default values from a database or other external service:

$value = Cache::get('key', function () {
    return DB::table(/* … */)->get();
});

アイテムの存在を判定Determining Item Existence

hasメソッドを使用して、アイテムがキャッシュに存在するかを判定できます。このメソッドは、アイテムが存在するがその値がnullの場合にも、falseを返します。The has method may be used to determine if an item exists in the cache. This method will also return false if the item exists but its value is null:

if (Cache::has('key')) {
    // …
}

値の増減Incrementing / Decrementing Values

incrementメソッドとdecrementメソッドを使用して、キャッシュ内の整数項目の値を増減できます。これらのメソッドは両方とも、アイテムの値をインクリメントまたはデクリメントする数を示すオプションの２番目の引数を取ります。The increment and decrement methods may be used to adjust the value of integer items in the cache. Both of these methods accept an optional second argument indicating the amount by which to increment or decrement the item's value:

// 存在しない場合、値を初期設定
Cache::add('key', 0, now()->addHours(4));

// 値の増分と減分
Cache::increment('key');
Cache::increment('key', $amount);
Cache::decrement('key');
Cache::decrement('key', $amount);

取得か保存Retrieve and Store

時に、キャッシュからアイテムを取得したいが、リクエストされたアイテムが存在しない場合はデフォルト値を保存したい場合があります。たとえば、すべてのユーザーをキャッシュから取得するか、存在しない場合はデータベースから取得してキャッシュに追加できます。これは、Cache::rememberメソッドを使用して行えます。Sometimes you may wish to retrieve an item from the cache, but also store a default value if the requested item doesn't exist. For example, you may wish to retrieve all users from the cache or, if they don't exist, retrieve them from the database and add them to the cache. You may do this using the Cache::remember method:

$value = Cache::remember('users', $seconds, function () {
    return DB::table('users')->get();
});

アイテムがキャッシュに存在しない場合、rememberメソッドに渡されたクロージャが実行され、その結果がキャッシュに配置されます。If the item does not exist in the cache, the closure passed to the remember method will be executed and its result will be placed in the cache.

rememberForeverメソッドを使用して、キャッシュからアイテムを取得するか、アイテムが存在しない場合は永久に保存できます。You may use the rememberForever method to retrieve an item from the cache or store it forever if it does not exist:

$value = Cache::rememberForever('users', function () {
    return DB::table('users')->get();
});

Stale While RevalidateStale While Revalidate

Cache::rememberメソッドを使用する場合、キャッシュ済の値が有効期限切れだと、レスポンスが遅くなるのを一部のユーザーは経験しています。データの種類により、キャッシュ済み値をバックグラウンドで再計算する間、部分的に古くなったデータを提供できるようにすることで、キャッシュ済み値を計算する間にレスポンスが遅くなることを防止できます。これはしばしば、"stale-while-revalidate"パターンと呼ばれ、Cache::flexibleメソッドはこのパターンの実装を提供します。When using the Cache::remember method, some users may experience slow response times if the cached value has expired. For certain types of data, it can be useful to allow partially stale data to be served while the cached value is recalculated in the background, preventing some users from experiencing slow response times while cached values are calculated. This is often referred to as the "stale-while-revalidate" pattern, and the Cache::flexible method provides an implementation of this pattern.

flexibleメソッドは、キャッシュ済み値を「新しい」とみなす時間と、「古い」とみなす時間を指定する配列を引数に取ります。配列の最初の値は、キャッシュが新鮮だとみなす秒数を表し、２番目の値は再計算が必要になるまでにどれくらいの時間、古いデータとして提供できるかを定義します。The flexible method accepts an array that specifies how long the cached value is considered “fresh” and when it becomes “stale.” The first value in the array represents the number of seconds the cache is considered fresh, while the second value defines how long it can be served as stale data before recalculation is necessary.

リクエストがフレッシュ期間内（最初の値の前）に行われた場合、キャッシュを再計算せず直ちに返します。もしリクエストが古い期間中(２つの値の間)に行われた場合、古い値をユーザーに提供し、レスポンスをユーザーへ送った後に、キャッシュ済み値をリフレッシュするために遅延関数を登録します。もし２番目の値より後にリクエストが行われた場合、キャッシュを期限切れとみなし、値を即座に再計算します。If a request is made within the fresh period (before the first value), the cache is returned immediately without recalculation. If a request is made during the stale period (between the two values), the stale value is served to the user, and a deferred function[/docs/{{version}}/helpers#deferred-functions] is registered to refresh the cached value after the response is sent to the user. If a request is made after the second value, the cache is considered expired, and the value is recalculated immediately, which may result in a slower response for the user:

$value = Cache::flexible('users', [5, 10], function () {
    return DB::table('users')->get();
});

取得後、削除Retrieve and Delete

キャッシュからアイテムを取得してからアイテムを削除する必要がある場合は、pullメソッドを使用できます。getメソッドと同様に、アイテムがキャッシュに存在しない場合はnullが返されます。If you need to retrieve an item from the cache and then delete the item, you may use the pull method. Like the get method, null will be returned if the item does not exist in the cache:

$value = Cache::pull('key');

$value = Cache::pull('key', 'default');

キャッシュへのアイテム保存Storing Items in the Cache

Cacheファサードでputメソッドを使用して、アイテムをキャッシュに保存できます。You may use the put method on the Cache facade to store items in the cache:

Cache::put('key', 'value', $seconds = 10);

保存時間がputメソッドに渡されない場合、アイテムは無期限に保存されます。If the storage time is not passed to the put method, the item will be stored indefinitely:

Cache::put('key', 'value');

秒数を整数として渡す代わりに、キャッシュするアイテムの有効期限を表すDateTimeインスタンスを渡すこともできます。Instead of passing the number of seconds as an integer, you may also pass a DateTime instance representing the desired expiration time of the cached item:

Cache::put('key', 'value', now()->addMinutes(10));

存在しない場合は保存Store if Not Present

addメソッドは、アイテムがキャッシュストアにまだ存在しない場合にのみ、アイテムをキャッシュに追加します。アイテムが実際にキャッシュに追加された場合、メソッドはtrueを返します。それ以外の場合にメソッドはfalseを返します。addメソッドはアトミック操作です。The add method will only add the item to the cache if it does not already exist in the cache store. The method will return true if the item is actually added to the cache. Otherwise, the method will return false. The add method is an atomic operation:

Cache::add('key', 'value', $seconds);

アイテムを永久に保存Storing Items Forever

foreverメソッドを使用して、アイテムをキャッシュに永続的に保存できます。保存アイテムは期限切れにならないため、forgetメソッドを使用して手作業でキャッシュから削除する必要があります。The forever method may be used to store an item in the cache permanently. Since these items will not expire, they must be manually removed from the cache using the forget method:

Cache::forever('key', 'value');

lightbulb Note: Memcachedドライバを使用している場合、「永久に」保存されているアイテムは、キャッシュがサイズ制限に達すると削除される可能性があります。[!NOTE]
If you are using the Memcached driver, items that are stored "forever" may be removed when the cache reaches its size limit.

キャッシュからのアイテム削除Removing Items From the Cache

forgetメソッドを使用してキャッシュからアイテムを削除できます。You may remove items from the cache using the forget method:

Cache::forget('key');

有効期限の秒数をゼロまたは負にすることで、アイテムを削除することもできます。You may also remove items by providing a zero or negative number of expiration seconds:

Cache::put('key', 'value', 0);

Cache::put('key', 'value', -5);

flushメソッドを使用してキャッシュ全体をクリアできます。You may clear the entire cache using the flush method:

Cache::flush();

warning Warning! キャッシュのフラッシュは、設定したキャッシュの「プレフィックス」を尊重せず、キャッシュからすべてのエントリを削除します。他のアプリケーションと共有するキャッシュをクリアするときは、これを慎重に検討してください。[!WARNING]
Flushing the cache does not respect your configured cache "prefix" and will remove all entries from the cache. Consider this carefully when clearing a cache which is shared by other applications.

キャッシュヘルパThe Cache Helper

Cacheファサードの使用に加え、グローバルなcache関数を使用して、キャッシュによるデータの取得および保存もできます。cache関数が単一の文字列引数で呼び出されると、指定されたキーの値を返します。In addition to using the Cache facade, you may also use the global cache function to retrieve and store data via the cache. When the cache function is called with a single, string argument, it will return the value of the given key:

$value = cache('key');

キーと値のペアの配列と有効期限を関数に指定すると、指定された期間、値がキャッシュに保存されます。If you provide an array of key / value pairs and an expiration time to the function, it will store values in the cache for the specified duration:

cache(['key' => 'value'], $seconds);

cache(['key' => 'value'], now()->addMinutes(10));

cache関数を引数なしで呼び出すと、Illuminate\Contracts\Cache\Factory実装のインスタンスが返され、他のキャッシュメソッドを呼び出せます。When the cache function is called without any arguments, it returns an instance of the Illuminate\Contracts\Cache\Factory implementation, allowing you to call other caching methods:

cache()->remember('users', $seconds, function () {
    return DB::table('users')->get();
});

lightbulb Note: グローバルなcache関数の呼び出しをテストするときは、ファサードをテストするのようにCache::shouldReceiveメソッドを使用できます。[!NOTE]
When testing call to the global cache function, you may use the Cache::shouldReceive method just as if you were testing the facade[/docs/{{version}}/mocking#mocking-facades].

アトミックロックAtomic Locks

warning Warning! この機能を利用するには、アプリケーションのデフォルトのキャッシュドライバとして、memcached、redis、dynamodb、database、file、arrayキャッシュドライバを使用する必要があります。さらに、すべてのサーバが同じ中央キャッシュサーバと通信している必要があります。[!WARNING]
To utilize this feature, your application must be using the memcached, redis, dynamodb, database, file, or array cache driver as your application's default cache driver. In addition, all servers must be communicating with the same central cache server.

ロック管理Managing Locks

アトミックロックを使用すると、競合状態を気にすることなく分散ロックを操作できます。たとえば、Laravel Forgeは、アトミックロックを使用して、サーバ上で一度に1つのリモートタスクのみが実行されるようにしています。Cache::lockメソッドを使用してロックを作成および管理できます。Atomic locks allow for the manipulation of distributed locks without worrying about race conditions. For example, Laravel Forge[https://forge.laravel.com] uses atomic locks to ensure that only one remote task is being executed on a server at a time. You may create and manage locks using the Cache::lock method:

use Illuminate\Support\Facades\Cache;

$lock = Cache::lock('foo', 10);

if ($lock->get()) {
    // ロックを10秒間取得

    $lock->release();
}

getメソッドもクロージャを受け入れます。クロージャが実行された後、Laravelは自動的にロックを解除します。The get method also accepts a closure. After the closure is executed, Laravel will automatically release the lock:

Cache::lock('foo', 10)->get(function () {
    // ロックを１０秒間取得し、自動的に開放
});

リクエストした時点でロックが利用できない場合に、指定された秒数待つようにLaravelへ指示できます。指定された制限時間内にロックを取得できない場合、Illuminate\Contracts\Cache\LockTimeoutExceptionを投げます。If the lock is not available at the moment you request it, you may instruct Laravel to wait for a specified number of seconds. If the lock cannot be acquired within the specified time limit, an Illuminate\Contracts\Cache\LockTimeoutException will be thrown:

use Illuminate\Contracts\Cache\LockTimeoutException;

$lock = Cache::lock('foo', 10);

try {
    $lock->block(5);

    // ロック取得を最大５秒待つ
} catch (LockTimeoutException $e) {
    // ロック取得失敗
} finally {
    $lock->release();
}

上記の例は、クロージャをblockメソッドに渡すことで簡略化できます。クロージャがこのメソッドに渡されると、Laravelは指定された秒数の間ロックを取得しようとし、クロージャが実行されると自動的にロックを解放します。The example above may be simplified by passing a closure to the block method. When a closure is passed to this method, Laravel will attempt to acquire the lock for the specified number of seconds and will automatically release the lock once the closure has been executed:

Cache::lock('foo', 10)->block(5, function () {
    // ロック取得を最大５秒待つ
});

プロセス間でのロック管理Managing Locks Across Processes

あるプロセスでロックを取得し、別のプロセスでそれを解放したい場合があります。たとえば、Webリクエスト中にロックを取得し、そのリクエストによってトリガーされたキュー投入済みジョブの終了時にロックを解放したい場合があるでしょう。このシナリオでは、ロックのスコープ付き「所​​有者トークン」をキュー投入済みジョブに渡し、ジョブが渡されたトークンを使用してロックを再インスタンス化できるようにする必要があります。Sometimes, you may wish to acquire a lock in one process and release it in another process. For example, you may acquire a lock during a web request and wish to release the lock at the end of a queued job that is triggered by that request. In this scenario, you should pass the lock's scoped "owner token" to the queued job so that the job can re-instantiate the lock using the given token.

以下の例では、ロックが正常に取得された場合に、キュー投入済みジョブをディスパッチします。さらに、ロックのownerメソッドを介して、ロックの所有者トークンをキュー投入済みジョブに渡します。In the example below, we will dispatch a queued job if a lock is successfully acquired. In addition, we will pass the lock's owner token to the queued job via the lock's owner method:

$podcast = Podcast::find($id);

$lock = Cache::lock('processing', 120);

if ($lock->get()) {
    ProcessPodcast::dispatch($podcast, $lock->owner());
}

アプリケーションのProcessPodcastジョブ内で、所有者トークンを使用してロックを復元し、解放できます。Within our application's ProcessPodcast job, we can restore and release the lock using the owner token:

Cache::restoreLock('processing', $this->owner)->release();

現在の所有者を尊重せずにロックを解放したい場合は、forceReleaseメソッドを使用できます。If you would like to release a lock without respecting its current owner, you may use the forceRelease method:

Cache::lock('processing')->forceRelease();

カスタムキャッシュドライバの追加Adding Custom Cache Drivers

ドライバの作成Writing the Driver

カスタムキャッシュドライバを作成するには、最初にIlluminate\Contracts\Cache\Store契約を実装する必要があります。したがって、MongoDBキャッシュの実装は次のようになります。To create our custom cache driver, we first need to implement the Illuminate\Contracts\Cache\Store contract[/docs/{{version}}/contracts]. So, a MongoDB cache implementation might look something like this:

<?php

namespace App\Extensions;

use Illuminate\Contracts\Cache\Store;

class MongoStore implements Store
{
    public function get($key) {}
    public function many(array $keys) {}
    public function put($key, $value, $seconds) {}
    public function putMany(array $values, $seconds) {}
    public function increment($key, $value = 1) {}
    public function decrement($key, $value = 1) {}
    public function forever($key, $value) {}
    public function forget($key) {}
    public function flush() {}
    public function getPrefix() {}
}

MongoDB接続を使用してこれらの各メソッドを実装する必要があります。これらの各メソッドを実装する方法の例については、LaravelフレームワークのソースコードのIlluminate\Cache\MemcachedStoreをご覧ください。実装が完了したら、Cacheファサードのextendメソッドを呼び出してカスタムドライバの登録を完了してください。We just need to implement each of these methods using a MongoDB connection. For an example of how to implement each of these methods, take a look at the Illuminate\Cache\MemcachedStore in the Laravel framework source code[https://github.com/laravel/framework]. Once our implementation is complete, we can finish our custom driver registration by calling the Cache facade's extend method:

Cache::extend('mongo', function (Application $app) {
    return Cache::repository(new MongoStore);
});

lightbulb Note: カスタムキャッシュドライバコードをどこに置くか迷っている場合は、appディレクトリ内にExtensions名前空間を作成できます。ただし、Laravelには厳密なアプリケーション構造がなく、好みに応じてアプリケーションを自由にオーガナイズできることに注意してください。[!NOTE]
If you're wondering where to put your custom cache driver code, you could create an Extensions namespace within your app directory. However, keep in mind that Laravel does not have a rigid application structure and you are free to organize your application according to your preferences.

Registering the DriverRegistering the Driver

カスタムキャッシュドライバをLaravelに登録するには、Cacheファサードでextendメソッドを使用します。他のサービスプロバイダはbootメソッド内でキャッシュされた値を読み取ろうとする可能性があるため、bootingコールバック内にカスタムドライバを登録します。bootingコールバックを使用することで、アプリケーションのサービスプロバイダでbootメソッドが呼び出される直前で、すべてのサービスプロバイダでregisterメソッドが呼び出された後にカスタムドライバが登録されるようにすることができます。アプリケーションのApp\Providers\AppServiceProviderクラスのregisterメソッド内にbootingコールバックを登録します。To register the custom cache driver with Laravel, we will use the extend method on the Cache facade. Since other service providers may attempt to read cached values within their boot method, we will register our custom driver within a booting callback. By using the booting callback, we can ensure that the custom driver is registered just before the boot method is called on our application's service providers but after the register method is called on all of the service providers. We will register our booting callback within the register method of our application's App\Providers\AppServiceProvider class:

<?php

namespace App\Providers;

use App\Extensions\MongoStore;
use Illuminate\Contracts\Foundation\Application;
use Illuminate\Support\Facades\Cache;
use Illuminate\Support\ServiceProvider;

class AppServiceProvider extends ServiceProvider
{
    /**
     * アプリケーションの全サービスの登録
     */
    public function register(): void
    {
        $this->app->booting(function () {
             Cache::extend('mongo', function (Application $app) {
                 return Cache::repository(new MongoStore);
             });
         });
    }

    /**
     * 全アプリケーションサービスの初期起動処理
     */
    public function boot(): void
    {
        // …
    }
}

extendメソッドに渡す最初の引数はドライバの名前です。これは、config/cache.php設定ファイルのdriverオプションに対応させます。２番目の引数は、Illuminate\Cache\Repositoryインスタンスを返す必要があるクロージャです。クロージャには、サービスコンテナのインスタンスである$appインスタンスが渡されます。The first argument passed to the extend method is the name of the driver. This will correspond to your driver option in the config/cache.php configuration file. The second argument is a closure that should return an Illuminate\Cache\Repository instance. The closure will be passed an $app instance, which is an instance of the service container[/docs/{{version}}/container].

拡張機能を登録したら、アプリケーションのconfig/cache.php設定ファイル内のCACHE_STORE環境変数、またはdefaultオプションを拡張機能の名前に更新します。Once your extension is registered, update the CACHE_STORE environment variable or default option within your application's config/cache.php configuration file to the name of your extension.

イベントEvents

すべてのキャッシュ操作でコードを実行できるように、キャッシュがディスパッチするさまざまなイベントをリッスンできます。To execute code on every cache operation, you may listen for various events[/docs/{{version}}/events] dispatched by the cache:

パフォーマンスを向上させるために、config/cache.php設定ファイルのevents設定オプションをfalseに設定し、イベントのキャッシュ保存を無効にできます。To increase performance, you may disable cache events by setting the events configuration option to false for a given cache store in your application's config/cache.php configuration file:

'database' => [
    'driver' => 'database',
    // ...
    'events' => false,
],