vue配置electron,使用electron-builder进行打包【完整步骤】

目 录

[1. 已知:vue3项目已经创建好](#1. 已知:vue3项目已经创建好)

一、配置Electron

[1. 安装electron](#1. 安装electron)

[2. 在根目录创建electron 文件夹,并新建main.js 和preload.js](#2. 在根目录创建electron 文件夹,并新建main.js 和preload.js)

[3.在package.json 中配置添加以下代码:](#3.在package.json 中配置添加以下代码:)

[4. 安装concurrently](#4. 安装concurrently)

[5. 安装 nodemon 实现热更新](#5. 安装 nodemon 实现热更新)

[6. 本地启动](#6. 本地启动)

[二、 打包和发布Electron](#二、 打包和发布Electron)

[1. 修改electron/main.js 文件](#1. 修改electron/main.js 文件)

[2. 安装electron-builder](#2. 安装electron-builder)

[3. 配置package.json](#3. 配置package.json)

[4. 打包](#4. 打包)


1. 已知:vue3项目已经创建好

1.1 安装依赖(npm i ) ;运行项目(npm run dev),确保项目是好的。

1.2. 打包本地Vue项目(npm run build)

打包好后会自动形成dist 文件夹

一、配置Electron

1. 安装electron

javascript 复制代码
cnpm install --save-dev electron

安装好后,package.json 中会加载electron 及其版本号

配置 vite.config.js文件

ps:在配置vite.config.js文件之后可以进行打包本地项目。

2. 在根目录创建electron 文件夹,并新建main.js 和preload.js

main.js :

javascript 复制代码
const { app, BrowserWindow } = require('electron')
const path = require('path')

const createWindow = () => {
    const win = new BrowserWindow({
      width: 800,
      height: 600,
    //   将此脚本(preload)附加到渲染器流程
      webPreferences: {
        preload: path.join(__dirname, 'preload.js'),
        nodeIntegration: true, //开启true这一步很重要,目的是为了vue文件中可以引入node和electron相关的API
      contextIsolation: true, // 可以使用require方法
      enableRemoteModule: true, // 可以使用remote方法
      }
    })
  
  
  //也开页面
    win.loadURL('http://localhost:3001')
 
   //控制台
    win.webContents.openDevTools()
   
  }
  app.whenReady().then(() => {
    createWindow()

    app.on('activate', () => {
        if (BrowserWindow.getAllWindows().length === 0) createWindow()
      })
  })

  app.on('window-all-closed', () => {
    if (process.platform !== 'darwin') app.quit()
  })

preload.js

javascript 复制代码
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])
    }
  })

3.在package.json 中配置添加以下代码:

javascript 复制代码
{
  "name": "vue3_cli_default",
  "version": "1.0.0",
  "description": "Hello World!",
  "main": "electron/main.js",   //main.js修改为electron/main.js
  "author": "Jane Doe",
  "license": "MIT",
  "scripts": {
    "dev": "vite",
    "build": "vite build",
    "serve": "vite preview",
    "start": "electron ."
  },
.......
}

4. 安装concurrently

cnpm install concurrently

concurrently:可以同时执行多个命令

用于此项目中的作用:将启动vite和electron整合成一条命令,一键启动

安装好配置package.json

javascript 复制代码
"dev": "concurrently vite \"electron .\""

5. 安装 nodemon实现热更新

cnpm i nodemon -D

javascript 复制代码
"dev": "concurrently vite \"nodemon --exec electron . --watch ./ --ext .js,.html,.css,.vue\""

6. 本地启动

javascript 复制代码
cnpm run dev

注意事项:electron 中的main.js 启动地址 要与本地启动的地址保持一致,否则打开是空白页。

二、 打包和发布Electron

1. 修改electron/main.js 文件

添加

javascript 复制代码
const NODE_ENV = process.env.NODE_ENV
 win.loadURL(
        NODE_ENV === 'development'
        ? 'http://localhost:3000'
        :`file://${path.join(__dirname, '../dist/index.html')}`
      ); 
if (NODE_ENV === "development") {
        win.webContents.openDevTools()
      }

2. 安装electron-builder

javascript 复制代码
cnpm i electron-builder -D

3. 配置package.json

javascript 复制代码
  "scripts": {
    "pack": "electron-builder --dir",
    "dist": "electron-builder"
  },

 "build": {  
    "appId": "luOne",
    "productName": "sd",
    "files": [  
          "dist/**/*",
    "electron/**/*"
    ],
    "directories": {  
      "buildResources": "assets",  
      "output": "electron-dist"
    },  
    "win": {  
      "target": ["nsis"],  
      "icon": "build/icon.ico"  
    }, 
    "mac": {
      "category": "public.app-category.utilities"
    }, 
    "nsis": {  
      "oneClick": false,
      "allowElevation": true, 
      "deleteAppDataOnUninstall": true,
      "allowToChangeInstallationDirectory": true, 
      "createDesktopShortcut": true,
      "createStartMenuShortcut": true,
      "shortcutName": "测试文档项目"
    }  
  } 

添加备注:

javascript 复制代码
build: {
 "nsis": {
      "oneClick": false, // 是否一键安装
      "perMachine": false,//perMachine 可能会影响自动更新的安装权限问题(windows7不受影响)
      "allowElevation": true,// 允许请求提升。 如果为false,则用户必须使用提升的权限重新启动安装程序。
      "allowToChangeInstallationDirectory": true,// 允许修改安装目录
      "installerIcon": "./build/icons/icon.ico",// 安装图标
      "uninstallerIcon": "./build/icons/icon.ico",//卸载图标
      "installerHeaderIcon": "./build/icons/icon.ico",// 安装时头部图标
      "createDesktopShortcut": true, // 创建桌面图标
      "createStartMenuShortcut": true,// 创建开始菜单图标
      "runAfterFinish": true,// 安装完成后是否运行项目
      "shortcutName": "client-ico",// 图标名称
      "include": "build/script/installer.nsh" // 自定义nsis脚本
    },
    
}

4. 打包

javascript 复制代码
cnpm run dist

打包成功会自动生成 electron-dist 文件夹, 其中会有一个exe 文件,直接运行exe文件即可。

相关推荐
明月_清风2 分钟前
🖥️ Electron 三进程 Host 实战:从架构设计到生产落地的完整指南
前端·electron·客户端
GIS数据转换器16 分钟前
智慧林草“一张图“平台
java·大数据·服务器·前端·javascript·数据库·人工智能
2401_8858850420 分钟前
国际语音php接口代码示例:PHP使用cURL快速调用语音发送API
android·开发语言·前端·人工智能·python·php·语音识别
leoZ23120 分钟前
AI+前端提效-08 AI自动化文档:前端组件、接口、项目文档自动生成
前端·人工智能·深度学习·神经网络·目标检测·自然语言处理·自动化
lilian23325 分钟前
HarmonyOS 7 新特性(五)|ContainerReader 容器断点与自适应布局
前端·华为·harmonyos
计算机魔术师39 分钟前
Google DeepMind 将 AI 科学家 Co-Scientist 扩展为实验室集成研究伙伴
前端
2601_965798471 小时前
BrandBoost WordPress Theme Review: Fast Agency Web Architecture
前端
律宏阔1 小时前
Electron 集成 Drizzle + SQLite 踩坑笔记
前端
律宏阔1 小时前
Electron preload.ts 类型无法自动推导的解决方案
前端
名字还没想好☜1 小时前
kubectl 排障实战:jsonpath 精准取值、custom-columns、events 排序与 top 速查
运维·前端·chrome·docker·kubernetes