Explication détaillée de la façon d'utiliser ETag et des en-têtes conditionnels pour la mise en cache

Optimisation des performances de l'API Laravel : mise en cache avec ETags et en-têtes conditionnels

Lorsque vous écrivez une application avec un front-end et un back-end séparés, vous devez commencer à réfléchir au type de requêtes que le client front-end soumettra à l'API pour récupérer à nouveau les données du back-end, même si vous venez de souhaitez vérifier si le cache frontal peut gérer les données ajoutées mises à jour en temps réel. Sur la base des exigences ci-dessus, vous pouvez utiliser des en-têtes ETag et des requêtes conditionnelles.

Dans cet article de blog, je décrirai brièvement ce que font les en-têtes ETag, If-None-Match et If-Match, puis je verrai comment je les applique à notre package, qui peut rapidement être implémenté dans votre application. Qu'est-ce que

est

Commençons par la viande et les pommes de terre, et c'est l'en-tête ETag. Cet en-tête est une valeur qui représente le corps de la réponse dans l'état exact dans lequel il se trouve. Dans de nombreux cas, la valeur de ETag sera la valeur hash du contenu, car c'est le moyen le plus simple de générer et de garantir un identifiant unique pour les données de réponse.

Pour garantir que l'en-tête ETag est disponible, nous devons utiliser des requêtes conditionnelles. La première condition que nous devons définir est l’en-tête If-None-Match, qui est un en-tête de requête pour GET. Une fois que le backend a reçu cet en-tête, il doit être comparé au contenu actuel. Si les valeurs correspondent, seul le code d'état 304 sera renvoyé. Par rapport à l'obtention de la ressource d'entité, les données de résultat de la réponse elles-mêmes sont très petites. Tout cela est très simple à mettre en œuvre : si votre première GET requête de ressource renvoie une donnée ETag, votre navigateur configurera automatiquement l'en-tête If-None-Match pour les requêtes ultérieures de la ressource.

Cela signifie que si votre backend implémente simplement etag et if-none-match, vous pouvez réduire la quantité de données transférées de votre API vers le frontend.

La deuxième condition de requête utilise l'en-tête if-match. Ceci est utilisé pour éviter les collisions en vol. En termes simples, si nous voulons mettre à jour les données dans le backend, mais que nos données frontend sont obsolètes, la mise à jour du backend doit être terminée et il devrait y avoir un rappel sur le frontend. Ceci est similaire à la façon dont fonctionne if-none-match. Après avoir récupéré une ressource contenant une valeur ETag, vous pouvez soumettre une demande PATCH et définir une valeur ETag égale à la valeur If-Match que vous avez reçue précédemment. Le backend vérifiera ensuite si la valeur etag de la ressource actuellement disponible sur le serveur correspond à la ressource que vous avez envoyée. S'il y a une correspondance, votre mise à jour sera autorisée. S'il n'y a pas de correspondance, un code d'état 412 sera renvoyé pour informer le front-end que les conditions ne correspondent pas.

Comment utiliser

Si vous souhaitez utiliser ce package de plug-in de requête conditionnelle dans votre projet laravel, vous pouvez utiliser la commande suivante pour l'installer :

$ composer require werk365/etagconditionals

Ajoutez ensuite le middleware etag à votre itinéraire et vous pourrez l'utiliser . Si vous souhaitez étudier le fonctionnement du middleware, ou si vous souhaitez implémenter cette fonction sans utiliser notre package de plug-ins, lisez la suite !

SetEtag Middleware

Comme vous l'avez peut-être deviné, nous pouvons facilement implémenter cette fonction via un middleware. Laravel nous fournit en fait déjà un middleware SetCacheHeaders pour définir l'en-tête ETag, mais il ne prend pas en charge les requêtes HEAD. SetEtag Le contenu du middleware ressemble à ceci :

    public function handle(Request $request, Closure $next)
    {
        // Handle request
        $method = $request->getMethod();

        // Support using HEAD method for checking If-None-Match
        if ($request->isMethod('HEAD')) {
            $request->setMethod('GET');
        }

        //Handle response
        $response = $next($request);

        // Setting etag
        $etag = md5($response->getContent());
        $response->setEtag($etag);

        $request->setMethod($method);

        return $response;
    }

