plugin-web-update-notification 使用教程

1. 项目介绍

plugin-web-update-notification 是一款用于检测前端网页更新并提示用户刷新页面的工具。它基于 Git 的提交哈希、SVN 的修订号、包版本或自定义标记作为版本号，将版本信息写入 JSON 文件。客户端通过定期检查服务器上的版本并与本地进行比较，当检测到版本变化时，显示更新通知，引导用户刷新页面，以确保他们始终访问的是最新内容。

2. 项目快速启动

安装

首先，你需要安装 plugin-web-update-notification 依赖：

pnpm add @plugin-web-update-notification/vite -D

配置 Vite

在你的 Vite 配置文件（如 vite.config.js）中引入并配置该插件：

import { defineConfig } from 'vite';
import vue from '@vitejs/plugin-vue';
import { webUpdateNotice } from '@plugin-web-update-notification/vite';

export default defineConfig({
  plugins: [
    vue(),
    webUpdateNotice({
      logVersion: true,
      checkInterval: 5 * 60 * 1000, // 设置检查间隔，单位毫秒，默认10分钟后检查
      notificationProps: {
        title: '系统更新',
        description: '系统已更新，请刷新页面',
        buttonText: '刷新',
        dismissButtonText: '忽略',
      },
    }),
  ],
});

启动项目

执行常规的 Vite 服务启动命令：

vite dev

3. 应用案例和最佳实践

最佳实践：

1. 调整检查间隔：根据项目需求，可设置适当的检查更新间隔，避免频繁打扰用户。
2. 自定义通知样式：可以覆盖默认 CSS 样式，以匹配你的网站设计。
3. 处理用户反馈：提供关闭更新提示的选项，但应告知用户关闭后可能错过重要更新。

应用案例：

• 当有重大安全更新或功能增强时，使用此插件强制用户刷新页面以获得更新。
• 对于需要实时数据同步或者用户体验要求较高的应用，保证用户总能看到最新内容。

4. 典型生态项目

plugin-web-update-notification 支持多种构建工具：

• Vite
• UmiJS
• Webpack

这些工具的社区广泛，相关插件和扩展丰富，使得 plugin-web-update-notification 很容易集成到各种现代前端项目中。

例如，对于 UmiJS 项目，可以在 umirc.ts 中这样配置：

import { defineConfig } from 'umi';
import type { Options as WebUpdateNotificationOptions } from '@plugin-web-update-notification/umijs';

export default defineConfig({
  plugins: [
    '@plugin-web-update-notification/umijs',
    {
      webUpdateNotification: {
        logVersion: true,
        checkInterval: 5 * 60 * 1000,
        notificationProps: {
          title: '系统更新',
          description: '系统已更新，请刷新页面',
          buttonText: '刷新',
          dismissButtonText: '忽略',
        },
      },
    },
  ],
});

以上即为 plugin-web-update-notification 的简单介绍、快速启动步骤以及一些使用场景和生态项目的介绍。希望对你在实际项目中的应用有所帮助。