記錄--前端重新部署如何通知用戶

来源:https://www.cnblogs.com/smileZAZ/archive/2023/08/07/17612178.html
-Advertisement-
Play Games

這裡給大家分享我在網上總結出來的一些知識，希望對大家有所幫助 1. 場景 前端構建完上線，用戶還停留還在老頁面，用戶不知道網頁重新部署了，跳轉頁面的時候有時候js連接hash變了導致報錯跳不過去，並且用戶體驗不到新功能。 2. 解決方案 每次打包寫入一個json文件，或者對比生成的script的sr ...


這裡給大家分享我在網上總結出來的一些知識，希望對大家有所幫助

1. 場景

前端構建完上線，用戶還停留還在老頁面，用戶不知道網頁重新部署了，跳轉頁面的時候有時候js連接hash變了導致報錯跳不過去，並且用戶體驗不到新功能。

2. 解決方案

  1. 每次打包寫入一個json文件，或者對比生成的script的src引入的hash地址或者etag不同，輪詢調用，判斷是否更新
  2. 前端使用websocket長連接，具體是每次構建，打包後通知後端，更新後通過websocket通知前端

輪詢調用可以改成在前置路由守衛中調用，無需控制時間，用戶有操作才去調用判斷。

3. 具體實現

3.1 輪詢方式

參考小滿的實現稍微修改下：

class Monitor {
  private oldScript: string[] = []

  private newScript: string[] = []

  private oldEtag: string | null = null

  private newEtag: string | null = null

  dispatch: Record<string, (() => void)[]> = {}

  private stop = false

  constructor() {
    this.init()
  }

  async init() {
    console.log('初始化')
    const html: string = await this.getHtml()
    this.oldScript = this.parserScript(html)
    this.oldEtag = await this.getEtag()
  }
 // 獲取html
  async getHtml() {
    const html = await fetch('/').then((res) => res.text())
    return html
  }
  // 獲取etag是否變化
  async getEtag() {
    const res = await fetch('/')
    return res.headers.get('etag')
  }
  // 解析script標簽
  parserScript(html: string) {
    const reg = /<script(?:\s+[^>]*)?>(.*?)<\/script\s*>/gi
    return html.match(reg) as string[]
  }
  // 訂閱
  on(key: 'update', fn: () => void) {
    ;(this.dispatch[key] || (this.dispatch[key] = [])).push(fn)
    return this
  }
  // 停止
  pause() {
    this.stop = !this.stop
  }
    
  get value() {
    return {
      oldEtag: this.oldEtag,
      newEtag: this.newEtag,
      oldScript: this.oldScript,
      newScript: this.newScript,
    }
  }
  // 兩層對比有任一個變化即可
  compare() {
    if (this.stop) return
    const oldLen = this.oldScript.length
    const newLen = Array.from(
      new Set(this.oldScript.concat(this.newScript))
    ).length
    if (this.oldEtag !== this.newEtag || newLen !== oldLen) {
      this.dispatch.update.forEach((fn) => {
        fn()
      })
    }
  }
 // 檢查更新 
  async check() {
    const newHtml = await this.getHtml()
    this.newScript = this.parserScript(newHtml)
    this.newEtag = await this.getEtag()
    this.compare()
  }
}

export const monitor = new Monitor()

// 路由前置守衛中調用
import { monitor } from './monitor'

monitor.on('update', () => {
  console.log('更新數據', monitor.value)
  Modal.confirm({
    title: '更新提示',
    icon: createVNode(ExclamationCircleOutlined),
    content: '版本有更新，是否刷新頁面！',
    okText: '刷新',
    cancelText: '不刷新',
    onOk() {
      // 更新操作
      location.reload()
    },
    onCancel() {
      monitor.pause()
    },
  })
})

router.beforeEach((to, from, next) => {
    monitor.check()
})

3.2 websocket方式

既然後端不好溝通，那就自己實現一個完整版。

具體流程如下：

3.2.1 代碼實現

服務端使用koa實現：

// 引入依賴 koa koa-router koa-websocket short-uuid koa2-cors
const Koa = require('koa')
const Router = require('koa-router')
const websockify = require('koa-websocket')
const short = require('short-uuid')
const cors = require('koa2-cors')

