[目錄]
背景
引申問題
思路
使用示例

• Env添加版本變量
• 插件代碼
• 配置文件中引入VersionPlugin
• 驗證版本號并處理
• Shell終端執(zhí)行打包

優(yōu)化

• 如何通過編譯指令指定版本號？
• 其他插件
  其他處理緩存方式及問題
  參考文章

[TAG]:

• Vue
• JavaScript
• Webpack Plugin
• 自動版本號
• 微信緩存更新

背景

微信H5開發(fā)中，遇到了問題：

• 微信H5對Index.html緩存問題，使得提測過程中、發(fā)布Release版本后，用戶端看到的頁面依舊是緩存的html/js/cs
• 在JavaScrip文件分包情況下，項目重新打包后，由于發(fā)布時清除了原js文件，如果html已緩存，就會出現(xiàn)加載不到j(luò)s的錯誤
• 由于需求和測試需要，支付渠道需要切換，每次為了一個配置參數(shù)卻需要反復(fù)提交TAG

引申問題

• 版本號如何自動生成？能否指定版本號？
• 如何獲取版本號等配置？通過Service服務(wù)器API獲取就會對Service侵入——接口同學(xué)要是善良尚可，要是......

思路

本著自己的問題自己解決，既然前端都是服務(wù)器在跑，那就直接提供個配置訪問文件，打包時復(fù)制一份豈不快哉。但是每次提測、發(fā)布都還得手動修改版本？怎么行？通過Webpack Plugin、運(yùn)行腳本自動生成吧。

前提: js等文件需要通過hash配置文件名，否則在微信緩存過期前貌似只能通過手動清理緩存處理。文件名配置參考

使用示例

Env添加版本變量

