【vite + vue + Electron 搭建项目】

一、安装

1.安装 vite

yarn create vite

2. 创建项目

创建命令如下：

yarn create vite <your-vue-app-name> --template vue

此处创建一个项目，名为 test。

yarn create vite test --template vue

3. 进入且运行

进入项目，在运行前需要先安装下依赖。

cd test
yarn install
yarn dev

二. 配置Electron

1.安装electron

yarn add --dev electron

如果安装失败
在根目录创建 .npmrc文件，写入如下字段：

ELECTRON_MIRROR=https://npm.taobao.org/mirrors/electron/
ELECTRON_BUILDER_BINARIES_MIRROR=http://npm.taobao.org/mirrors/electron-builder-binaries/

再次进行安装

因为打包也需要安装一些依赖。这个也可以解决打包下载依赖失败的问题。

2.配置文件

1）vite.config.js

import path from 'path'           // 新增
export default defineConfig({
  base: path.resolve(__dirname, './dist/'), // 新增
})

2）main.js
在 根目录 创建一个新的文件main.js，需要注意的是，该内容中index.html的加载路径跟electron官网给的配置不同。

// 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') // 此处跟electron官网路径不同，需要注意

  // 打开开发工具
  // 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 导入。

3）preload.js
在 根目录 创建一个新的文件preload.js。

// preload.js

// 所有Node.js API都可以在预加载过程中使用。
// 它拥有与Chrome扩展一样的沙盒。
window.addEventListener('DOMContentLoaded', () => {
  const replaceText = (selector, text) => {
    const element = document.getElementById(selector)
    if (element) element.innerText = text
  }

  for (const dependency of ['chrome', 'node', 'electron']) {
    replaceText(`${dependency}-version`, process.versions[dependency])
  }
})

4）package.json
为了确保能够运行相关electron的命令，需要修改package.json文件。

首先需要去设置main属性，electron默认会去在开始时寻找项目根目录下的index.js文件，此处我们使用的是main.js，所以需要去定义下。

// package.json

{
  "name": "text",
  "version": "0.0.0",
  "main": "main.js",  // 新增
  "scripts": {
    "dev": "vite",
    "build": "vite build",
    "serve": "vite preview",
    "electron:serve": "electron ." // 新增
  },
}

三. 运行

直接在终端输入如下命令：

yarn electron:serve

四. vue 打包后可能出现的问题

router.js

需要更改为 hash 模式

  // history: createWebHistory(),
  history: createWebHashHistory(),

五. 打包

因为我们需要打包成 Linux 版本的，我是直接把 vue 打包后然后扔到 electron 项目里面再使用 electron 二次进行打包；
如果需要直接在vue项目中打包应该还需要安装 electron-builder electron-packager 然后再修改 package.json 文件配置打包命令等。这里以后再研究