const app = new Koa()
// 使用koa2-cors中間件解決跨域
app.use(cors())

const router = new Router()

//  使用 koa-websocket 將應用程式升級為 WebSocket 應用程式
const appWebSocket = websockify(app)

// 存儲所有連接的客戶端進行去重處理
const clients = new Set()

// 處理 WebSocket 連接
appWebSocket.ws.use((ctx, next) => {
  // 存儲新連接的客戶端
  clients.add(ctx.websocket)
  // 處理連接關閉事件
  ctx.websocket.on('close', () => {
    clients.delete(ctx.websocket)
  })
  ctx.websocket.on('message', (data) => {
    ctx.websocket(666)//JSON.stringify(data)
  })
  ctx.websocket.on('error', (err) => {
     clients.delete(ctx.websocket)
  })

  return next(ctx)
})

// 處理外部通知頁面更新的介面
router.get('/api/webhook1', (ctx) => {
  // 向所有連接的客戶端發送消息,使用uuid確保不重覆
  clients.forEach((client) => {
    client.send(short.generate())
  })
  ctx.body = 'Message pushed successfully!'
})

// 將路由註冊到應用程式
appWebSocket.use(router.routes()).use(router.allowedMethods())

// 啟動伺服器
appWebSocket.listen(3000, () => {
  console.log('Server started on port 3000')
})

前端頁面代碼：

websocket使用vueuse封裝的，保持個心跳。

import { useWebSocket } from '@vueuse/core'

const { open, data } = useWebSocket('ws://dev.shands.cn/ws', {
  heartbeat: {
    message: 'ping',
    interval: 5000,
    pongTimeout: 10000,
  },
  immediate: true, // 自動連接
  autoReconnect: {
    retries: 6,
    delay: 3000,
  },
})


watch(data, (val) => {
  if (val.length !== '3HkcPQUEdTpV6z735wxTum'.length) return
  Modal.confirm({
    title: '更新提示',
    icon: createVNode(ExclamationCircleOutlined),
    content: '版本有更新，是否刷新頁面！',
    okText: '刷新',
    cancelText: '不刷新',
    onOk() {
     // 更新操作
      location.reload()
    },
    onCancel() {},
  })
})

// 建立連接
onMounted(() => {
  open()
})
// 斷開鏈接
onUnmounted(() => {
  close()
})

3.2.2 發佈部署

後端部署：

考慮伺服器上沒有安裝node環境，直接使用docker進行部署，使用pm2運行node程式。

  1. 寫一個DockerFile，發佈鏡像
// Dockerfile:

# 使用 Node.js 作為基礎鏡像
FROM node:14-alpine

# 設置工作目錄
WORKDIR /app

# 複製 package.json 和 package-lock.json 到容器中
COPY package.json ./

# 安裝項目依賴
RUN npm install
RUN npm install -g pm2

# 複製所有源代碼到容器中
COPY . .

# 暴露埠號
EXPOSE 3000

# 啟動應用程式
CMD ["pm2-runtime","app.js"]

本地進行打包鏡像發送到docker hub，使用docker build -t f5l5y5/websocket-server-image:v0.0.1 .命令生成鏡像文件，使用docker push f5l5y5/websocket-server-image:v0.0.1 推送到自己的遠程倉庫

  1. 伺服器拉取鏡像，運行

拉取鏡像：docker pull f5l5y5/websocket-server-image:v0.0.1

運行鏡像: docker run -d -p 3000:3000 --name websocket-server f5l5y5/websocket-server-image:v0.0.1

可進入容器內部查看：docker exec -it <container_id> sh # 使用 sh 進入容器

查看容器運行情況：

 進入容器內部查看程式運行情況，pm2常用命令

此時訪問/api/webhook1會找到項目的對應路由下，需要配置下nginx代理轉發

  1. 配置nginx介面轉發
map $http_upgrade $connection_upgrade {
    default upgrade;
    ''      close;
  }
