詳解如何使用ETag和條件標頭進行緩存

Laravel API 效能最佳化：使用 ETag 和條件標頭進行快取

                                                       

當寫一個前後端分離的應用程式時，你必須得開始考慮前端客戶端會給API提交什麼樣的請求，從後端再次獲取數據，即使你只想要驗證前端緩存是否能對新增的數據即時更新。根據以上的需求，你可以使用 ETag 頭 和 conditional requests。

在這篇文章中，我會簡單的概括一下ETag, If-None-Match 和 If-Match 頭是做什麼的，然後再看看我是如何將這些應用到我們的package中的，這個軟體包可以快速的將它實施到您的應用程式中。

是什麼

讓我們從這一切的核心內容開始，那就是 ETag 頭。此頭文件是表示其所在的確切狀態下的回應主體的值。在許多情況下 ETag 的值將是內容的 hash 值，因為這是最容易產生和保證回應資料唯一性識別碼的方法。

為了確保 ETag 頭可用，我們必須使用條件請求。我們需要設定的第一個條件是 If-None-Match 頭，這是一個用於 GET 的請求頭。在後端接收到這個頭之後，需要將它和目前的內容進行比較。如果值相符的話，只會傳回 304 狀態碼，和取得實體資源比較起來，回應結果的資料本身是很小的。這一切實施起來是非常簡單的：如果你的第一個獲取資源的 GET 請求返回了一個 ETag 數據，你的瀏覽器會自動的為接下來的資源的請求配置 If-None-Match 頭。

這意味著，如果您的後端簡單實現了etag 和if-none-match，則可以減少從您的API傳輸到前端的數據量。

第二個請求條件使用的是 if-match 頭。這被用來阻止 mid-air collisions 。通俗的說，如果我們想要在後端更新數據，但是我們的前端數據已經過時，後端的更新應該被終止，而且前端也應該有提醒。這和 if-none-match 的工作方式很類似。在取得包含 ETag 值的資源之後，你可以提交一個 PATCH 請求並且設定一個和你先前接收到的 ETag 值相等的 # If-Match 值。然後，後端將檢查服務端目前可用的資源的 etag 值是否與您發送的資源相符。如果匹配，將允許您的更新。如果沒有匹配，將返回412狀態碼，讓前端知道條件不匹配。

如何使用

如果你想要在laravel 專案中使用這個條件請求插件包的話，你可以使用以下命令來安裝:

$ composer require werk365/etagconditionals

然後在你的路由中加入etag 中間件之​​後就可以使用了。如果你想研究中間件的工作原理，或者想要不透過我們的插件包來實現這個功能的話，請接著往下讀！

SetEtag 中間件

正如您可能已經猜到的那樣，我們可以透過中間件來很簡單的實作這一功能。 Laravel 實際上已經為我們提供了一個 SetCacheHeaders 中間件來設定 ETag 頭， 但是它不支援 HEAD 請求。 SetEtag 中間件的內容看起來是這樣的：

    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;
    }

我們首先要做的事情是取得請求的方法，以防我們想要修改它。然後，當我們在處理 HEAD 請求的時候，我們把它修改為 GET 請求，以確保請求的內容已載入且可以被加密。在此之後，我們跳到已經使用 md5() 方法加密後的回應主體內容。在回傳回應之前，我們會將加密後的 hash 值作為 ETag 頭，並且將原始請求方法設定回原處。

IfNoneMatch 中間件

這是另一個相對簡單的方法。讓我們先來看看程式碼：

    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

以上是詳解如何使用ETag和條件標頭進行緩存的詳細內容。更多資訊請關注PHP中文網其他相關文章！