VitePWA插件中injectManifest策略下self.__WB_MANIFEST为空数组的问题解析

问题背景

在使用VitePWA插件时，开发者经常会遇到服务工作者(Service Worker)配置的问题。特别是当采用injectManifest策略时，有时会发现self.__WB_MANIFEST被注入为一个空数组，导致预缓存功能无法正常工作。

核心问题分析

这个问题通常出现在开发环境中，主要原因有以下几点：

1. 开发环境默认行为：VitePWA插件在开发服务器环境下会默认禁用预缓存功能，这是为了避免开发过程中频繁的缓存更新影响开发体验。

2. 配置位置错误：当使用injectManifest策略时，globPatterns应该直接放在插件的主配置中，而不是放在workbox对象内。这是因为injectManifest策略会接管workbox的配置方式。

3. 插件顺序问题：压缩插件(viteCompression)应该在PWA插件之前注册，确保资源被正确处理。

解决方案

要解决这个问题，可以采取以下配置方式：

export default defineConfig({
  plugins: [
    viteCompression(), // 压缩插件在前
    VitePWA({
      strategies: 'injectManifest',
      srcDir: 'src',
      filename: 'service-worker.js',
      injectRegister: false,
      // 主配置中直接设置globPatterns
      globPatterns: ['**/*.{js,css,html}'],
      devOptions: {
        enabled: true,
        type: 'module',
      },
    }),
  ],
});

深入理解

1. 开发与生产环境差异：

   • 开发环境：默认禁用预缓存，self.__WB_MANIFEST为空
   • 生产环境：会正常注入资源清单

2. injectManifest策略特点：

   • 需要手动编写service-worker.js
   • 提供更精细的控制能力
   • 需要正确配置才能生成资源清单

3. 最佳实践：

   • 始终在生产环境测试PWA功能
   • 开发环境可以暂时忽略空清单问题
   • 确保文件路径配置正确

总结

VitePWA插件在使用injectManifest策略时，需要特别注意配置方式和环境差异。通过正确的配置顺序和参数设置，可以确保服务工作者在生产和开发环境中都能按预期工作。理解这些细节有助于开发者更好地利用VitePWA插件构建可靠的渐进式Web应用。