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

這篇文章主要介紹“如何使用ETag和條件標頭進行緩存”，在日常操作中，相信很多人在如何使用ETag和條件標頭進行緩存問題上存在疑惑，小編查閱了各式資料，整理出簡單好用的操作方法，希望對大家解答”如何使用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和條件標頭進行緩存”的學習就結束了，希望能夠解決大家的疑惑。理論與實踐的搭配能更好的幫助大家學習，快去試試吧！若想繼續學習更多相關知識，請繼續關注億速云網站，小編會繼續努力為大家帶來更多實用的文章！