server {
        listen     80;
        server_name  test-pms.shands.cn;
        client_max_body_size 50M;

        location / {
            root /usr/local/openresty/nginx/html/test-pms-admin;
            try_files $uri $uri/ /index.html;
        }
        // 將觸發的更新代理到容器的3000
        location /api/webhook1 {
         proxy_pass http://localhost:3000/api/webhook1;
         proxy_set_header Host $host;
         proxy_set_header X-Real-IP $remote_addr;
        }
        // websocket 配置
        location /ws {
          # 反向代理到容器中的WebSocket介面
          proxy_pass http://localhost:3000;
          # 支持WebSocket協議
          proxy_http_version 1.1;
          proxy_set_header Upgrade $http_upgrade;
          proxy_set_header Connection "Upgrade";
        }       
}

3.2.3 測試

url請求api/webhook即可

4. 總結

主要實踐下兩種方案：

  1. 輪詢調用方案：輪詢獲取網頁引入的腳本文件的hash值或者etag來實現。這種方案的優點是實現簡單，但存在性能消耗和延遲較高的問題。

  2. WebSocket版本方案：在前端部署的同時建立一個WebSocket連接，將後端構建部署完成的通知發送給前端。當後端完成部署後，通過WebSocket向前端發送消息，提示用戶刷新頁面以載入最新版本。這種方案的優點是實時性好，用戶體驗較好，但需要在前端和後端都進行相應的配置和代碼開發。

本文轉載於:

https://juejin.cn/post/7264396960558399549

