Craft Asset Rev（缓存破坏）插件指南

Craft Asset Rev（缓存破坏）插件指南

craft-asset-revA Craft CMS plugin to help with cache busting项目地址:https://gitcode.com/gh_mirrors/cr/craft-asset-rev

1. 项目介绍

Craft Asset Rev 是一个专为 Craft CMS 3 设计的Twig扩展，旨在通过附加查询字符串或替换资产文件名为其经过哈希处理的版本来帮助你实现资产的缓存破坏。此功能依赖于JSON格式的清单文件（manifest file），该文件通常由Grunt或Gulp的任务处理器自动生成。通过这种方式，当更新静态资源时，能够确保浏览器下载最新版本，从而优化页面加载速度并遵循推荐的最佳缓存策略。

2. 快速启动

要迅速地将Craft Asset Rev集成到你的Craft CMS项目中，请遵循以下步骤：

安装

通过Composer进行安装是最简便的方式：

composer require clubstudioltd/craft3-asset-rev

或者，你也可以手动下载插件，并将src目录的内容复制到你的Craft插件目录中的一个名为assetrev的新目录里。接下来，登录Craft控制台，从插件设置页激活Craft Asset Rev。

配置

默认配置应该满足大部分需求，但若需定制，如指定自定义清单文件路径，请在配置文件中进行相应设置。例如，在Craft的config目录下创建一个名为assetrev.php，内容可以是：

return [
    'manifestPath' => 'path/to/your/manifest.json', // 自定义清单文件路径
];

3. 应用案例和最佳实践

在模板文件中，使用rev()函数引用您的资产文件。这允许Craft自动处理文件名，以确保浏览器总是获取正确的版本。

<link href="{{ rev('css/main.css') }}" rel="stylesheet">
<script src="{{ rev('js/main.js') }}"></script>

最佳实践：

• Manifest 文件维护：确保你的构建流程中有生成或更新manifest文件的步骤。
• 环境适应性：利用环境变量动态配置路径，提高部署灵活性。
• 查询字符串回退：未找到清单文件时，插件会基于文件修改时间添加查询字符串作为缓存破坏的备用机制。

4. 典型生态项目

虽然直接关联的特定生态项目未在文档中明确提及，Craft Asset Rev通常与前端构建工具如Grunt、Gulp搭配使用，后者用于生成必要的哈希化的manifest文件。此外，在Craft CMS的生态系统中，这个插件经常被结合使用于需要高效管理静态资源的项目之中，尤其是那些重视性能优化的Web开发项目。

---

本指导涵盖了Craft Asset Rev的基本应用，使其成为缓存管理和性能提升的一个强大工具。通过遵循上述步骤，你可以在Craft CMS项目中轻松实现静态资源的有效版本控制与缓存破坏。

craft-asset-revA Craft CMS plugin to help with cache busting项目地址:https://gitcode.com/gh_mirrors/cr/craft-asset-rev