Vite+Electron快速构建一个VUE3桌面应用(二)——动态模块热重载

hunter-ji commented 3 years ago

一. 简介

在上一篇文章Vite+Electron快速构建一个VUE3桌面应用中，我们了解了如何使用Vite和Electron来快速构建一个Vue3桌面应用。但是，之前构建的应用仅仅是一个简单的版本。在开发过程中，为了更好的开发体验，在开发electron的时候，肯定也希望能有动态模块热重载（HMR），更别说vite那迅雷不及掩耳盗铃儿响叮当之势的加载速度。

因此，接着上一篇文章所完成的项目代码，我们来完成Vite和Electron开发时的动态模块热重载功能。

源码：https://github.com/Kuari/Blog/tree/master/Examples/vite_electron/vite_electron_2

系列文章：

二. 思路

先说结论，可利用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")，更新后的文件如下所示：

// 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，修改后的文件如下所示：

// 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新增两条命令：

  "scripts": {
    "electron": "wait-on tcp:3000 && electron .",
    "electron:serve": "concurrently -k \"yarn dev\" \"yarn electron\""
  },

更新后完整内容如下：

{
  "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端口可访问，然后执行electron
yarn electron:serve为阻塞执行开发服务器运行和yarn electron命令

运行项目只要执行命令yarn electron:serve即可，当修改项目文件时，桌面应用也将自动更新。

五. 参考文档

13771986136 commented 2 years ago

老哥牛逼，用你的方法顺利跑起来项目了

hunter-ji commented 2 years ago

老哥牛逼，用你的方法顺利跑起来项目了

😄😄😄

KKKZOZ commented 2 years ago

大佬，能帮我看下我写的demo吗...（在main.js中引入自己写的文件时报错）具体就是在background.ts中，第6行的require会报错,说can not find module XXX 我查了一晚上百度和谷歌也不知道为什么... 项目地址： https://github.com/KKKZOZ/system_infomation 报错的位置： https://github.com/KKKZOZ/system_infomation/blob/0a56e369ab65dea30f20fa6760a53aa0bd625243/background.ts#L6 SystemInfoStore内容： https://github.com/KKKZOZ/system_infomation/blob/0a56e369ab65dea30f20fa6760a53aa0bd625243/src/stores/SystemInfoStore.ts#L34 项目结构：

hunter-ji commented 2 years ago

大佬，能帮我看下我写的demo吗...（在main.js中引入自己写的文件时报错）具体就是在background.ts中，第6行的require会报错,说can not find module XXX 我查了一晚上百度和谷歌也不知道为什么... 项目地址： https://github.com/KKKZOZ/system_infomation 报错的位置： https://github.com/KKKZOZ/system_infomation/blob/0a56e369ab65dea30f20fa6760a53aa0bd625243/background.ts#L6 SystemInfoStore内容： https://github.com/KKKZOZ/system_infomation/blob/0a56e369ab65dea30f20fa6760a53aa0bd625243/src/stores/SystemInfoStore.ts#L34 项目结构：

你好，引入第三方包报错can not find module xxx，建议首先查看下你使用的第三方包（比如你此处的pinia）的版本是否存在该module，可以去该版本的文档或者源码里面找一找看。

zhangwenboi commented 1 year ago

wait on 不知道为什么没有生效无法监听到 tcp:3000

CHR19951228 commented 1 year ago

wait on 不知道为什么没有生效无法监听到 tcp:3000

可能是vite 3.0之后，启动的项目默认端口从3000改成了5173，所以在跟着博主配置的时候，3000的地方要改成5173。另一种方法是到vite.config.js中配置项目运行的地址：

export default defineConfig({
  base:'./',//配置基础路径
  plugins: [vue()],
  // vite启动项目后的项目地址
  server:{
    host:'127.0.0.1',
    port:'3000'
  }
})

hunter-ji / Blog