README

此包允许您轻松将响应缓存为磁盘上的静态文件，以实现闪电般的页面加载。

简介
安装
使用方法
许可协议

简介

尽管静态网站生成器（如 Jekyll 和 Jigsaw）在当今非常受欢迎，但动态PHP网站仍然为主要是静态的网站提供了很多价值。一个合适的PHP网站可以轻松地在需要的地方添加动态功能，而且也意味着在推送网站更新时不需要进行构建步骤。

话虽如此，对于网站上的真正静态页面，真的没有必要启动一个完整的PHP应用来仅仅服务一个静态页面。从磁盘上服务一个简单的HTML页面要快得多，并且对服务器的压力更小。

解决方案？全页缓存。

使用本包中包含的中间件，您可以有选择地将特定请求的响应缓存到磁盘上。对同一页面的后续调用将直接作为静态HTML页面提供服务！

安装

注意：Page Cache当前版本需要PHP 8.2+和Laravel 11+。

如果您正在使用Laravel v5-v10，请使用 Page Cache v1.0.9。

使用Composer安装page-cache包

$ composer require silber/page-cache

中间件

打开app/Http/Kernel.php并将新项目添加到web中间件组

protected $middlewareGroups = [
    'web' => [
        \Silber\PageCache\Middleware\CacheResponse::class,
        /* ... keep the existing middleware here */
    ],
];

此中间件足够智能，只缓存具有200 HTTP状态代码的响应，并且只针对GET请求。

如果您只想选择性地缓存网站上的特定请求，则应在middlewareAliases数组中添加新映射

protected $middlewareAliases = [
    'page-cache' => \Silber\PageCache\Middleware\CacheResponse::class,
    /* ... keep the existing mappings here */
];

注册后，您可以在单个路由上使用此中间件。

URL重写

为了在缓存后直接提供静态文件，您需要正确配置您的Web服务器以检查这些静态文件。

对于nginx

更新您的location块的try_files指令，包括对page-cache目录的检查

location = / {
    try_files /page-cache/pc__index__pc.html /index.php?$query_string;
}

location / {
    try_files $uri $uri/ /page-cache/$uri.html /page-cache/$uri.json /page-cache/$uri.xml /index.php?$query_string;
}

对于apache

打开public/.htaccess并在标签为Handle Front Controller的块之前添加以下内容

# Serve Cached Page If Available...
RewriteCond %{REQUEST_URI} ^/?$
RewriteCond %{DOCUMENT_ROOT}/page-cache/pc__index__pc.html -f
RewriteRule .? page-cache/pc__index__pc.html [L]
RewriteCond %{DOCUMENT_ROOT}/page-cache%{REQUEST_URI}.html -f
RewriteRule . page-cache%{REQUEST_URI}.html [L]
RewriteCond %{DOCUMENT_ROOT}/page-cache%{REQUEST_URI}.json -f
RewriteRule . page-cache%{REQUEST_URI}.json [L]
RewriteCond %{DOCUMENT_ROOT}/page-cache%{REQUEST_URI}.xml -f
RewriteRule . page-cache%{REQUEST_URI}.xml [L]

忽略缓存文件

为了确保您不会将本地缓存的文件提交到您的git仓库，请将此行添加到您的.gitignore文件中

/public/page-cache

使用方法

使用中间件

注意：如果您已将中间件添加到全局web组，则所有成功的GET请求将自动被缓存。不需要在路由上再次直接放置中间件。

如果您将其注册到middlewareAliases中，则应使用中间件在您希望缓存的任何路由上。

要缓存特定请求的响应，请使用page-cache中间件

Route::middleware('page-cache')->get('posts/{slug}', 'PostController@show');

现在每个帖子都将缓存在public/page-cache目录下的文件中，与请求的URL结构紧密匹配。对该帖子的所有后续请求都将直接从磁盘提供，甚至永远不会触及您的应用！

清除缓存

由于响应被缓存为静态文件到磁盘上，因此您应用中这些页面的任何更新都不会反映在您的网站上。要更新网站上的页面，您应使用以下命令清除缓存

php artisan page-cache:clear

作为一个经验法则，将此操作添加到您的部署脚本中是个好习惯。这样，每当您向网站推送更新时，页面缓存将自动清除。

如果您正在使用Forge的快速部署功能，您应将此行添加到部署脚本的末尾。这样可以确保在您向网站推送更新时清除缓存。

您可以选择传递一个URL别名给命令，仅删除特定页面的缓存

php artisan page-cache:clear {slug}

要清除给定路径下的所有内容，请使用--recursive标志

php artisan page-cache:clear {slug} --recursive

例如，假设您在/categories下有一个分类资源，以下为缓存的页面

/categories/1
/categories/2
/categories/5

要清除所有分类的缓存，请使用带有categories路径的--recursive

php artisan page-cache:clear categories --recursive

自定义要缓存的内容

默认情况下，所有带有200 HTTP响应代码的GET请求都会被缓存。如果您想更改这一点，请创建自己的中间件，该中间件扩展了包的基本中间件，并使用您自己的逻辑覆盖shouldCache方法。

运行make:middleware Artisan命令以创建中间件文件
```
php artisan make:middleware CacheResponse
```

替换app/Http/Middleware/CacheResponse.php文件的内容为以下内容

<?php

namespace App\Http\Middleware;

use Symfony\Component\HttpFoundation\Request;
use Symfony\Component\HttpFoundation\Response;
use Silber\PageCache\Middleware\CacheResponse as BaseCacheResponse;

class CacheResponse extends BaseCacheResponse
{
    protected function shouldCache(Request $request, Response $response)
    {
        // In this example, we don't ever want to cache pages if the
        // URL contains a query string. So we first check for it,
        // then defer back up to the parent's default checks.
        if ($request->getQueryString()) {
            return false;
        }

        return parent::shouldCache($request, $response);
    }
}

最后，更新您的app/Http/Kernel.php文件中的中间件引用，使其指向您自己的中间件。

许可协议

页面缓存包是开源软件，许可协议为MIT许可。

silber / page-cache

维护者

详情