// 示例 
// 文件：/config/prod.env.js
module.exports = {
  NODE_ENV: '"production"',
  VERSION:'"v1.0 [' + new Date().toLocaleString() + ']"'
}
// 文件：/config/dev.env.js
module.exports = merge(prodEnv, { // 這里使用了merge, 為了后續(xù)判斷所以需要設(shè)置空字符串
  NODE_ENV: '"development"',
  VERSION: '""', // 開發(fā)環(huán)境置空才不會判斷版本，因為開發(fā)環(huán)境未配置自動生成版本配置信息
}
// 文件：/config/index.js
module.exports = {
  dev: { ... },
  build: { env: require('./prod.env') }
}

插件代碼

'use strict';

var FStream = require('fs');

/**
 * 版本信息生成插件
 * @author phpdragon@qq.com
 * @param options
 * @constructor
 */
function VersionPlugin(options) {
  this.options = options || {};
  !this.options.versionDirectory && (this.options.versionDirectory = 'static');
}

// apply方法是必須要有的，因為當(dāng)我們使用一個插件時（new somePlugins({})），webpack會去尋找插件的apply方法并執(zhí)行
VersionPlugin.prototype.apply = function (compiler) {
  var self = this;
  compiler.plugin("compile", function (params) {
    var dir_path = this.options.context + '/' + self.options.versionDirectory;
    var version_file = dir_path + '/version.json';
    var content = '{"version":' + self.options.env.VERSION + '}';
    FStream.exists(dir_path, function (exist) {
      if (exist) {
        writeVersion(self, version_file, content);
        return;
      }
      FStream.mkdir(dir_path, function (err) {
        if (err) throw err;
        console.log('\n創(chuàng)建目錄[' + dir_path + ']成功');
        writeVersion(self, version_file, content);
      });
    });
  });
  //編譯器'對'所有任務(wù)已經(jīng)完成'這個事件的監(jiān)聽
  compiler.plugin("done", function (stats) {
    console.log("應(yīng)用編譯完成！");
  });
};

const writeVersion = (self, versionFile, content) => {
  console.log("\n當(dāng)前版本號：" + self.options.env.VERSION);
  console.log("開始寫入版本信息...");
  //寫入文件
  FStream.writeFile(versionFile, content, function (err) {
    if (err) throw err;
    console.log("版本信息寫入成功!");
  });
}

module.exports = VersionPlugin;

• 此插件代碼來源于下文參考文章，插件開發(fā)參考如何編寫一個插件？

配置文件中引入VersionPlugin

// 文件：/build/webpack.prod.conf.js
const config = require('../config');
const VersionPlugin = require('./version-plugin');
const webpackConfig = merge(baseWebpackConfig, {
  plugins: [
    new VersionPlugin({ path: config.build.assetsRoot, env: config.build.env, versionDirectory: 'static'}),
  ]
}

驗證版本號并處理

// 項目配置的入口文件，如文件：./src/main.js
import Vue from 'vue';
import router from './router';
import axios from 'axios';
import { ToastPlugin } from 'vux';
/** 
  * 〖Author〗 MiWi.LIN ＾＾＾＾〖E-mail〗 80383585@qq.com
  *  Copyright(c) 2018/12/28
  * 〖Version〗 1.0
  * 〖Date〗 2018/12/28_上午10:45
  */ 
const { VERSION } = process.env;

Vue.use(ToastPlugin);

function ifVersionCorrect(to, from, next) {
    ...
    next(); // 不適合調(diào)用參數(shù), 如next('/')會出現(xiàn)死循環(huán)，原因在于參數(shù)情況下會第二次執(zhí)行router.beforeEach的回調(diào)函數(shù)
}

function checkVersion(to, from, next) {
  console.info('當(dāng)前版本：', VERSION);
  axios.get(`../static/version.json?_=${Math.random()}`).then((response) => { // 訪問前端服務(wù)器獲取版本號
    if (response.status === 200 && VERSION !== response.data.version) {
      Vue.$vux.toast.text('發(fā)現(xiàn)新版本，自動更新中...');
      console.info('新版本：', response.data.version);
      setTimeout(() => {
        location.reload(true);
      }, 500);
      return;
    }
    ifVersionCorrect(to, from, next);
  }).catch((err) => {
    console.error('checkVersion', err);
    ifVersionCorrect(to, from, next);
  });
}

router.beforeEach((to, from, next) => {
  // 未匹配路由跳轉(zhuǎn)到首頁
  if (!to.name) {
    next({ name: 'index' });
    return;
  }
  if (VERSION && to.name === 'index') { // VERSION在prod.env中配置，作為區(qū)分生產(chǎn)環(huán)境
    checkVersion(to, from, next);
  } else {
    ifVersionCorrect(to, from, next);
  }
});

• 這里只對進(jìn)入Index時校驗版本，所以相關(guān)邏輯也可以在首頁Index.vue中做處理

Shell終端執(zhí)行打包

> npm run build
當(dāng)前版本號："v1.0 [2018-12-28 10:00:41]"
開始寫入版本信息...
版本信息寫入成功!

優(yōu)化

如何通過編譯指令指定版本號？

// 文件：/config/prod.env.js
module.exports = {
  NODE_ENV: '"production"',
  VERSION: JSON.stringify(process.env.VERSION_ENV) || '"v1.0 [' + new Date().toLocaleString() + ']"'
}
// 文件: /package.json
{
  "scripts": {
  "build:2": "cross-env VERSION_ENV=v2.0 webpack --config build/build.js"
  }
}

Shell終端執(zhí)行打包

> npm run build:2

說明

• 如不配置build:2，可在終端中直接輸入指令內(nèi)容, 實時動態(tài)設(shè)置版本，嫌指令太長？去看看Shell終端的alais配置...
• 這樣就可以通過process.env.VERSION_ENV獲取到值v2.0
• 關(guān)于cross-env可以參考使用cross-env解決跨平臺設(shè)置NODE_ENV的問題，主要是解決不同系統(tǒng)環(huán)境指令兼容問題
• 如不使用cross-env，可通過process.argv獲取指令參數(shù)，方式參考：

for (var i in process.argv) {
  if (process.argv[i] === "--production") { ... }
}
// 或 process.argv.includes('--production')

其他插件

使用webpack進(jìn)行版本管理工具(webpack-plugin-auto-version)_GitHub
versiony-自動修改package.json中項目版本號

其他處理緩存方式及問題

方式一：

修改服務(wù)器nginx no-cache配置，需要運(yùn)營配置(沒試過...)

方式二：

Index.html中配置no-cache：

<html manifest="IGNORE.manifest">  <!--靜態(tài)html文件遇到微信緩存而無法及時更新,html標(biāo)簽中增加不存在的manifest文件鏈接-->
<!--no-cache相關(guān)-->
<!--no-cache瀏覽器會緩存，但刷新頁面或者重新打開時 會請求服務(wù)器，服務(wù)器可以響應(yīng)304，如果文件有改動就會響應(yīng)200-->
<meta http-equiv="cache-control" content="max-age=0" />
<meta http-equiv="cache-control" content="no-cache" />
<meta http-equiv="expires" content="0" />
<meta http-equiv="expires" content="Tue, 01 Jan 1980 1:00:00 GMT" />
<meta http-equiv="pragma" content="no-cache" />

存在問題：
- IGNORE.manifest 會引起500錯誤，使用時存在個別機(jī)型、微信版本無效，仍使用緩存文件，還得手動刷新
- 不能解決上文提到的分包問題

方式三：

Cache Buster方式: route url添加版本號或隨機(jī)數(shù)

如：/index.html?v=1#/list

存在問題：
- 在項目業(yè)務(wù)中，跳轉(zhuǎn)微信或其他第三方頁面后，原邏輯可能會使參數(shù)失效，返回原緩存頁面，加載微信中已緩存的舊邏輯
- 還是不能解決上文提到的分包問題
- 微信公眾號使用場景中，每次版本發(fā)布得在微信后臺修改URL
- Vue中同一頁面route跳轉(zhuǎn)不會刷新緩存，參考vue-router源碼分析-整體流程

方式四：

上文提到的，需要接口同學(xué)配合。
系統(tǒng)內(nèi)部通過ajax請求獲取版本信息從而提示更新。
存在問題：對后端系統(tǒng)有侵入性，屬于下策。

參考文章

webpack + vue 項目 自定義 插件 解決 前端 JS 版本 更新 問題
Webpack插件開發(fā)簡要
webpack 打包傳參 process.env 公司一個項目多個版本的前端架構(gòu)方案
webpack使用和踩過的坑