Laravel API のキャッシュ層を構築する方法-PHPチュートリアル-php.cn

データを提供する API を構築しているとします。GET 応答が非常に遅いことに気づきました。クエリを最適化し、頻繁にクエリされる列によってデータベーステーブルにインデックスを作成しようとしましたが、依然として期待する応答時間が得られません。次のステップは、API のキャッシュレイヤーを作成することです。ここでの「キャッシュ層」とは、成功した応答を高速に取得できるストアに保存するミドルウェアを表す単なる派手な用語です。例えばRedis、Memcached など、その後の API へのリクエストは、データがストアで利用可能かどうかを確認し、応答を返します。

前提条件

ララベル
レディス

始める前に

ここまでたどり着いた方は、laravel アプリの作成方法をご存知だと思います。接続先のローカルまたはクラウド Redis インスタンスも必要です。ローカルに docker がある場合は、ここに作成ファイルをコピーできます。また、Redis キャッシュドライバーに接続する方法のガイドについては、こちらをお読みください。

ダミーデータの作成

キャッシュ層が期待どおりに動作していることを確認できるようにします。もちろん、いくつかのデータが必要です。Post という名前のモデルがあるとします。そこで、いくつかの投稿を作成し、データベースに負荷がかかる可能性のある複雑なフィルタリングも追加します。その後、キャッシュによって最適化できます。

それでは、ミドルウェアの作成を始めましょう:

実行してミドルウェアのスケルトンを作成します

php artisan make:middleware CacheLayer

ログイン後にコピー

次に、次のように app/Http/Kernel.php の API ミドルウェアグループに登録します。

    protected $middlewareGroups = [
        'api' => [
            CacheLayer::class,
        ],
    ];

ログイン後にコピー

ただし、Laravel 11 を実行している場合は、bootstrap/app.php に登録します

->withMiddleware(function (Middleware $middleware) {
        $middleware->api(append: [
            \App\Http\Middleware\CacheLayer::class,
        ]);
    })

ログイン後にコピー

キャッシュ用語

キャッシュヒット: 要求されたデータがキャッシュ内で見つかった場合に発生します。
キャッシュミス: 要求されたデータがキャッシュ内に見つからない場合に発生します。
キャッシュフラッシュ: キャッシュに保存されているデータをクリアして、新しいデータを再入力できるようにします。
キャッシュタグ: これは Redis に固有の機能です。キャッシュタグは、キャッシュ内の関連アイテムをグループ化するために使用される機能で、関連データの管理と無効化を同時に容易にします。
Time to Live (TTL): これは、キャッシュされたオブジェクトが期限切れになるまでの有効期間を指します。よくある誤解の 1 つは、オブジェクトがキャッシュからアクセスされる (キャッシュヒット) たびに、その有効期限がリセットされると考えることです。しかし、これは真実ではありません。たとえば、TTL が 5 分に設定されている場合、キャッシュされたオブジェクトは、その期間内に何回アクセスされても、5 分後に期限切れになります。 5 分が経過すると、そのオブジェクトに対する次のリクエストにより、キャッシュ内に新しいエントリが作成されます。

一意のキャッシュキーの計算

つまり、キャッシュドライバーはキーと値のストアです。キーがあるので、値はjsonになります。したがって、リソースを識別するには一意のキャッシュキーが必要です。一意のキャッシュキーは、キャッシュの無効化、つまり新しいリソースの作成/更新時にキャッシュアイテムを削除するのにも役立ちます。キャッシュキーを生成するための私のアプローチは、リクエスト URL、クエリパラメーター、および本文をオブジェクトに変換することです。次に、それを文字列にシリアル化します。これをキャッシュミドルウェアに追加します:

class CacheLayer 
{
    public function handle(Request $request, Closure $next): Response
    {
    }

    private function getCacheKey(Request $request): string
    {
        $routeParameters = ! empty($request->route()->parameters) ? $request->route()->parameters : [auth()->user()->id];
        $allParameters = array_merge($request->all(), $routeParameters);
        $this->recursiveSort($allParameters);

        return $request->url() . json_encode($allParameters);
    }

    private function recursiveSort(&$array): void
    {
        foreach ($array as &$value) {
            if (is_array($value)) {
                $this->recursiveSort($value);
            }
        }

        ksort($array);
    }
}

ログイン後にコピー

コードを 1 行ずつ見てみましょう。

まず、一致するリクエストパラメータを確認します。 /users/1/posts と /users/2/posts に対して同じキャッシュキーを計算したくありません。
一致するパラメータがない場合は、ユーザーの ID を渡します。この部分はオプションです。現在認証されているユーザーの詳細を返す /user のようなルートがある場合。キャッシュキーでユーザー ID を渡すのが適切です。そうでない場合は、空の配列([])にすることができます。
次に、すべてのクエリパラメーターを取得し、それをリクエストパラメーターとマージします
次にパラメータを並べ替えます。この並べ替え手順が非常に重要なのは、たとえば /posts?page=1&limit=20 と /posts?limit=20&page=1 に対して同じデータを返すことができるためです。したがって、パラメーターの順序に関係なく、同じキャッシュキーが返されます。

路線を除く