如果對您有所幫助，歡迎您點個關註，我會定時更新技術文檔，大家一起討論學習，一起進步。

 


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • 使用GParted-live對Ubuntu進行分區
    GParted-live下載官網：https://gparted.org/download.php 1、用Rufus製作gparted-live啟動盤（Windows） Rufus下載官網：https://rufus.ie 2、 用Unetbootin製作gparted-live啟動盤（Window ...
  • 選讀SQL經典實例筆記19_Any和All
    ![](https://img2023.cnblogs.com/blog/3076680/202308/3076680-20230804113710206-1765431897.png) # 1. Any ## 1.1. 任意一個 ## 1.2. 選修了任意一門課程的學生 ### 1.2.1. 找出 ...
  • mysql備份恢復(mysqldump備份 mysqlbinlog恢復)
    # mysql備份恢復(mysqldump備份 mysqlbinlog恢復) ## 一、備份的分類 1. 物理備份 ​ 物理備份:對資料庫操作系統的物理文件(如數據文件、日誌文件等) - 冷備份(離線備份) :是在關閉資料庫的時候進行的 - 熱備份(聯機備份) :資料庫處於運行狀態，依賴於資料庫的日 ...
  • 2023-8-7 記錄一次面試題，使用Sql進行遞歸
    本文分享自華為雲社區《【帶你走進DWS大集群內幕】大集群通信：作業hang、殘留問題定位》，作者： 雨落天穹丶。 前言： 測試過程中，我們會遇到這樣一種情況，我的作業都執行很久了，為啥還不結束，是不是作業hang掉了？ 或者說，明明看到CN上的作業都沒了，為什麼通過全局視圖發現DN上還有作業在執行而 ...
  • MySQL Execution Plan -- IN條件與ORDER BY組合優化
    基於本次618大促JDV平臺支持大促過程中的表現，共從大促總結、能力沉澱、待提升項3個方向也進行了相應總結和反思。 ...
  • 使用SQL 統計表最大值，最小值，平均值，中位數值
    > 問：有一個postgres數據表，表中有update_time, create_time關於時間戳的欄位，選擇某個時間段，計算出update_time減去create_time的值做為耗時時間的欄位duration_time，統計出在這段時間內耗時時間的平均值，中位數值，最大值，和最小值，請問如 ...
  • 發佈關於PostGIS對於USD格式的拓展
    我們非常高興的發佈為了一年一度的SIGGRAPH 2023發佈關於為PostGIS支持USD格式的新拓展。 新添加了3個函數 ST_AsUSDA(geom geometry, usd_root_name text, usd_geom_name text, width float) ST_AsUSDC ...
  • ios 自製Framework 獲取指定bundle並讀取裡面的資源
    原文地址：https://zhanglei.blog.csdn.net/article/details/121673288 [toc] ## 一、前言 應用中某些模塊需要組件化，組件化後的工程最後會做二進位化處理，打包成`.framework`文件。 今天簡單聊一下在主工程或其他組件中是如何訪問自製 ...
一周排行
    -Advertisement-
    Play Games
  • 移動開發（一）：使用.NET MAUI開發第一個安卓APP
    移動開發（一）：使用.NET MAUI開發第一個安卓APP 對於工作多年的C#程式員來說，近來想嘗試開發一款安卓APP，考慮了很久最終選擇使用.NET MAUI這個微軟官方的框架來嘗試體驗開發安卓APP，畢竟是使用Visual Studio開發工具，使用起來也比較的順手，結合微軟官方的教程進行了安卓 ...
  • wpf ToggleButton選中效果和一個登錄界面
    前言 QuestPDF 是一個開源 .NET 庫，用於生成 PDF 文檔。使用了C# Fluent API方式可簡化開發、減少錯誤並提高工作效率。利用它可以輕鬆生成 PDF 報告、發票、導出文件等。 項目介紹 QuestPDF 是一個革命性的開源 .NET 庫，它徹底改變了我們生成 PDF 文檔的方 ...
  • 彈幕樹洞項目功能新增篇
    項目地址 項目後端地址： https://github.com/ZyPLJ/ZYTteeHole 項目前端頁面地址： ZyPLJ/TreeHoleVue (github.com) https://github.com/ZyPLJ/TreeHoleVue 目前項目測試訪問地址： http://tree ...
  • 第27篇 sqlserver2022詳細安裝步驟
    話不多說，直接開乾 一.下載 1.官方鏈接下載： https://www.microsoft.com/zh-cn/sql-server/sql-server-downloads 2.在下載目錄中找到下麵這個小的安裝包 SQL2022-SSEI-Dev.exe，運行開始下載SQL server； 二. ...
  • .NET 開源高性能 MQTT 類庫
    前言 隨著物聯網（IoT）技術的迅猛發展，MQTT（消息隊列遙測傳輸）協議憑藉其輕量級和高效性，已成為眾多物聯網應用的首選通信標準。 MQTTnet 作為一個高性能的 .NET 開源庫，為 .NET 平臺上的 MQTT 客戶端與伺服器開發提供了強大的支持。 本文將全面介紹 MQTTnet 的核心功能 ...
  • Serilog文檔翻譯系列（六） - 可用的接收器、增強器、格式化輸出
    Serilog支持多種接收器用於日誌存儲，增強器用於添加屬性，LogContext管理動態屬性，支持多種輸出格式包括純文本、JSON及ExpressionTemplate。還提供了自定義格式化選項，適用於不同需求。 ...
  • 警惕 Visual Studio 屬性求值副作用導致邏輯不符合預期
    目錄簡介獲取 HTML 文檔解析 HTML 文檔測試參考文章 簡介 動態內容網站使用 JavaScript 腳本動態檢索和渲染數據，爬取信息時需要模擬瀏覽器行為，否則獲取到的源碼基本是空的。 本文使用的爬取步驟如下： 使用 Selenium 獲取渲染後的 HTML 文檔 使用 HtmlAgility ...
  • [使用目前最新版]HybridCLR6.9.0+YooAsset2.2.4實現純C# Unity熱更新方案 (一)
    1.前言 什麼是熱更新 游戲或者軟體更新時，無需重新下載客戶端進行安裝，而是在應用程式啟動的情況下，在內部進行資源或者代碼更新 Unity目前常用熱更新解決方案 HybridCLR，Xlua，ILRuntime等 Unity目前常用資源管理解決方案 AssetBundles，Addressable， ...
  • 在 ASP.NET Core Web API 中使用操作篩選器統一處理通用操作
    本文章主要是在C# ASP.NET Core Web API框架實現向手機發送驗證碼簡訊功能。這裡我選擇是一個互億無線簡訊驗證碼平臺，其實像阿裡雲，騰訊雲上面也可以。 首先我們先去 互億無線 https://www.ihuyi.com/api/sms.html 去註冊一個賬號 註冊完成賬號後，它會送 ...
  • 第28篇 如何.net中實現高效可靠數據同步api
    通過以下方式可以高效，並保證數據同步的可靠性 1.API設計 使用RESTful設計，確保API端點明確，並使用適當的HTTP方法（如POST用於創建，PUT用於更新）。 設計清晰的請求和響應模型，以確保客戶端能夠理解預期格式。 2.數據驗證 在伺服器端進行嚴格的數據驗證，確保接收到的數據符合預期格 ...
所有分類