水煮白菜王

前端实现版本更新自动检测✅

作者简介：水煮白菜王，一位资深前端劝退师
文章专栏：前端专栏，记录一下平时在博客写作中，总结出的一些开发技巧和知识归纳总结✍。
感谢支持

一、背景

在现代Web应用中，部署前端版本更新后及时提醒用户进行页面刷新是必要的。由于单页面应用（SPA）的路由特性和浏览器缓存机制，用户浏览器可能不会自动加载最新的代码资源。这会导致用户未能体验到最新的功能变化，甚至遇Bug或不一致的行为。通过实现一种自动检测机制来提醒用户有新的版本，并引导其刷新页面，可以有效地解决这个问题，保证所有用户都能及时使用最新版应用的功能。

二、实现原理

2.1 逻辑

是

否

是

否

变化

是

否

未变化

应用启动

生产环境?

启动定时器

结束流程

等待60秒

获取当前脚本哈希

首次运行?

保存初始哈希

哈希变化?

停止定时器

显示更新提示

用户确认?

刷新页面

记录取消操作

通过对比构建打包出文件的哈希值变化实现版本检测：

定时轮询：每分钟检查静态资源变化
哈希对比：通过解析HTML中script标签指纹判断更新
强制刷新：检测到更新后提示用户刷新页面

// 核心对比逻辑
const isChanged = (oldSet, newSet) => {
  return oldSet.size !== newSet.size || 
         ![...oldSet].every(hash => newSet.has(hash))
}

2.2 一些好处

通用性强：适用于任意前端框架
无侵入式检测：不依赖构建工具配置
用户可控：提示框让用户选择刷新时机
精准检测：通过对比script标签内容哈希值
低资源消耗：每分钟检测一次，单次请求性能消耗低

三、具体实现

3.1 工程化封装

// useVersionHash.js 核心实现
export default function useVersionHash() {
  // 状态管理
  const timerUpdate = ref(null)
  let scriptHashes = new Set()

  // 生命周期
  onMounted(() => startTimer())
  onBeforeUnmount(() => stopTimer())

  // 业务方法
  const fetchScriptHashes = async () => { /*...*/ }
  const compareScriptHashes = async () => { /*...*/ }
  
  return { compareScriptHashes }
}

3.2 关键方法解析

脚本哈希获取：

const fetchScriptHashes = async () => {
  const html = await fetch('/').then(res => res.text())
  const scriptRegex = /]*)?>(.*?)<\/script\s*>/gi
  return new Set(html?.match(scriptRegex) || [])
}

对比逻辑：

if (scriptHashes.size === 0) {
  // 初始化基准值
  scriptHashes = newScriptHashes  
} else if (
  scriptHashes.size !== newScriptHashes.size ||
  ![...scriptHashes].every(hash => newScriptHashes.has(hash))
) {
  // 触发更新流程
  stopTimer()
  showUpdateDialog()
}

四、全部代码

4.1 vue3

1、use-version-update.js具体逻辑

// @/utils/use-version-update.js
import { ref, onMounted, onBeforeUnmount } from 'vue'
import { ElMessageBox } from 'element-plus'

let scriptHashes = new Set()
const timerUpdate = ref(null)

export default function useVersionHash() {
  const isProduction = import.meta.env.MODE === 'production'

  const fetchScriptHashes = async () => {
    try {
      const html = await fetch('/').then((res) => res.text())
      const scriptRegex = /]*)?>(.*?)<\/script\s*>/gi
      return new Set(html?.match(scriptRegex) || [])
    } catch (error) {
      console.error('获取脚本哈希失败:', error)
      return new Set()
    }
  }

  const compareScriptHashes = async () => {
    try {
      const newScriptHashes = await fetchScriptHashes()

      if (scriptHashes.size === 0) {
        scriptHashes = newScriptHashes
      } else if (
        scriptHashes.size !== newScriptHashes.size ||
        ![...scriptHashes].every(hash => newScriptHashes.has(hash))
      ) {
        stopTimer()
        updateNotice()
      }
    } catch (error) {
      console.error('版本检查失败:', error)
    }
  }

  const updateNotice = () => {
    ElMessageBox.confirm(
      '检测到新版本，建议立即更新以确保平台正常使用',
      '更新提示',
      {
        confirmButtonText: '确定',
        cancelButtonText: '取消',
        type: 'warning'
      }
    ).then(() => window.location.reload())
  }

  const startTimer = () => {
    if (!isProduction) return
    timerUpdate.value = setInterval(compareScriptHashes, 60000)
  }

  const stopTimer = () => {
    timerUpdate.value && clearInterval(timerUpdate.value)
  }

  onMounted(startTimer)
  onBeforeUnmount(stopTimer)

  return { compareScriptHashes, updateNotice }
}

2、引入use-version-update.js

// App.vue
import versionUpdatefrom '@/utils/use-version-update.js'
export default {
  setup() {
    const { updateNotice } = versionUpdate()
    return { updateNotice }
  }
}

3、Vite 相关配置

// vite.config.js
import { defineConfig } from 'vite'

export default defineConfig({
  build: {
    rollupOptions: {
      output: {
         // 主入口文件命名规则
        entryFileNames: 'js/[name]-[hash:8].js',
        
        // 代码分割块命名规则
        chunkFileNames: 'js/[name]-[hash:8].js',
        
        // 静态资源文件命名规则
        assetFileNames: ({ name }) => {
          const ext = name?.split('.').pop()
          return `assets/${ext}/[name]-[hash:8].[ext]`
        }
      }
    },
    // 启用文件哈希的manifest生成
    manifest: true
  }
})

也可以将use-version-update写成以JS、TS模块化封装，在入口文件中main.ts引入

// use-version-update.ts
export const versionUpdate = () => {
  ... 具体处理逻辑
}

// main.ts
import { versionUpdate} from "@/utils/use-version-update"
if (import.meta.env.MODE == 'production') {
  versionUpdate()
}

4.2 vue2