vue3结合electron

使用Vue3构建Electron应用

最新推荐文章于 2025-10-22 08:19:18 发布

原创最新推荐文章于 2025-10-22 08:19:18 发布 · 3.2k 阅读

4 ·

CC 4.0 BY-SA版权

文章标签：

#electron #vue.js

本文档介绍了如何一步步将Vue3项目转化为一个Electron应用。首先创建Vue3项目并确保其正常运行，接着通过特定命令使项目兼容Electron。然后，你需要修改background.js文件以适配 Electron。最后，成功在Vue组件中引入并使用Electron和Node模块，解决了导入模块时遇到的问题。

第一步

像平时一样先创建vue3项目，能正常运行之后进行第二步

第二步

执行vue add electron-builder命令，让vue项目变成一个electron+vue的项目

第三步

修改项目中的background.js文件

'use strict'

import { app, protocol, BrowserWindow,ipcMain } from 'electron'
import { createProtocol } from 'vue-cli-plugin-electron-builder/lib'
// import installExtension, { VUEJS3_DEVTOOLS } from 'electron-devtools-installer'
const isDevelopment = process.env.NODE_ENV !== 'production'

// Scheme must be registered before the app is ready
protocol.registerSchemesAsPrivileged([
  { scheme: 'app', privileges: { secure: true, standard: true } }
])

async function createWindow() {
  // Create the browser window.
  const win = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      nodeIntegration: true, //开启true这一步很重要,目的是为了vue文件中可以引入node和electron相关的API
      contextIsolation: false,
      enableRemoteModule: true,
    }
  })
  ipcMain.on('sub',(e,data) => {
    console.log(data)
  })
  if (process.env.WEBPACK_DEV_SERVER_URL) {
    // Load the url of the dev server if in development mode
    await win.loadURL(process.env.WEBPACK_DEV_SERVER_URL)
    if (!process.env.IS_TEST) win.webContents.openDevTools()
  } else {
    createProtocol('app')
    // Load the index.html when not in development
    win.loadURL('app://./index.html')
  }
}

// Quit when all windows are closed.
app.on('window-all-closed', () => {
  // On macOS it is common for applications and their menu bar
  // to stay active until the user quits explicitly with Cmd + Q
  if (process.platform !== 'darwin') {
    app.quit()
  }
})

app.on('activate', () => {
  // On macOS it's common to re-create a window in the app when the
  // dock icon is clicked and there are no other windows open.
  if (BrowserWindow.getAllWindows().length === 0) createWindow()
})

// This method will be called when Electron has finished
// initialization and is ready to create browser windows.
// Some APIs can only be used after this event occurs.
app.on('ready', async () => {
  // if (isDevelopment && !process.env.IS_TEST) {
  //   // Install Vue Devtools
  //   try {
  //     await installExtension(VUEJS3_DEVTOOLS)
  //   } catch (e) {
  //     console.error('Vue Devtools failed to install:', e.toString())
  //   }
  // }
  createWindow()
})

// Exit cleanly on request from parent process in development mode.
if (isDevelopment) {
  if (process.platform === 'win32') {
    process.on('message', (data) => {
      if (data === 'graceful-exit') {
        app.quit()
      }
    })
  } else {
    process.on('SIGTERM', () => {
      app.quit()
    })
  }
}

第四步

在vue文件里面就可以引入electron模块和node模块了，

<script setup>
import {defineProps} from 'vue' // defineProps不是可以直接使用吗，不知道为啥不引入的话报错，可能是因为用的webpack吧，之前用vite打包可以不引入直接使用
const {ipcRenderer} = window.require('electron') //注意是window.require
const fs = window.require('fs')
console.log(fs)
ipcRenderer.send('sub', "hahalala")

const props = defineProps({
  msg: {
    type: String
  }
})
</script>

结语：
在vue文件中引入electron模块时浪费了我很多时间，主要是引入方法不对，我使用的错误引入方法如下：
import electron from ‘electron’

const electron = require(‘electron’)