webpack、vite增加系统版本号插件,自动更新网页

1、vite.config中增加版本号生成插件

在/src/utils文件夹中添加versionUpdatePlugin.ts文件

//简易Ts版
// versionUpdatePlugin.js
import fs from 'fs';
import path from 'path';
interface OptionVersion {
    version: number | string;
}
interface configObj extends Object {
    publicDir: string;
}

const writeVersion = (versionFileName: string, content: string | NodeJS.ArrayBufferView) => {
    // 写入文件
    fs.writeFile(versionFileName, content, (err) => {
        if (err) throw err;
    });
};

export default (options: OptionVersion) => {
    let config: configObj = { publicDir: '' };
    return {
        name: 'version-update',
        configResolved(resolvedConfig: configObj) {
            // 存储最终解析的配置
            config = resolvedConfig;
        },
        buildStart() {
            // 生成版本信息文件路径
            const file = config.publicDir + path.sep + 'version.json';
            // 这里使用编译时间作为版本信息
            const content = JSON.stringify({ version: options.version });
            if (fs.existsSync(config.publicDir)) {
                writeVersion(file, content);
            } else {
                fs.mkdir(config.publicDir, (err) => {
                    if (err) throw err;
                    writeVersion(file, content);
                });
            }
        },
    };
};

在vite.config中添加如下代码,编译的时候会是生成当前版本version.json文件在根目录

import versionUpdatePlugin from "./src/utils/versionUpdatePlugin";

//版本时间戳
const CurrentTimeVersion = new Date().getTime();
export default defineConfig(({ mode }: ConfigEnv): UserConfig => {
  return {
    define: {
      // 定义全局变量
      "process.env.VITE__APP_VERSION__": CurrentTimeVersion,
    },
    plugins: [
      ...
    versionUpdatePlugin({
        version: CurrentTimeVersion,
      }),
    ]
  }
});

在/router/index.ts中添加版本监控代码

import axios from "axios";
// 版本监控
const versionCheck = async () => {
  if (import.meta.env.MODE === 'dev') return;
  if(!process.env.VITE__APP_VERSION__) return;
  const response = await axios.get(`${window.location.origin}/version.json`)
  // eslint-disable-next-line no-undef
  if (process.env.VITE__APP_VERSION__ !== response.data.version) {
    window.location.reload()
  }
}

router.afterEach(async (to, from, next) => {
  //在页面跳转之后如果更新版本了,就刷新当前页面
  //如果需要在跳转之前进行刷新,就在router.beforeEach中进行调用
  versionCheck();
});

在相应的环境(.env、.env.dev、.env.pro)里面添加版本参数

VITE__APP_VERSION__ = ''

2、webpack中添加versionUpdatePlugin插件

主要是部分项目vue2使用的vue.config,里面的打包工具用的webpack,为了兼容旧项目,增加了插件进行打包。
在/src/utils中添加versionUpdatePlugin.js插件

//简易版
// versionUpdatePlugin.js

const fs = require("fs");
const path = require("path");

const writeVersion = (versionFileName, content) => {
  // 写入文件
  fs.writeFile(versionFileName, content, (err) => {
    if (err) throw err;
  });
};

function versionUpdatePlugin(options) {
  this.options = options;
}

versionUpdatePlugin.prototype.apply = function (compiler) {
  console.log(compiler, "done", this.options);
  compiler.plugin("done", () => {
    let config = { publicDir: compiler.options.output.path };
    // 生成版本信息文件路径
    const file = config.publicDir + path.sep + "version.json";
    // 这里使用编译时间作为版本信息
    const content = JSON.stringify({ version: this.options.version });
    if (fs.existsSync(config.publicDir)) {
      writeVersion(file, content);
    } else {
      fs.mkdir(config.publicDir, (err) => {
        if (err) throw err;
        writeVersion(file, content);
      });
    }
  });
};

module.exports = versionUpdatePlugin;

在vue.config中添加

const versionUpdatePlugin = require("./src/utils/versionUpdatePlugin");
let timeStamp = new Date().getTime();

module.exports = {
  ...
  configureWebpack: (config) => {
    if(process.env.NODE_ENV === "development"){
      const plugins = [];
      // 版本
      plugins.push(
        new versionUpdatePlugin({
          version: timeStamp,
        })
      );
    }
  config.plugins = [...config.plugins, ...plugins];
  },
  chainWebpack(config) {
    config.plugin('define').tap(args => {
      args[0]['process.env'].APP_VERSION = `${timeStamp}`;
      return args
    });
  }
}

在/src/router/index.js中添加

import axios from "axios";
// 版本监控
const versionCheck = async () => {
  console.log('build time:', process.env.APP_VERSION, process.env.NODE_ENV === "development");
  if (process.env.NODE_ENV == "development") return
  const response = await axios.get('version.json')
  // eslint-disable-next-line no-undef
  if (process.env.APP_VERSION !== response.data.version) {
    window.location.reload()
  }
}

router.beforeEach((to, from, next) => {
  next();
  versionCheck();
});

以上2种方法会在遇到版本不同时进行页面自动刷新。

附录:
https://blog.csdn.net/qq_39448719/article/details/106369224
https://blog.csdn.net/qwe134133987/article/details/127979312

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343

推荐阅读更多精彩内容