一. 简介
在上一篇文章Vite+Electron快速构建一个VUE3桌面应用中,我们了解了如何使用Vite
和Electron
来快速构建一个Vue3桌面应用。但是,之前构建的应用仅仅是一个简单的版本。在开发过程中,为了更好的开发体验,在开发electron的时候,肯定也希望能有动态模块热重载(HMR),更别说vite那迅雷不及掩耳盗铃儿响叮当之势的加载速度。
因此,接着上一篇文章所完成的项目代码,我们来完成Vite
和Electron
开发时的动态模块热重载功能。
二. 思路
先说结论,可利用electron中的mainWindow.loadURL(<your-url>)
来实现。
对于动态模块热重载功能来说,无论是webpack还是vite,其都是将构建内容存入内存,因此我们无法使用mainWindow.loadFile('dist/index.html')
这样加载文件的方式。
但是,单纯地改变该配置也是不行的,需要使用vite将开发服务器运行起来,可以正常运行动态模块热重载,而electron直接加载其开发服务器可访问的url,即http://localhost:3000
。
三. 实现步骤
1. 编辑main.js
将mainWindow.loadFile('dist/index.html')
更新为mainWindow.loadURL("http://localhost:3000")
,更新后的文件如下所示:
TypeScript
// main.js
// 控制应用生命周期和创建原生浏览器窗口的模组
const { app, BrowserWindow } = require('electron')
const path = require('path')
function createWindow () {
// 创建浏览器窗口
const mainWindow = new BrowserWindow({
width: 800,
height: 600,
webPreferences: {
preload: path.join(__dirname, 'preload.js')
}
})
// 加载 index.html
// mainWindow.loadFile('dist/index.html') 将该行改为下面这一行,加载url
mainWindow.loadURL("http://localhost:3000")
// 打开开发工具
// mainWindow.webContents.openDevTools()
}
// 这段程序将会在 Electron 结束初始化
// 和创建浏览器窗口的时候调用
// 部分 API 在 ready 事件触发后才能使用。
app.whenReady().then(() => {
createWindow()
app.on('activate', function () {
// 通常在 macOS 上,当点击 dock 中的应用程序图标时,如果没有其他
// 打开的窗口,那么程序会重新创建一个窗口。
if (BrowserWindow.getAllWindows().length === 0) createWindow()
})
})
// 除了 macOS 外,当所有窗口都被关闭的时候退出程序。 因此,通常对程序和它们在
// 任务栏上的图标来说,应当保持活跃状态,直到用户使用 Cmd + Q 退出。
app.on('window-all-closed', function () {
if (process.platform !== 'darwin') app.quit()
})
// 在这个文件中,你可以包含应用程序剩余的所有部分的代码,
// 也可以拆分成几个文件,然后用 require 导入。
2. 编辑vite.config.js
修改文件vite.config.js
的base
,修改后的文件如下所示:
TypeScript
// vite.config.js
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
// https://vitejs.dev/config/
export default defineConfig({
base: "./", // 新增
plugins: [vue()]
})
3. 同时开启vite和electron服务
为了使vite和electron正常运行,需要先运行vite,使得其开发服务器的url可以正常访问,然后再开启electron去加载url。
此处需要安装两个库:
- concurrently :阻塞运行多个命令,
-k
参数用来清除其它已经存在或者挂掉的进程 - wait-on:等待资源,此处用来等待url可访问
首先来安装。
yarn add -D concurrently wait-on
接着更新文件package.json
,scripts
新增两条命令:
TypeScript
"scripts": {
"electron": "wait-on tcp:3000 && electron .",
"electron:serve": "concurrently -k \"yarn dev\" \"yarn electron\""
},
更新后完整内容如下:
TypeScript
{
"name": "kuari",
"version": "0.0.0",
"main": "main.js",
"scripts": {
"dev": "vite",
"build": "vite build",
"serve": "vite preview",
"electron": "wait-on tcp:3000 && electron .",
"electron:serve": "concurrently -k \"yarn dev\" \"yarn electron\""
},
"dependencies": {
"vue": "^3.2.16"
},
"devDependencies": {
"@vitejs/plugin-vue": "^1.9.3",
"concurrently": "^6.3.0",
"cross-env": "^7.0.3",
"electron": "^15.1.2",
"vite": "^2.6.4",
"wait-on": "^6.0.0"
}
}
四. 运行
现已添加两条命令:
yarn electron
为等待tcp协议3000端口可访问,然后执行electronyarn electron:serve
为阻塞执行开发服务器运行和yarn electron
命令
运行项目只要执行命令yarn electron:serve
即可,当修改项目文件时,桌面应用也将自动更新。