• 技术文章 >php框架 >Laravel

    详解如何使用ETag和条件标头进行缓存

    藏色散人藏色散人2021-07-16 08:59:39转载150
    Laravel API 性能优化:使用 ETag 和条件标头进行缓存

    当写一个前后端分离的应用时,你必须得开始考虑前端客户端会给API提交什么样的请求,从后端再次获取数据,即使你只想要验证前端缓存是否能对添加的数据实时更新。根据以上的需求,你可以使用 ETag 头 和 conditional requests。

    在这篇博文中,我会简单的概括一下 ETag, If-None-MatchIf-Match 头是做什么的,然后再看看我是如何将这些应用到我们的package中的,这个软件包可以快速的将它实施到您的应用程序中。

    是什么

    让我们从这一切的核心内容开始,那就是 ETag 头。该头文件是表示其所在的确切状态下的响应主体的值。在很多情况下 ETag 的值将是内容的 hash 值,因为这是最容易生成和保证响应数据唯一性标识符的方法。

    为了保证 ETag 头可用,我们必须使用条件请求。我们需要设置的第一个条件是 If-None-Match 头,这是一个用于 GET 的请求头。在后端接收到这个头之后,需要将它和当前的内容进行比较。如果值匹配的话,将只返回 304 状态码,和获取实体资源比较起来,响应结果的数据本身是很小的。这一切实施起来是非常简单的:如果你的第一个获取资源的 GET 请求返回了一个 ETag 数据,你的浏览器会自动的为接下来的资源的请求配置 If-None-Match 头。

    这意味着,如果您的后端简单实现了 etagif-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 将稍微复杂一些。这个问题归结于:我们需要找到一种方法,用来获取应该更新的当前版本的内容。这可以用多种方式实现。

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

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

        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中文网其它相关文章!

    声明:本文转载于:learnku,如有侵犯,请联系admin@php.cn删除
    专题推荐:laravel
    上一篇:非常有用的Laravel optional辅助函数! 下一篇:强烈推荐一个扩展包:Laravel Log Enhancer
    VIP会员

    相关文章推荐

    • 一文介绍Laravel Ignition的一切• Laravel如何使用Observer实现日志管理模块• 分享一个好用的Laravel 扩展(laravel-hprose)• 非常有用的Laravel optional辅助函数!

    全部评论我要评论

  • 取消发布评论发送
  • 1/1

    PHP中文网