前端线上部署,如何通知用户有新版本

前言

version-polling 是一个轻量级的 JavaScript 库,它可以实时检测 web 应用的 index.html 文件内容是否有变化。当服务端发布新版本后,前端会自动弹出更新提示,让用户刷新页面,以加载最新的资源和功能。这样可以提高用户体验和数据准确性。

设计目的

为了解决后端部署之后,如何通知用户系统有新版本,并引导用户刷新页面以加载最新资源的问题。

适用场景

用户在浏览器中打开某 web 应用(通常是后台管理系统)很长时间且未刷新页面时,如果应用有新功能添加或问题修复,用户可能无法及时知道有新版发布。这样会导致用户继续使用旧版,影响用户体验和数据准确性,甚至出现程序报错。

功能特性

  1. 针对前端 web 单页应用而设计

  2. 纯前端技术实现,使用简单,不需要后端支持

  3. 支持 TypeScript

实现原理

  1. 使用 Web Worker API 在浏览器后台轮询请求页面,不会影响主线程运行。

  2. 命中协商缓存,对比本地和服务器请求响应头etag字段值。

  3. 如果etag值不一致,说明有更新,则弹出更新提示,并引导用户手动刷新页面(例如弹窗提示),完成应用更新。

  4. 当页面不可见时(例如切换标签页或最小化窗口),停止实时检测任务;再次可见时(例如切换回标签页或还原窗口),恢复实时检测任务。

浏览器兼容性

适用于支持原生 ES 模块的现代浏览器,具体可参考以下 browserslist 配置

defaults and supports es6-module
maintained node versions

安装

# 本地项目安装
npm install version-polling --save

使用

  1. 通过 npm 引入,并通过构建工具进行打包

    // 在应用入口文件中使用: 如 main.js, app.jsx
    import { createVersionPolling } from "version-polling";

    createVersionPolling({
    appETagKey: "APP_ETAG",
    pollingInterval: 5 * 1000, // 单位为毫秒
    silent: process.env.NODE_ENV === "development", // 开发环境下不检测
    onUpdate: (self) => {
    // 当检测到有新版本时,执行的回调函数,可以在这里提示用户刷新页面
    const result = confirm("页面有更新,点击确定刷新页面!");
    if (result) {
    self.onRefresh();
    } else {
    self.onCancel();
    }
    // 强制更新可以用alert
    // alert('有新版本,请刷新页面');
    },
    });

  2. 通过 script 引入,直接插入到 HTML,无侵入用法,接入成本最低

    <!DOCTYPE html> <html lang="en"> <head> <meta charset="UTF-8" /> <meta http-equiv="X-UA-Compatible" content="IE=edge" /> <meta name="viewport" content="width=device-width, initial-scale=1.0" /> <title>前端页面自动检测更新-示例</title> </head> <body> <script src="//unpkg.com/version-polling/dist/version-polling.min.js"></script> <script> VersionPolling.createVersionPolling({ appETagKey: "__APP_ETAG__", pollingInterval: 5 * 1000, onUpdate: (self) => { // 当检测到有新版本时,执行的回调函数,可以在这里提示用户刷新页面 const result = confirm("页面有更新,点击确定刷新页面!"); if (result) { self.onRefresh(); } else { self.onCancel(); } }, }); </script> </body> </html>

最佳实践

在项目 index.html 下直接插入 script,类似于百度统计那种用法,具体代码参考:

https://github.com/JoeshuTT/version-polling

注意事项

  • version-polling 需要在支持 web workerfetchAPI 的浏览器中运行,不支持 IE 浏览器

  • version-polling 需要在 web 应用的入口文件(通常是 index.html)中引入,否则无法检测到更新

  • version-polling 需要在 web 应用的服务端配置协商缓存,否则无法命中缓存,会增加网络请求

  • version-polling 需要在 web 应用的服务端保证每次发版后,index.html 文件的 etag 字段值会改变,否则无法检测到更新

相关推荐
Leyla15 分钟前
【代码重构】好的重构与坏的重构
前端
影子落人间18 分钟前
已解决npm ERR! request to https://registry.npm.taobao.org/@vant%2farea-data failed
前端·npm·node.js
世俗ˊ42 分钟前
CSS入门笔记
前端·css·笔记
子非鱼92143 分钟前
【前端】ES6:Set与Map
前端·javascript·es6
6230_1 小时前
git使用“保姆级”教程1——简介及配置项设置
前端·git·学习·html·web3·学习方法·改行学it
想退休的搬砖人1 小时前
vue选项式写法项目案例(购物车)
前端·javascript·vue.js
加勒比海涛1 小时前
HTML 揭秘:HTML 编码快速入门
前端·html
啥子花道1 小时前
Vue3.4 中 v-model 双向数据绑定新玩法详解
前端·javascript·vue.js
麒麟而非淇淋1 小时前
AJAX 入门 day3
前端·javascript·ajax
茶茶只知道学习2 小时前
通过鼠标移动来调整两个盒子的宽度(响应式)
前端·javascript·css