SPA 单页应用无刷新更新部署方案与实战优化

使用 webpack 自动向 manifest.json 写入当前时间戳信息。

vue.config.js 配置示例

// vue.config.js
const fs = require('fs');
const path = require('path');

// 定义要写入 manifest.json 的内容，可自定义扩展
const buildManifestContent = {
  // 项目版本号（可读取 package.json 的 version，实现自动同步）
  appVersion: require('./package.json').version,
  // 构建时间，自动生成时间戳
  version: new Date().getTime(),
  // 构建环境（development/production）
  buildEnv: process.env.NODE_ENV,
  // 哈希值，适配 SPA 更新检测（可选）
  buildHash: new Date().getTime().toString(16),
  // 自定义更新标识，配合前端版本检测
  needRefresh: false,
  msg: "更新内容如下：\n--1.更新提示机制"
};

module.exports = {
  // Webpack 配置扩展
  configureWebpack: {
    plugins: [
      // 自定义 Webpack 插件，实现写入 manifest.json
      {
        apply(compiler) {
          // 定义写入函数，封装重复逻辑
          const writeManifest = () => {
            const manifestPath = path.resolve(__dirname, 'public/manifest.json');
            try {
              // 先读取原有内容
              let originalContent = {};
              if (fs.existsSync(manifestPath)) {
                const fileStr = fs.readFileSync(manifestPath, 'utf-8');
                originalContent = JSON.parse(fileStr);
              }
              // 合并原有内容和新内容，新内容覆盖重复字段
              const finalContent = { ...originalContent, ...buildManifestContent };
              // 写入合并后的内容
              fs.writeFileSync(manifestPath, JSON.stringify(finalContent, null, 2), 'utf-8');
              console.log('✅ 成功合并并写入 public/manifest.json');
            } catch (error) {
              console.error('❌ 写入 manifest.json 失败：', error);
            }
          };

          // 生产环境打包：编译前执行写入
          compiler.hooks.beforeRun.tap('WriteManifestPlugin', writeManifest);
          // 开发环境监听模式：文件变化时执行写入
          compiler.hooks.watchRun.tap('WriteManifestPlugin', writeManifest);
        }
      }
    ]
  }
};

1. 在 App.vue 入口中监听路由变化进行判断是否更新

核心思路是在路由切换时拉取最新的 manifest.json，对比本地存储的版本号。

// App.vue 文件
watch: {
  $route(to, from) {
    fetch(`/manifest.json?v=${Date.now()}`).then(response => {
      if (!response.ok) {
        throw new Error('Network response was not ok');
      }
      return response.json(); // 将响应解析为 JSON 格式
    }).then(data => {
      const newVersion = data?.version;
      const oldVersion = Number(localStorage.getItem('lastVersion'));
      
      if (!oldVersion || oldVersion !== data?.version) {
        console.log('版本升级了，强制刷新');
        localStorage.setItem('lastVersion', newVersion);
        setTimeout(() => {
          window.location.reload(true);
        }, 1000);
      } else {
        // console.log('Latest Version, No Update Needed');
      }
    }).catch(err => {
      console.error('There was a problem with the fetch operation:', err);
    });
  }
}

2. 轮询方式检查版本更新

适合对实时性要求不高，但希望保持连接轻量化的场景。

flowchart TD
A[开始] --> B[加载 manifest.json]
B --> C{与缓存版本比较？}
C -- Yes --> D[提示用户或是静默刷新界面]
C -- No --> E[轮询 manifest.json，继续此流程]

代码实现：

// 版本管理模块：VersionManager.js
class VersionManager {
  constructor() {
    this.currentVersion = null;
    this.updateCallback = null;
    this.pollingInterval = 300000; // 5 分钟轮询一次
    this.isUpdateAvailable = false;
  }

  // 初始化版本检测
  init(versionUrl, onUpdate) {
    this.updateCallback = onUpdate;
    return this.fetchVersion(versionUrl)
      .then(version => {
        this.currentVersion = version;
        this.startPolling(versionUrl);
        return version;
      });
  }

  // 获取版本信息
  fetchVersion(url) {
    return fetch(url, {
      cache: 'no-cache', // 禁用缓存
      headers: {
        'Cache-Control': 'no-cache, no-store, must-revalidate',
        'Pragma': 'no-cache',
        'Expires': '0'
      }
    })
      .then(res => res.json())
      .then(data => data.version || data.buildTime)
      .catch(err => {
        console.error('版本获取失败:', err);
        return null;
      });
  }

