ty-version-updating

一个用于实时检测 web 应用更新的 JavaScript 库

前言

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

设计目的

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

适用场景

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

功能特性

• 针对前端 web 单页应用而设计
• 纯前端技术实现，使用简单，不需要后端支持
• 支持 TypeScript

实现原理

1. 使用 Web Worker API 在浏览器后台轮询请求页面，不会影响主线程运行。
2. 命中协商缓存，对比本地和服务器请求响应头etag字段值。
3. 如果etag值不一致，说明有更新，则弹出更新提示，并引导用户手动刷新页面（例如弹窗提示），完成应用更新。
4. 当页面不可见时（例如切换标签页或最小化窗口），停止实时检测任务；再次可见时（例如切换回标签页或还原窗口），恢复实时检测任务。

浏览器兼容性

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

defaults and supports es6-module
maintained node versions

安装

1# 本地项目安装
2npm install ty-version-updating --save

使用

• 通过 npm 引入，并通过构建工具进行打包

1// 在应用入口文件中使用: 如 main.js, app.jsx
2import { createVersionPolling } from "ty-version-updating";
3
4createVersionPolling({
5  appETagKey: "__APP_ETAG__",
6  pollingInterval: 4 * 1000, // 单位为毫秒
7  silent: process.env.NODE_ENV === "development", // 开发环境下不检测
8  onUpdate: (self) => {
9    // 当检测到有新版本时，执行的回调函数，可以在这里提示用户刷新页面
10    const result = confirm("页面有更新，点击确定刷新页面！");
11    if (result) {
12      self.onRefresh();
13    } else {
14      self.onCancel();
15    }
16    // 强制更新可以用alert
17    // alert('有新版本，请刷新页面');
18  },
19});

API

Options

参数	说明	类型	默认值
appETagKey	web 应用更新唯一标识字段名	string	__APP_ETAG__
pollingInterval	轮询间隔，单位为毫秒，默认为 5 分钟	number	5 * 60 * 1000
htmlFileUrl	web 应用网站运行目录	string	${location.origin}${location.pathname}
silent	安静模式，为true时，不会进行实时监测	boolean	false
silentPollingInterval	安静模式，为true时，不做轮询任务	boolean	false
silentPageVisibility	安静模式，为true时，不做页面可见状态监听	boolean	false
forceUpdate	强制更新，为true是，取消也会检查更新	boolean	false
onUpdate	更新检测的回调函数，可以自定义更新的逻辑	(self) => void	-

注意事项

• ty-version-updating 需要在支持 web worker 和 fetchAPI 的浏览器中运行，不支持 IE 浏览器
• ty-version-updating 需要在 web 应用的入口文件（通常是 index.html）中引入，否则无法检测到更新
• ty-version-updating 需要在 web 应用的服务端配置协商缓存，否则无法命中缓存，会增加网络请求
• ty-version-updating 需要在 web 应用的服务端保证每次发版后，index.html 文件的 etag 字段值会改变，否则无法检测到更新