README

Laravel Cachebuster

为应用程序资源的URL添加MD5哈希，当它们发生变化时，URL也会发生变化。CSS文件中的URL将自动转换；其他URL（例如通过 <script>、<link> 和 <img> 标签引用的URL）也可以通过blade模板中的辅助函数轻松转换。

还支持向资产URL添加CDN代理前缀，以便快速轻松地将透明CDN（如 Cloudfront）的性能和可扩展性添加到您的应用程序中。

安装

要获取与您的Laravel版本兼容的cachebuster版本，请按照以下安装说明进行操作

将以下内容添加到您的 composer.json

对于Laravel 5.x和Laravel 6

"themonkeys/cachebuster" :"2.*"

对于Laravel 4.x

"themonkeys/cachebuster" :"1.*"

注意：要继续使用Laravel 4的支持，请使用cachebuster 1.x版本，而不是dev-master*

运行 composer update
一旦安装了cachebuster，您需要将服务提供者注册到应用程序中。打开 app/config/app.php 并找到 providers 键。

'providers' => array(
    'Themonkeys\Cachebuster\CachebusterServiceProvider',
)

该包附带一个外观，它为URL编码提供了一种简洁的静态语法。您可以通过 app/config/app.php 文件的 aliases 键注册外观。

'aliases' => array(
    'Bust' => 'Themonkeys\Cachebuster\Cachebuster'
)

在Laravel重写规则之前将以下内容添加到您的 .htaccess 文件中之前

# ------------------------------------------------------------------------------
# | Remove cachebuster hash from request URLs if present                       |
# ------------------------------------------------------------------------------
<IfModule mod_rewrite.c>
    RewriteRule ^(.*)-[0-9a-f]{32}(\.(.*))$ $1$2 [DPI]
</IfModule>

注意：如果您正在使用NGINX并且不解析 .htaccess 文件，请参阅 @RTC1 的此 gist 中的等效NGINX重写规则。

并在Laravel重写规则之后将以下内容添加到您的 .htaccess 文件中之后

# ------------------------------------------------------------------------------
# | Allow Laravel to pre-process the css to add cachebusters to image urls     |
# ------------------------------------------------------------------------------
<IfModule mod_rewrite.c>
    RewriteCond %{REQUEST_URI} !^/index.php
    RewriteRule ^(.*\.css)$ index.php [L]
</IfModule>

最后，将其添加到您的 app/routes.php 文件中

Route::get('{path}', function($filename) {
  return Bust::css($filename);
})->where('path', '.*\.css$');
App::make('cachebuster.StripSessionCookiesFilter')->addPattern('|\.css$|');

注意：此通配符路由可能与 croppa 使用的通配符路由冲突，导致Croppa失效。如果这影响了您，请简单地更具体地指定CSS路由。例如，如果您的所有CSS文件都在一个 css/ 文件夹中
Route::get('/css/{path}', function($filename) {
    return Bust::css("/css/$filename");
})->where('path', '.*\.css$');
或者您甚至可以在过滤器中使用 Bust::css()。

配置

要配置此包，您可以使用以下命令，它将配置文件发布到 app/config/。

Laravel 5.x

php artisan vendor:publish

将发布到： /app/config/cachebuster.php。

设置本身在 /app/config/cachebuster.php 中有文档说明。您也可以在此处更改默认设置，以便在未检测到环境变量时使用。

注意： Laravel 5.x 将环境配置更改为使用点Env文件，您需要使用点Env范式“启用”cachebuster，以适应应用程序所需的环境。

例如，要启用cachebuster，打开您的 .env 文件，并添加以下行

CACHEBUSTER_ENABLED = true

Laravel 4.x

php artisan config:publish themonkeys/cachebuster

将发布到： app/config/packages/themonkeys/cachebuster。

或者您也可以在该文件夹中创建一个新文件，仅覆盖您需要的设置。设置本身在 app/config/packages/themonkeys/cachebuster/config.php 中有文档说明。

使用Laravel内置的开发服务器

您可能希望使用Laravel内置的开发服务器来运行您的应用程序，例如用于自动化测试。由于该服务器不支持必要的URL重写，最简单的解决方案是禁用该环境的缓存破坏。通过创建文件 app/config/packages/themonkeys/cachebuster/testing/config.php 来实现此操作（将 testing 替换为开发服务器所使用的环境）并包含以下内容

<?php
return array(
    'enabled' => false,
);

如果您仍然希望在开发服务器下启用缓存破坏，可以使用[这个Gist]中的代码（https://gist.github.com/felthy/3fc1675a6a89db891396）。感谢RTC1提供这个Gist所基于的原始代码。

用法

在您的blade模板中指定资产路径的地方，使用 Bust::url() 来转换路径。例如，一个脚本标签如下...

<script src="{{ Bust::url('/js/main.js') }}"></script>

...对于您的用户来说将看起来像这样

<script src="/js/main-a09b64644df96f807a0db134d27912bf.js"></script>

或者如果您已经配置了CDN，它可能看起来像

<script src="//a1bc23de4fgh5i.cloudfront.net/js/main-a09b64644df96f807a0db134d27912bf.js"></script>

对于 <img> 标签也是如此

<img src="{{ Bust::url('/img/spacer.gif') }}" alt="">

对于您的用户来说将看起来像这样

<img src="/img/spacer-5e416a75e3af86e42b1a3bc8efc33ebc.gif" alt="">

最后一部分是你的CSS

<link rel="stylesheet" href="{{ Bust::url('/css/main.css') }}">

看起来是这样的

<link rel="stylesheet" href="/css/main-f75168d5f53c7a09d9a08840d7b5a5ec.css">

这里发生了一些真正的魔法——您CSS文件中的所有URL（图片、字体等）都会自动通过缓存破坏，因此它们的文件名现在也有哈希值。在浏览器中打开CSS文件看看吧！

绝对URL

有时您可能需要指定一个绝对URL，例如在OpenGraph元标签中。这很简单

<meta property="og:image" content="{{ Bust::url('/img/share-thumbnail.jpg', true) }}" />

可能看起来像这样

<meta property="og:image" content="http://yourhost/img/share-thumbnail-2a7d7b5a4401ef3176565dffcd59b282.png" />

这使用的是Laravel内置的URL生成器，所以URL将根据您的环境生成。

贡献

没有正式的风格指南，请务必维护现有的编码风格。

许可

MIT许可（c）The Monkeys

ejunker / laravel-cachebuster

维护者

详细信息