VitePWA插件中解决缓存清单冲突问题

问题背景

在使用VitePWA插件（vite-plugin-pwa）时，开发者可能会遇到一个名为"add-to-cache-list-conflicting-entries"的错误。这个错误通常发生在升级插件版本后，表现为控制台抛出缓存条目冲突的警告。

错误现象

典型的错误信息会显示两个看似相同但实际上存在差异的URL路径被同时尝试添加到缓存列表中。例如：

https://example.com/assets/icon.png
https://example.com/assets/icon.png?__WB_REVISION__=xxxxxx

这种冲突会导致PWA服务工作不正常，影响应用的离线功能。

问题原因

这个问题的根源在于VitePWA插件的默认行为会同时处理两种缓存策略：

1. 通过globPatterns配置的全局文件匹配模式
2. 通过manifest配置中定义的图标文件

当这两种配置同时存在且指向相同文件时，插件会尝试将同一文件以不同形式（带版本哈希和不带版本哈希）添加到缓存清单中，从而产生冲突。

解决方案

解决这个问题的方法很简单：在VitePWA配置中添加includeManifestIcons: false选项。这个配置项告诉插件不要自动将manifest中定义的图标文件包含在预缓存列表中。

VitePWA({
  registerType: 'autoUpdate',
  injectRegister: 'auto',
  includeManifestIcons: false, // 添加这一行
  workbox: {
    globPatterns: ['**/*.{js,css,html,ico,png,svg}'],
    navigateFallbackDenylist: [/^\/api/, /^\/files/],
  },
  manifest: {
    // manifest配置
  }
})

最佳实践

1. 明确缓存策略：要么使用globPatterns全局匹配，要么让插件自动处理manifest图标，避免两者混用
2. 版本控制：理解Workbox的版本控制机制，__WB_REVISION__参数是用于缓存更新的重要标识
3. 文件组织：将PWA相关资源（如图标）放在统一目录下，便于管理
4. 测试验证：在开发过程中定期检查Service Worker的缓存行为

总结

VitePWA插件提供了强大的PWA支持，但在配置时需要理解其内部工作机制。当遇到缓存冲突问题时，通过includeManifestIcons配置可以有效地解决问题，同时保持应用的离线功能正常工作。开发者应根据实际需求选择合适的缓存策略，确保PWA应用的稳定性和性能。