  // 启动定时轮询
  startPolling(url) {
    setInterval(() => {
      this.fetchVersion(url)
        .then(newVersion => {
          if (newVersion && this.isNewVersion(newVersion)) {
            this.isUpdateAvailable = true;
            this.promptUserToUpdate();
          }
        });
    }, this.pollingInterval);
  }

  // 版本比较（支持语义化版本或时间戳）
  isNewVersion(newVersion) {
    if (!this.currentVersion) return true;
    // 语义化版本比较示例
    if (this.currentVersion.includes('.')) {
      const current = this.currentVersion.split('.').map(Number);
      const latest = newVersion.split('.').map(Number);
      for (let i = 0; i < current.length; i++) {
        if (latest[i] > current[i]) return true;
        if (latest[i] < current[i]) return false;
      }
      return false;
    }
    // 时间戳比较示例
    return newVersion > this.currentVersion;
  }

  // 提示用户更新
  promptUserToUpdate() {
    if (!this.updateCallback) return;
    // 可自定义提示样式
    const updateConfirm = confirm('检测到新版本，是否立即刷新页面？');
    if (updateConfirm) {
      this.updateCallback();
    }
  }
}

// 在应用中使用
const versionManager = new VersionManager();
versionManager.init('manifest.json', () => {
  location.reload(); // 刷新页面
});

3. 服务器推送 Server-Sent Events (SSE) 实现

SSE 是 HTML5 提供的单向服务器推送技术，适合更新通知场景，比轮询更节省带宽。

服务器端（Node.js 示例）

const http = require('http');
const fs = require('fs');
const path = require('path');

const server = http.createServer((req, res) => {
  if (req.url === '/updates' && req.method === 'GET') {
    res.writeHead(200, {
      'Content-Type': 'text/event-stream',
      'Cache-Control': 'no-cache',
      'Connection': 'keep-alive'
    });
    res.write(': keep-alive\n\n'); // 心跳包防止连接断开
    
    // 监听版本变更事件
    let lastVersion = '1.0.0';
    fs.watch(path.join(__dirname, 'version.json'), (event, filename) => {
      if (event === 'change') {
        const newVersion = JSON.parse(fs.readFileSync(path.join(__dirname, 'version.json'))).version;
        if (newVersion !== lastVersion) {
          res.write(`event: update\n`);
          res.write(`data: ${newVersion}\n\n`);
          lastVersion = newVersion;
        }
      }
    });

    // 客户端断开连接处理
    req.on('close', () => {
      console.log('客户端连接关闭');
    });
  } else {
    // 其他请求处理...
  }
});

server.listen(3000, () => {
  console.log('服务器运行在 3000 端口');
});

客户端实现

class SSEUpdateNotifier {
  constructor() {
    this.sse = null;
    this.currentVersion = null;
  }

  init(versionUrl, sseUrl, onUpdate) {
    return this.fetchVersion(versionUrl)
      .then(version => {
        this.currentVersion = version;
        this.startListening(sseUrl, onUpdate);
        return version;
      });
  }

  fetchVersion(url) {
    // 同轮询方案中的 fetchVersion
    return fetch(url, { cache: 'no-cache' })
      .then(res => res.json())
      .then(data => data.version || data.buildTime);
  }

  startListening(url, onUpdate) {
    this.sse = new EventSource(url);
    this.sse.onmessage = event => {
      if (event.data && this.isNewVersion(event.data)) {
        onUpdate(); // 提示用户更新
      }
    };
    this.sse.onerror = error => {
      console.error('SSE 连接错误:', error);
      // 错误重连逻辑
      setTimeout(() => {
        this.startListening(url, onUpdate);
      }, 5000);
    };
  }

  isNewVersion(newVersion) {
    // 同轮询方案中的 isNewVersion
    return !this.currentVersion || newVersion > this.currentVersion;
  }

  close() {
    if (this.sse) {
      this.sse.close();
    }
  }
}

// 使用示例
const notifier = new SSEUpdateNotifier();
notifier.init('manifest.json', '/updates', () => {
  // 显示更新提示
  const updateModal = document.createElement('div');
  updateModal.innerHTML = `
    <div>
      <h3>发现新版本</h3>
      <p>点击'更新'按钮体验新功能</p>
      <button id="update-now">立即更新</button>
      <button id="update-later">稍后更新</button>
    </div>
  `;
  document.body.appendChild(updateModal);
  
  document.getElementById('update-now').addEventListener('click', () => {
    location.reload();
    updateModal.remove();
  });
  
  document.getElementById('update-later').addEventListener('click', () => {
    updateModal.remove();
    // 设置稍后提醒时间（如 30 分钟后）
    setTimeout(() => {
      notifier.promptUserToUpdate();
    }, 1800000);
  });
});

4. 使用 WebSocket 实现

