前端项目部署后如何提示用户版本更新详解_Javascript

前言

项目部署上线后，特别是网页项目，提示正在操作系统的用户去更新版本非常 important。一般我们都会用“刷新大法”来清理缓存，但是对于正在操作网页的用户，不造系统更新了，请求的还是老版本的资源。

为了确保用户能够及时获得最新的功能和修复的 bug，我们需要通知用户刷新页面获取最新的代码。

解决方案

每次打包时，都生成一个时间戳，作为系统的伪版本，放到json文件中，通过对比文件的响应头etag判断是否有更新。具体步骤如下：

在public文件夹下加入manifest.json文件，里面存放两个字段：更新内容、更新时间戳
前端打包的时候向manifest.json写入当前时间戳信息
在入口文件main.js中引入检查版本更新的逻辑，有更新则提示更新。有两种方式提示提示用户：
- 路由守卫router.beforeresolve（vue-router为例），检查更新，对比manifest.json文件的响应头etag判断是否有更新
- 通过worker轮询，检查更新，对比manifest.json文件的响应头etag判断是否有更新。worker线程并不影响其他线程的逻辑。

整体逻辑如下所示：

1、public目录下新建manifest.json

{
   "timestamp":21312321311,
   "msg":"更新内容如下：\n--1.添加系统更新提示机制"
}

2、写入当前时间戳到manifest.json

vue.config.js文件中

const { readfile, writefile } = require('fs')
// 获取路径
const filepath = path.resolve(`./public`, 'manifest.json')
// 读取文件内容
readfile(filepath, 'utf8', (err, data) => {
  if (err) {
    console.error('读取文件时出错:', err)
    return
  }
  // 将文件内容转换json
  const dataobj = json.parse(data)
  //修改时间戳
  dataobj.timestamp = new date().gettime()
  // 将修改后的内容写回文件
  writefile(filepath, json.stringify(dataobj), 'utf8', err => {
    if (err) {
      console.error('写入文件时出错:', err)
      return
    }
  })
})

3、检查版本更新

新建 checkupdate.js 文件

（1）初始化变量

import worker from "./checkupdate.worker.js";
import router from '../router'
//上次的etag
let lastetag = ''；
//是否更新
let hasupdate = false
//创建worker线程
const worker = new worker();

（2）检查版本更新

//检查版本更新
async function checkupdate() {
  try {
    // 检测前端资源是否有更新
    let response = await fetch(`/manifest.json?v=${date.now()}`, {
      method: 'head'
    })
    // 获取最新的etag  
    let etag = response.headers.get('etag')
    hasupdate = lastetag && etag !== lastetag
    lastetag = etag
  } catch (e) {
    return promise.reject(e)
  }
}

其中let response = await fetch(/manifest.json?v=${date.now()}, { method: 'head' })，
使用 fetch 函数发起了一个 http 请求，获取了指定资源的头信息（http 头部）。其中 manifest.json 是要请求的资源，date.now() 会生成当前时间的时间戳，作为查询参数 v 的值，这样可以避免浏览器缓存，强制获取最新的资源。请求方式为 head，这意味着只请求资源的头部信息而不获取具体的内容。

let etag = response.headers.get('etag')，从 http 响应中获取了 etag 头部信息，etag 是服务器生成的资源唯一标识，用于检查资源是否发生了变化。具体比较逻辑如下：

1、客户端发起请求，请求中包含上次获取的资源的etag。
2、服务器收到请求后，比较客户端提供的etag与当前资源的etag是否一致。
3、如果一致，则返回http 304 not modified响应，表示资源未发生变化，客户端可以使用缓存的版本。
4、如果不一致，服务器返回最新的资源内容，同时更新etag。
5、客户端收到响应后，更新本地缓存的资源内容和etag。

（3）路由跳转检测版本更新

 // 路由拦截
 router.beforeeach(async (to, from, next) => {
  next()
  try {
    await checkupdate()
    if (hasupdate) {
      worker.postmessage({
        type: 'destroy'
      })
      location.reload()
    }
  } catch (e) {}
})

（4）向worker线程发送检查版本更新逻辑

worker.postmessage({
  type: 'check'
})

（5）接收到 worker 线程数据更新

worker.onmessage = ({ data }) => {
  console.log(data,'data')
  if (data.type === 'hasupdate') {
    hasupdate = true
    confirmreload(data.msg, data.lastetag)
  }
}

（6）收到版本更新信息，进行弹框提示

收到版本更新信息后，先暂停轮询检查版本更新，点击确定按钮，则发送destory消息，点击取消按钮则发送recheck消息

async function confirmreload(msg = '', lastetag) {
  worker &&
    worker.postmessage({
      type: 'pause'
    })
  try {
  //弹框提示逻辑
  } catch (e) { }
}

checkupdate.js 全部代码实现

import worker from "./checkupdate.worker.js";
import router from '../router'
//上次的etag
let lastetag = ''；
//是否更新
let hasupdate = false
//创建worker线程
const worker = new worker();

