vite-plugin-pwa 静态资源缓存配置指南

静态资源缓存机制解析

在使用 vite-plugin-pwa 插件时，开发者经常会遇到静态资源缓存配置的问题。该插件基于 Workbox 实现，提供了两种主要的静态资源缓存配置方式，理解它们的区别对于正确配置 PWA 缓存策略至关重要。

includeAssets 与 globPatterns 的区别

许多开发者容易混淆 includeAssets 和 globPatterns 这两个配置项：

1. includeAssets：专门用于处理放置在项目 public 目录下的静态资源文件。这些文件不会被 Vite 处理，会直接复制到输出目录中。

2. globPatterns：用于匹配构建后 dist 目录中的所有资源文件，包括经过 Vite 处理的资源（如被哈希重命名的文件）。

常见问题场景

当开发者尝试缓存通过 CSS 引用的图片资源（如 background: url(...)）时，经常会遇到资源未被缓存的情况。这是因为：

• 这些资源通常位于 src/assets 目录而非 public 目录
• 经过 Vite 构建后，这些文件会被哈希处理并输出到 dist/assets 目录
• 使用 includeAssets 配置无法正确捕获这些文件

正确配置方案

对于大多数项目，推荐使用 globPatterns 来配置需要缓存的静态资源：

VitePWA({
  workbox: {
    globPatterns: ['**/*.{js,css,html,png,jpg,jpeg,webp,svg,ico}']
  }
})

这种配置方式可以自动捕获所有经过 Vite 处理的资源文件，包括：

• JavaScript 文件
• CSS 文件
• HTML 文件
• 各种图片格式（PNG、JPG、JPEG、WEBP、SVG）
• 网站图标（ICO）

最佳实践建议

1. 对于直接放在 public 目录下的静态资源，才需要使用 includeAssets 配置

2. 对于通过模块系统引入的资源（如 import 或 CSS 中的 url()），应使用 globPatterns

3. 构建后检查生成的 sw.js 文件，确认所有需要缓存的资源都被正确列出

4. 对于特殊文件类型，只需在 globPatterns 数组中添加相应的扩展名即可

通过正确理解和使用这些配置选项，开发者可以确保 PWA 应用能够可靠地缓存所有必要的静态资源，提供更好的离线体验。