Vite+Vue3实现版本更新检查,实现页面自动刷新
vue
vuejs/vue: 是一个用于构建用户界面的 JavaScript 框架,具有简洁的语法和丰富的组件库,可以用于开发单页面应用程序和多页面应用程序。
项目地址:https://gitcode.com/gh_mirrors/vu/vue
免费下载资源
·
Vite+Vue3实现版本更新检查,实现页面自动刷新
现有一个需求就是实现管理系统的版本发版,网页实现自动刷新页面获取最新版本
搜索了一下,轮询的方案有点浪费资源,不太适合我的
现在使用了路由跳转的方式去实现 这里有个大佬
就是在每次打包的时候生成一个version.json版本信息文件,在页面跳转的时候请求服务端的version.json的版本号和浏览器本地的版本号对比,进行监控版本的迭代更新,并对页面进行更新
1、使用Vite插件打包自动生成版本信息
Vite插件即是Vite虚拟模块, Vite 沿用 Rollup 的虚拟模块官网有解释(第一次了解到Vite虚拟模块)
这里的文件位置为 /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);
});
}
},
};
};
2、Vite.config.ts配置
define全局变量配置,不懂可以看看这个
import versionUpdatePlugin from './src/utils/versionUpdatePlugin'; //Rollup 的虚拟模块
// 打包时获取版本信息
const CurrentTimeVersion = new Date().getTime();
const viteConfig = defineConfig((config) => {
const now = new Date().getTime()
return {
...
define: {
// 定义全局变量
'process.env.VITE__APP_VERSION__': CurrentTimeVersion,
},
plugins: [
...
versionUpdatePlugin({
version: CurrentTimeVersion,
}),
],
...
}
})
3、配置环境变量
环境变量分开了,没有直接放在 .env中
//development 和 production
# 版本
VITE__APP_VERSION__ = ''
4、路由配置
路由跳转是自动检测版本,有新版本则自动更新页面
// 版本监控
const versionCheck = async () => {
//import.meta.env.MODE 获取的是开发还是生产版本的
if (import.meta.env.MODE === 'development') return;
const response = await axios.get('version.json');
// eslint-disable-next-line no-undef
//process.env.VITE__APP_VERSION__ 获取环境变量设置的值,判断是否与生成的版本信息一致
if (process.env.VITE__APP_VERSION__ !== response.data.version) {
// eslint-disable-next-line no-undef
ElMessage({
message: '发现新内容,自动更新中...',
type: 'success',
showClose: true,
duration: 1500,
onClose: () => {
window.location.reload();
},
});
}
};
// 这里在路由全局前置守卫中检查版本
router.beforeEach(async () => {
await versionCheck()
})
打包自动修改package.json 的version
还是用到Vite虚拟模块
贴代码
// versionUpdatePlugin.js
import fs from 'fs';
import path from 'path';
function handleType(oldVersion: string, type: string = 'release') {
var oldVersionArr = oldVersion.split('.');
//版本号第一位 如:1.2.3 则为 1
var firstNum = +oldVersionArr[0];
//版本号第二位 如:1.2.3 则为 2
var secondNum = +oldVersionArr[1];
//版本号第三位 如:1.2.3 则为 3
var thirdNum = +oldVersionArr[2];
switch (type) {
case 'release':
//release分支的处理逻辑
++secondNum;
thirdNum = 0;
break;
case 'hotfix':
//hotfix分支的处理逻辑
++thirdNum;
break;
default:
// 默认按照最小版本处理
++thirdNum;
break;
}
return firstNum + '.' + secondNum + '.' + thirdNum;
}
export default () => {
return {
name: 'version-update',
buildStart() {
if (process.env.NODE_ENV === "development") return
const url = path.join(process.cwd(), 'package.json');
const json = fs.readFileSync(url, 'utf-8');
const pkg = JSON.parse(json);
// hotfix: 最小版本更新 release:穩定版本
const version = handleType(pkg.version, 'hotfix');
pkg.version = version
fs.writeFileSync('package.json', JSON.stringify(pkg, null, 2));
},
};
};
//vite.config.ts
define: {
__NEXT_VERSION__: JSON.stringify(process.env.npm_package_version),
},
剩下的就是在APP.vue上做版本的检测,不同则弹出更新提示
// 版本监控
const versionCheck = async () => {
if (import.meta.env.MODE === 'development') return;
if (route.path !== '/login') {
state.getVersion = false;
// @ts-ignore
let nextVersion = __NEXT_VERSION__;
const response = await axios.get(`version.json?${Date.now()}`);
const localVersion = Local.get('version');
console.log('R', response.data.version);
console.log('N', nextVersion);
console.log('L', localVersion);
if (response.data.version !== nextVersion && (response.data.version !== localVersion || nextVersion !== localVersion)) {
state.resVersion = response.data.version;
state.getVersion = true;
// Local.set('version', response.data.version);
}
}
};
//之前忘记贴代码了
//这是我自己的,暂时没出现问题,仅供参考
继续多学习…
GitHub 加速计划 / vu / vue
207.54 K
33.66 K
下载
vuejs/vue: 是一个用于构建用户界面的 JavaScript 框架,具有简洁的语法和丰富的组件库,可以用于开发单页面应用程序和多页面应用程序。
最近提交(Master分支:2 个月前 )
73486cb5
* chore: fix link broken
Signed-off-by: snoppy <michaleli@foxmail.com>
* Update packages/template-compiler/README.md [skip ci]
---------
Signed-off-by: snoppy <michaleli@foxmail.com>
Co-authored-by: Eduardo San Martin Morote <posva@users.noreply.github.com> 4 个月前
e428d891
Updated Browser Compatibility reference. The previous currently returns HTTP 404. 5 个月前
更多推荐
已为社区贡献2条内容
所有评论(0)