//检查版本更新
async function checkupdate() {
  try {
    // 检测前端资源是否有更新
    let response = await fetch(`/manifest.json?v=${date.now()}`, {
      method: 'head'
    })
    // 获取最新的etag  
    let etag = response.headers.get('etag')
    hasupdate = lastetag && etag !== lastetag
    lastetag = etag
    console.log(lastetag = etag,'lastetag = etag')
  } catch (e) {
    return promise.reject(e)
  }
}

async function confirmreload(msg = '', lastetag) {
  worker &&
    worker.postmessage({
      type: 'pause'
    })
  try {
    console.log('版本更新了')
  } catch (e) { }
}
 // 路由拦截
 router.beforeeach(async (to, from, next) => {
  next()
  try {
    await checkupdate()
    if (hasupdate) {
      worker.postmessage({
        type: 'destroy'
      })
      location.reload()
    }
  } catch (e) {}
})

worker.postmessage({
  type: 'check'
})


worker.onmessage = ({ data }) => {
  console.log(data,'data')
  if (data.type === 'hasupdate') {
    hasupdate = true
    confirmreload(data.msg, data.lastetag)
  }
}

4、woker线程

新建 checkupdate.worker.js

（1）初始化变量

let lastetag；//上次的etag
let hasupdate = false；//是否更新
let intervalid = ''；

（2）检查版本更新

逻辑更第三步差不多，唯一一点就是检测到更新后，发送hasupdate消息，给出弹框提示是否需要更新

async function checkupdate() {
  try {
    // 检测前端资源是否有更新
    let response = await fetch(`/manifest.json?v=${date.now()}`, {
      method: 'get'
    })
    // 获取最新的etag和data
    let etag = response.headers.get('etag')
    let data = await response.json()
    hasupdate = lastetag !== undefined && etag !== lastetag
  
    if (hasupdate) {
      postmessage({
        type: 'hasupdate', 
        msg: data.msg,
        lastetag: lastetag,
        etag: etag
      })
    }
    lastetag = etag
  } catch (e) {
    return promise.reject(e)
  }
}

（3）监听主线程发送过来的数据

// 监听主线程发送过来的数据
addeventlistener('message', ({ data }) => {
  console.log(data,'消息')
  if (data.type === 'check') {  
    // 每5分钟执行一次
    // 立即执行一次，获取最新的etag，避免在setinterval等待中系统更新，第一次获取的etag是新的，但是lastetag还是undefined，不满足条件，错失刷新时机
    // checkupdate()
    intervalid = setinterval(()=>{
      checkupdate()
      //这里3s方便测试
    },  3 * 1000)
  }
  if (data.type === 'recheck') {
    // 每5分钟执行一次
    hasupdate = false
    lastetag = data.lastetag
    intervalid = setinterval(()=>{
      checkupdate()
    },  3 * 1000)
  }
  if (data.type === 'pause') {
    clearinterval(intervalid)
  }
  if (data.type === 'destroy') {
    clearinterval(intervalid)
    close()
  }
})

完整代码逻辑如下：

let lastetag
let hasupdate = false
let intervalid = ''
async function checkupdate() {
 
  try {
    // 检测前端资源是否有更新
    let response = await fetch(`/manifest.json?v=${date.now()}`, {
      method: 'get'
    })
    // 获取最新的etag和data
    let etag = response.headers.get('etag')
    let data = await response.json()
    hasupdate = lastetag !== undefined && etag !== lastetag
  
    if (hasupdate) {
      postmessage({
        type: 'hasupdate', 
        msg: data.msg,
        lastetag: lastetag,
        etag: etag
      })
    }
    lastetag = etag
  } catch (e) {
    return promise.reject(e)
  }
}

// 监听主线程发送过来的数据
addeventlistener('message', ({ data }) => {
  console.log(data,'消息')
  if (data.type === 'check') {  
     console.log('checkcheckcheck')
    // 每5分钟执行一次
    // 立即执行一次，获取最新的etag，避免在setinterval等待中系统更新，第一次获取的etag是新的，但是lastetag还是undefined，不满足条件，错失刷新时机
    // checkupdate()
    intervalid = setinterval(()=>{
      checkupdate()
      console.log('检查版本更新')
    },  3 * 1000)
  }
  if (data.type === 'recheck') {
    // 每5分钟执行一次
    hasupdate = false
    lastetag = data.lastetag
    intervalid = setinterval(()=>{
      checkupdate()
      console.log('检查版本更新')
    },  3 * 1000)
    console.log('recheckrecheckrecheck')
  }
  if (data.type === 'pause') {
    clearinterval(intervalid)
  }
  if (data.type === 'destroy') {
    clearinterval(intervalid)
    close()
  }
})

5、入口文件引入

import "@/utils/checkupdate.js"

可能出现的问题

1、worker

webpack 5 可以使用 web workers

new worker(new url('./checkupdate.worker.js', import.meta.url));

webpack 5 以下，使用 worker-loader，先安装worker-loader

yarn add worker-loader -d

然后在vue.config.js 配置

  chainwebpack(config) {
    config.module
    .rule('worker')
    .test(/\.worker\.js$/)
    .use('worker')
    .loader('worker-loader')
    .end()
  }

如果配置有问题，会一直出现下面这个问题，worker-loader 的配置要放在其他 loader 前。