La première chose que nous devons faire est d'obtenir la méthode de requête au cas où nous voudrions la modifier. Ensuite, lorsque nous traitons la requête HEAD, nous la modifions en requête GET pour nous assurer que le contenu demandé a été chargé et peut être crypté. Après cela, nous passons au contenu du corps de la réponse qui a été chiffré à l'aide de la méthode md5(). Avant de renvoyer la réponse, nous transmettons la valeur hash chiffrée comme en-tête ETag et rétablissons la méthode de requête d'origine.

IfNoneMatch Middleware

Il s'agit d'une autre méthode relativement simple. Jetons d'abord un coup d'oeil au code :

    public function handle(Request $request, Closure $next)
    {
        // Handle request
        $method = $request->getMethod();

        // Support using HEAD method for checking If-None-Match
        if ($request->isMethod('HEAD')) {
            $request->setMethod('GET');
        }

        //Handle response
        $response = $next($request);

        $etag = '"'.md5($response->getContent()).'"';
        $noneMatch = $request->getETags();

        if (in_array($etag, $noneMatch)) {
            $response->setNotModified();
        }

        $request->setMethod($method);

        return $response;
    }

这个开头与  SetEtag 中间件相似，将确保我们可以再次处理 HEAD 请求，并根据响应内容生成 hash值。注意这种情况下我们需要将hash值用双引号包裹。双引号包裹 ETag头，然后在setEtag中间件中 setEtag()方法自动包裹hash。有了hash值后，我们可以轻松的与 If-None-Match头进行比较。由于该头可以自动加载无限个hash，并且 getETags()方法会将它们以数组形式返回，所以我们可以核对新生成的值是否存在于数组中。如果确实有匹配，我们可以在响应中使用 setNotModified()设置 304 的状态码。

IfMatch 中间件

处理 If-Match 将稍微复杂一些。这个问题归结于：我们需要找到一种方法，用来获取应该更新的当前版本的内容。这可以用多种方式实现。

• 你可以使用 HTTP 客户端对相同资源从外部发起 GET 请求
• 你可以查看当前请求将执行的操作， 而不是调用与之等价的 GET 请求（ 例如，调用控制器上的 show() 方法）
• 或者你可以通过内部发起一个新的 GET 请求。

在构建这个中间件时，我开始尝试使用第二个选项。出于某种原因，这对我来说似乎是最好的选择。我成功地创建了一个完全可以工作的版本，但我对结果并不满意。为了让它工作，我需要做一些假设，预设一些限制，并做了太多的工作，而我只需要创建一个新的请求就可以了。

当我们要发起一个新的请求来获取当前版本资源的时候，代码是下面这样的：

    public function handle(Request $request, Closure $next)
    {
        // 只有请求方式是 PATCH 并且已经设置了 If-Match 头
        if (! ($request->isMethod('PATCH') && $request->hasHeader('If-Match'))) {
            return $next($request);
        }

        // 对同一个点创建新的 GET 请求,
        // 复制和添加请求头，让中间件能忽略本次请求
        $getRequest = Request::create($request->getRequestUri(), 'GET');
        $getRequest->headers = $request->headers;
        $getRequest->headers->set('X-From-Middleware', 'IfMatch');
        $getResponse = app()->handle($getRequest);

        // Get content from response object and get hashes from content and etag
        $getContent = $getResponse->getContent();
        $getEtag = '"'.md5($getContent).'"';
        $ifMatch = $request->header('If-Match');

        // 比较当前和请求携带的 hash 值
        if ($getEtag !== $ifMatch) {
            return response(null, 412);
        }

        return $next($request);

所有这些中间件都将在请求生命周期开始时运行。首先，我们将过滤掉任何非 PATCH 请求或请求头中没有 If Match 的请求。之后，我们将向同一个端点发出一个新的 GET 请求，并从原来的请求中复制请求头，以便新请求可以通过身份验证中间件和其他约束。

使用这个新请求的响应，我们将再次生成一个哈希，以便与发送的哈希进行比较。如果哈希匹配，请求将被中间件允许通过。如果不匹配，将返回状态代码为 412 的请求响应。

通过使用这三个中间件，你可以在你的 Laravel 应用程序中轻松处理 ETag 和条件请求。

软件包：https://github.com/365Werk/etagconditionals

原文地址：https://hergen.nl/caching-your-laravel-api-with-etag-and-conditional-requests

译文地址：https://learnku.com/laravel/t/55539

Ce qui précède est le contenu détaillé de. pour plus d'informations, suivez d'autres articles connexes sur le site Web de PHP en chinois!