适用于需要双向通信或更高实时性的场景。

class WebSocketUpdateNotifier {
  constructor() {
    this.ws = null;
    this.currentVersion = null;
    this.reconnectAttempts = 0;
    this.maxReconnects = 10;
  }

  init(versionUrl, wsUrl, onUpdate) {
    this.onUpdate = onUpdate;
    return this.fetchVersion(versionUrl)
      .then(version => {
        this.currentVersion = version;
        this.connectToWebSocket(wsUrl);
        return version;
      });
  }

  fetchVersion(url) {
    // 同轮询方案
    return fetch(url, { cache: 'no-cache' })
      .then(res => res.json())
      .then(data => data.version || data.buildTime);
  }

  connectToWebSocket(url) {
    this.ws = new WebSocket(url);
    this.ws.onopen = () => {
      console.log('WebSocket 连接已建立');
      this.reconnectAttempts = 0;
      // 发送当前版本号
      this.ws.send(JSON.stringify({ type: 'version', data: this.currentVersion }));
    };

    this.ws.onmessage = event => {
      const message = JSON.parse(event.data);
      if (message.type === 'update' && this.isNewVersion(message.data)) {
        this.onUpdate();
      }
    };

    this.ws.onclose = (event) => {
      console.log('WebSocket 连接关闭:', event);
      if (this.reconnectAttempts < this.maxReconnects) {
        this.reconnectAttempts++;
        setTimeout(() => {
          this.connectToWebSocket(url);
        }, 2000 * this.reconnectAttempts); // 指数退避重连
      }
    };

    this.ws.onerror = error => {
      console.error('WebSocket 错误:', error);
    };
  }

  isNewVersion(newVersion) {
    return !this.currentVersion || newVersion > this.currentVersion;
  }
}

其他用户体验优化策略

1. 渐进式提示设计

检测到更新后做弹窗提示，避免打扰用户工作流。

// 多级提示策略
let updatePromptLevel = 0;
const MAX_PROMPT_LEVEL = 3;

function showUpdatePrompt() {
  updatePromptLevel++;
  if (updatePromptLevel === 1) {
    // 轻度提示（页面角落通知）
    const notification = document.createElement('div');
    notification.className = 'update-notification';
    notification.innerHTML = '发现新版本，点击查看详情';
    notification.onclick = showUpdateModal;
    document.body.appendChild(notification);
  } else if (updatePromptLevel === 2) {
    // 中度提示（半透明遮罩）
    showUpdateModal();
  } else if (updatePromptLevel === 3) {
    // 重度提示（全屏模态框）
    showForceUpdateModal();
  }
}

function showUpdateModal() {
  // 带更多信息的模态框
  // 包含版本更新日志、更新按钮、稍后提醒选项
}

function showForceUpdateModal() {
  // 强制更新提示
  const modal = document.createElement('div');
  modal.className = 'force-update-modal';
  modal.innerHTML = `
    <h2>必须更新</h2>
    <p>旧版本已不再支持，请刷新页面使用最新版本</p>
    <button onclick="location.reload()">立即更新</button>
  `;
  document.body.appendChild(modal);
}

结合版本文件中的更新说明：

fetch('manifest.json')
  .then(res => res.json())
  .then(versionInfo => {
    if (versionInfo.changelog) {
      const changelog = versionInfo.changelog.map(item => `
        <div>
          <h4>${item.title}</h4>
          <p>${item.description}</p>
        </div>
      `).join('');
      updateModal.innerHTML = `
        <h3>版本 ${versionInfo.version} 已更新</h3>
        <div>${changelog}</div>
        <button>立即更新</button>
        <button>1 小时后提醒</button>
      `;
    }
  });

2. 智能延迟策略

根据用户行为动态调整提醒时机，避免在用户操作密集时打断。

// 根据用户行为动态调整提醒时机
function shouldShowPrompt() {
  // 用户活跃状态检测
  const isActive = document.hidden === false;
  // 用户操作频率检测
  const userActivity = { clicks: 0, scrolls: 0, lastAction: 0 };
  
  document.addEventListener('click', () => {
    userActivity.clicks++;
    userActivity.lastAction = Date.now();
  });
  
  document.addEventListener('scroll', () => {
    userActivity.scrolls++;
    userActivity.lastAction = Date.now();
  });
  
  // 如果最近 10 秒内有操作，暂不提示
  if (Date.now() - userActivity.lastAction < 10000) {
    return false;
  }
  return isActive;
}

3. 参考开源项目

实际项目中可直接参考成熟的版本检测库，减少重复造轮子的工作量。常见的实现思路包括定期轮询 manifest 文件或基于长连接的通知机制。