首页/文章/前端

Vite前端部署：版本更新，即刻知晓

2024-09-20

1090 字约 4 分钟

...

学习

最近测试和用户频繁反馈，说经常会出现页面点不动了。然后每次都回复，刚发完版，刷新下就好了。但时间长了，就被怀疑是能力问题，因为其他项目为什么不这样呢？

先做一些准备工作，复盘一下当时的场景：

运行 pnpm create vite vue3-vite-router --template vue 在本地快速新建一个项目

进入项目目录中，运行pnpm i 安装依赖，安装成功后启动项目pnpm dev, 启动成功后运行 pnpm build进行打包。打包完成后根目录下会多出一个dist目录。运行 pnpm preview预览构建后的项目。

页面可以正常打开：

页面窗口保持不变（不进行刷新等其他操作）。在AboutView.vue文件中随便修改一点修改。再次运行打包pnpm build和预览 pnpm preview。在刚才的页面中点击 About 进行导航切换后，About页面对应的js文件请求失败了。

经过排查，是发版后js的文件名hash变了，原页面对应的html文件引用的js hash名称还是上一版本的，由于做了懒加载，所以点击跳转新页面时，对应的js文件不存在导致。懒加载的优化变成了事故，我冤枉啊~~~（我发誓：以后能跑起来绝对不优化）

为了证明自己的开发能力（掉发能力），针对vite项目调研了两种方案（纯前端方案，绝不麻烦后端）：

翻看vite官方文档上发现了一个简单的办法：当vite加载动态导入失败时，会触发 vite:preloadError 事件。可以使用这个事件进行处理。

在main.js中增加以下代码：

window.addEventListener('vite:preloadError', (event) => {
  console.log('检测到有新版本，5秒后即将刷新...');
  setTimeout(() => {
    window.location.reload() 
    console.log('页面已更新为最新版本...');
  }, 5000)
})

先执行 pnpm build和pnpm preview，刷新页面。然后随意修改AboutView.vue的代码，重新执行 pnpm build和pnpm preview，点击About后，js请求异常，会触发vite:preloadError事件，然后执行回调中的刷新逻辑。

总结：这个方法比较简单，但是只能应用在路由切换的场景中。

还有一种场景是无路由切换时，代码未及时进行更新。对我们的项目来说，都是在晚上发布，如果有版本更新，运维同学会在群里及时同步测试和产品同学。如果需要解决，需要进行轮询操作。具体请参考：2种纯前端检测版本更新提示

目测最佳的时间方案为：

vite打包构建时生成版本号json文件，并将json文件保存到构建好的静态资源目录中。

路由变化时执行：对比json文件中的版本号与缓存中是否一致。若一致，则进行弹窗提示用户进行刷新。

相关代码参考了这篇文章：vite前端版本升级，刷新页面

新建一个vite插件，完成将发布版本的时间戳写入文件。代码如下：

import path from "path";
import fs from "fs";


const writeVersion = async (versionFile, content) => {
  fs.writeFile(versionFile, content, (err) => {
    if (err) throw err;
  });
};

export default (options) => {
  
  let configPath;
  return {
    name: "refreshVersion",
    configResolved(resolvedConfig) {
      
      configPath = resolvedConfig.publicDir;
    },
    async buildStart() {
      
      const file = configPath + path.sep + "version.json";
      
      const content = JSON.stringify({ version: options.version });
      if (fs.existsSync(configPath)) {
        
        writeVersion(file, content);
      } else {
        
        fs.mkdir(configPath, (err) => {
          if (err) throw err;
          writeVersion(file, content);
        });
      }
    },
  };
};

vite配置文件中使用该插件，并在全局缓存版本时间戳，便于后续比对使用。代码如下：

import { fileURLToPath, URL } from 'node:url'

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import refreshPlugin from './src/plugins/refreshPlugin.js'
const now = new Date().getTime(); 



export default defineConfig({
  plugins: [
    vue(),
    
     refreshPlugin({
      version: now
    })
  ],
  resolve: {
    alias: {
      '@': fileURLToPath(new URL('./src', import.meta.url))
    }
  },
  
  define: {
    __APP_VERSION__: now,
  }
})

router/index.js




router.beforeEach(async (to, from, next) => {
  await versionCheck() 
  next()
});


const versionCheck = async () => {
  if (process.env.NODE_ENV === 'development') return
  const response = await axios.get('version.json')
  if (__APP_VERSION__ !== response.data.version) {
      
      console.log('有新版本，5秒后自动刷新页面');
      setTimeout(() => {
          window.location.reload()
      }, 5000)
  }
}