したがって、構築しているアプリケーションの性質に応じて異なります。キャッシュしたくない GET ルートがいくつかあるため、これらのルートに一致する正規表現を使用して定数を作成します。これは次のようになります:

 private const EXCLUDED_URLS = [
    '~^api/v1/posts/[0-9a-zA-Z]+/comments(\?.*)?$~i'
'
];

ログイン後にコピー

この場合、この正規表現は投稿のすべてのコメントに一致します。

TTLの構成

このためには、このエントリを config/cache.php に追加するだけです

  'ttl' => now()->addMinutes(5),

ログイン後にコピー

ミドルウェアの作成

これで準備手順がすべて設定され、ミドルウェアコードを作成できるようになりました。

public function handle(Request $request, Closure $next): Response
    {
        if ('GET' !== $method) {
           return $next($request);
        }

        foreach (self::EXCLUDED_URLS as $pattern) {
            if (preg_match($pattern, $request->getRequestUri())) {
                return $next($request);
            }
        }

        $cacheKey = $this->getCacheKey($request);

        $exception = null;

        $response = cache()
            ->tags([$request->url()])
            ->remember(
                key: $cacheKey,
                ttl: config('cache.ttl'),
                callback: function () use ($next, $request, &$exception) {
                    $res = $next($request);

                    if (property_exists($res, 'exception') && null !== $res->exception) {
                        $exception = $res;

                        return null;
                    }

                    return $res;
                }
            );

        return $exception ?? $response;
    }

ログイン後にコピー

First we skip caching for non-GET requests and Excluded urls.
Then we use the cache helper, tag that cache entry by the request url.
we use the remember method to store that cache entry. then we call the other handlers down the stack by doing $next($request). we check for exceptions. and then either return the exception or response.

Cache Invalidation

When new resources are created/updated, we have to clear the cache, so users can see new data. and to do this we will tweak our middleware code a bit. so in the part where we check the request method we add this:

if ('GET' !== $method) {
    $response = $next($request);

    if ($response->isSuccessful()) {
        $tag = $request->url();

        if ('PATCH' === $method || 'DELETE' === $method) {
            $tag = mb_substr($tag, 0, mb_strrpos($tag, '/'));
        }

        cache()->tags([$tag])->flush();
    }

    return $response;
}

ログイン後にコピー

So what this code is doing is flushing the cache for non-GET requests. Then for PATCH and Delete requests we are stripping the {id}. so for example if the request url is PATCH /users/1/posts/2 . We are stripping the last id leaving /users/1/posts. this way when we update a post, we clear the cache of all a users posts. so the user can see fresh data.

Now with this we are done with the CacheLayer implementation. Lets test it

Testing our Cache

Let's say we want to retrieve all a users posts, that has links, media and sort it by likes and recently created. the url for that kind of request according to the json:api spec will look like: /posts?filter[links]=1&filter[media]=1&sort=-created_at,-likes. on a posts table of 1.2 million records the response time is: ~800ms

How to build a caching layer for your Laravel API
and after adding our cache middleware we get a response time of 41ms

How to build a caching layer for your Laravel API

Great success!

Optimizations

Another optional step is to compress the json payload we store on redis. JSON is not the most memory-efficient format, so what we can do is use zlib compression to compress the json before storing and decompress before sending to the client.
the code for that will look like:

$response = cache()
            ->tags([$request->url()])
            ->remember(
                key: $cacheKey,
                ttl: config('cache.ttl'),
                callback: function () use ($next, $request, &$exception) {
                    $res = $next($request);

                    if (property_exists($res, 'exception') && null !== $res->exception) {
                        $exception = $res;

                        return null;
                    }

                    return gzcompress($res->getContent());
                }
            );

        return $exception ?? response(gzuncompress($response));

ログイン後にコピー

The full code for this looks like:

getMethod();

        if ('GET' !== $method) {
            $response = $next($request);

            if ($response->isSuccessful()) {
                $tag = $request->url();

                if ('PATCH' === $method || 'DELETE' === $method) {
                    $tag = mb_substr($tag, 0, mb_strrpos($tag, '/'));
                }

                cache()->tags([$tag])->flush();
            }

            return $response;
        }

        foreach (self::EXCLUDED_URLS as $pattern) {
            if (preg_match($pattern, $request->getRequestUri())) {
                return $next($request);
            }
        }

        $cacheKey = $this->getCacheKey($request);

        $exception = null;

        $response = cache()
            ->tags([$request->url()])
            ->remember(
                key: $cacheKey,
                ttl: config('cache.ttl'),
                callback: function () use ($next, $request, &$exception) {
                    $res = $next($request);

                    if (property_exists($res, 'exception') && null !== $res->exception) {
                        $exception = $res;

                        return null;
                    }

                    return gzcompress($res->getContent());
                }
            );

        return $exception ?? response(gzuncompress($response));
    }

    private function getCacheKey(Request $request): string
    {
        $routeParameters = ! empty($request->route()->parameters) ? $request->route()->parameters : [auth()->user()->id];
        $allParameters = array_merge($request->all(), $routeParameters);
        $this->recursiveSort($allParameters);

        return $request->url() . json_encode($allParameters);
    }

    private function recursiveSort(&$array): void
    {
        foreach ($array as &$value) {
            if (is_array($value)) {
                $this->recursiveSort($value);
            }
        }

        ksort($array);
    }
}

ログイン後にコピー