网页重新部署，通知用户-最佳实践

乌托邦
13,090 阅读5分钟

为什么需要

如果用户打网页后，长时间不关闭对应标签页，也不刷新页面（在中后台管理项目挺常见的），且期间服务器页面有更新，可能会存在以下问题：

  1. 单页应用，如果前端部署是全量更新的话（建议增量更新），用户跳转其他页面，可能会 404, 因为对应资源已经不存在了。

  2. 如果后端接口有更新，且没做兼容处理的话，会影响数据准确性，也可能直接报错。

  3. 一个紧急 bug，你修复并发布了，用户如果没刷新页面，还是可以复现。

  4. 用户长期使用历史版本，影响用户体验。

  5. 老板和销售：不是说好的今天更新吗，怎么页面还是老样子。

    你：刷新下页面就好了

    老板和销售：怎么刷新页面啊？

    你：😤

plugin-web-update-notification

监听网页更新，并通知用户刷新页面的插件，支持 Vite、Webpack、umi

没错，最佳实践就是这个插件，如果觉得有用就点个 star 收藏下吧。

github | npm | 文档

原理

以 git commit hash (也支持 svn revision number、package.json version、build timestamp、custom) 为版本号，打包时将版本号写入一个 json 文件，同时注入客户端运行的代码。客户端轮询服务器上的版本号（浏览器窗口的visibilitychange、focus 事件辅助），和本地作比较，如果不相同则通知用户刷新页面。

优点

  1. 接入简单，安装插件，修改配置文件即可，不用修改业务代码（如果不自定义行为）。

    // 以 vite 为例
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import { webUpdateNotice } from '@plugin-web-update-notification/vite'
​
// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    vue(),
    webUpdateNotice({
      logVersion: true,
    }),
  ]
})

  2. 支持多种版本号类型：

    • git commit hash（git 仓库默认）。
    • svn revision number (svn 仓库默认)
    • package.json 中的 version 字段。（建议搭配 bumpp 食用最佳）
    • build timestamp，运行打包命令时的时间戳。
    • custom，用户自定义版本号。

  3. 预置了一个简约的更新 Notification，可以自定义文案、样式、位置。当然也可以取消默认的 Notification，监听到更新事件后自定义行为。

    image-20230311125900307

  4. 预置的 Notification 文案支持国际化。

  5. 支持手动控制检测。

  6. tiny, 注入的 js 和 css 文件压缩后不到 2kb。

  7. 完善的 ts 类型提示。

  8. issue 响应急时...

什么时候会检测更新

检测：通过 fetch 加载服务器上的 version.json 文件（会忽略本地缓存）。

  1. 首次加载页面。
  2. 轮询（default: 10 * 60 * 1000 ms）。
  3. js 脚本资源加载失败 (404 ?)。
  4. 标签页 visibilitychange、focus 事件为 true 时。(按目前公司的项目来看，大多数更新是这个时候命中的，轮询反而少些)

关于时效性

有人说轮询如果频率太慢了，时效性会比较差。

我觉得影响不大。用户一般不会长时间保持这个标签页在前台，很有可能会切换到其他标签页或直接切出浏览器做其他操作，这时如果你回到当前标签页，会触发 visibilitychange 事件，立刻检测更新。所以大多数更新应该是在visibilitychange、focus 事件中命中的，轮询反而是一个辅助兜底的手段。

轮询对服务器的压力？

感觉应该问题不大，只是轮询服务器上的一个 json 文件。

// version.json
{
  "version": "f29e8de"
}

而且如果用户离开（不关闭）当前标签页时，插件会暂时停止轮询的行为。重新回到页面后，会立刻检查一次并开启轮询。

你也可以设置 checkInterval: 0 来关闭轮询，只通过 visibilitychange、focus 事件来触发检测。

是否单独起一个 web worker 跑检测更新任务

看到有类似功能的插件会单独起一个 worker 来运行检测更新任务，为了不影响主线程。

个人觉得没有太大必要，因为检测更新任务只是简单的 fetch json 文件，然后做下本地与远程的版本对比，应该可以说是毫无压力。反而运行一个 web worker 会占用内存和 cpu。

插件对打包内容做了哪些变动

image.png

源码

monorepo 形式组织代码，原理简单，代码也比较简单。

core: 主要是如何获取版本号。

injectScript: 注入到客户端运行的代码。

injectStyle: 预置的 Notification css 样式。

vite plugin: vite 插件的实现。

webpack plugin: webpack 插件的实现。

umi plugin: umi 插件的实现。

e2e test: vite 插件的基于 playwright 的 e2e 测试。

你可以看看一个标准的 js 库是如何通过 tsup 打包，如何配置 pkg 的。

一个通过 tag 触发，打包 -> release -> 发布 npm 包的 github action workflow 配置。

一个简单的 vite、webpack、umi 插件怎么能写的。

为什么不使用 ** 方案?

websocket

需要一个 websocket 服务, 还需要后端配合。

service worker（pwa）

印像中老版本的 vue-router 文档就是基于 service worker 做的更新通知。

接入 service worker 需要成本，本地运行一个 worker 也会占用内存和 cpu 资源。

国内并不流行 pwa。

最主要是的它具有拦截并处理网络请求的能力，如果你不熟悉，很有可能造成强缓存，手动强制刷新页面都无法更新。参考谨慎处理 Service Worker 的更新。

如果非要使用的话， 建议使用 vite-plugin-pwa，插件已经内置了更新提示功能，开发也不用关心如何更新 sw.js。

对比 html 文件里引入的 js 文件 hash 值

不支持监听静态资源的更新。

轮询加载 version.json 应该比加载 index.html 对服务器的压力小些吧。

如 webpack 打包时给文件路径加 hash 的功能是可以被关闭的。

检查 index.html Response head 的 Etag、Last-Modified 值

需要服务端开启缓存。另外, 一些代理服务和负载均衡设备也可能在转发 HTTP 请求和响应时在 Etag 和 Last-Modified 之前去除这些头信息，以减少网络负载和提高性能。

不支持监听静态资源的更新。

avatar
文章
阅读
粉丝