Vue+Electron打包桌面應用(超詳細完整教程)
更新時間：2024年02月04日 10:29:03 作者：蕭寂173
這篇文章主要介紹了Vue+Electron打包桌面應用超詳細完整教程,在這大家要記住整個項目的json文件不能有注釋,及時沒報錯也不行,否則運行命令時還是有問題,具體細節(jié)問題參考下本文詳細講解
一.使用vite+vue3+js方式
切記,整個項目的json文件不能有注釋,及時沒報錯也不行,否則運行命令時還是有問題
1.構(gòu)建桌面應用
1- 1.創(chuàng)建項目
npm create vite@latest 或者 npm init vite@latest // 選擇vue3+js或者vue3+ts
1- 2. 安裝依賴運行項目
// 進入項目安裝依賴 npm install // 運行項目 npm run dev
1- 3.配置Electron
npm install electron //這里建議用鏡像,不然太慢
1- 4.修改配置文件
1) vite.config.js
import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
// https://vitejs.dev/config/
export default defineConfig({
base: './', // 新增,打包的dist文件的index.html引入資源css/js的路徑,這里使用相對路徑,預防找不到的問題
plugins: [vue()]
})2）main.js(項目根目錄新增)
此為electron運行的入口文件
// main.js
// 控制應用生命周期和創(chuàng)建原生瀏覽器窗口的模組
const { app, BrowserWindow } = require('electron')
const path = require('path')
function createWindow () {
// 創(chuàng)建瀏覽器窗口
const mainWindow = new BrowserWindow({
width: 800,
height: 600,
webPreferences: {
preload: path.join(__dirname, 'preload.js')
}
})
// 加載 index.html
mainWindow.loadFile('dist/index.html') // 此處跟electron官網(wǎng)路徑不同，需要注意
// 打開開發(fā)工具
// mainWindow.webContents.openDevTools()
}
// 這段程序?qū)?Electron 結(jié)束初始化
// 和創(chuàng)建瀏覽器窗口的時候調(diào)用
// 部分 API 在 ready 事件觸發(fā)后才能使用。
app.whenReady().then(() => {
createWindow()
app.on('activate', function () {
// 通常在 macOS 上，當點擊 dock 中的應用程序圖標時，如果沒有其他
// 打開的窗口，那么程序會重新創(chuàng)建一個窗口。
if (BrowserWindow.getAllWindows().length === 0) createWindow()
})
})
// 除了 macOS 外，當所有窗口都被關(guān)閉的時候退出程序。 因此，通常對程序和它們在
// 任務欄上的圖標來說，應當保持活躍狀態(tài)，直到用戶使用 Cmd + Q 退出。
app.on('window-all-closed', function () {
if (process.platform !== 'darwin') app.quit()
})
// 在這個文件中，你可以包含應用程序剩余的所有部分的代碼，
// 也可以拆分成幾個文件，然后用 require 導入。3）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
{
"name": "sd",
"private": true,
"version": "0.0.0",
"main": "main.js", // 新增
//"type": "module", 創(chuàng)建項目自帶的這個要刪除,否則會有問題
"scripts": {
"dev": "vite",
"build": "vite build",
"preview": "vite preview",
"electron:serve": "electron ." //新增 electron運行命令
},
"dependencies": {
"electron": "^27.0.0",
"vue": "^3.3.4"
},
"devDependencies": {
"@vitejs/plugin-vue": "^4.2.3",
"vite": "^4.4.5"
}
}1- 5.打包vue項目
npm run build
1- 6.運行electron
yarn electron:serve 或者 npm run electron:serve
到這一步基本完成了,后面再新增一下熱更新及打包的配置,可以接著往下看
2.熱更新開發(fā)環(huán)境
2-1. 編輯main.js
將mainWindow.loadFile(‘dist/index.html’)更新為mainWindow.loadURL(“http://localhost:5173”)，更新后的文件如下所示：
// main.js
// 控制應用生命周期和創(chuàng)建原生瀏覽器窗口的模組
const { app, BrowserWindow } = require('electron')
const path = require('path')
function createWindow () {
// 創(chuàng)建瀏覽器窗口
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:5173") //這里改成自己的項目啟動端口
// 打開開發(fā)工具
// mainWindow.webContents.openDevTools()
}
// 這段程序?qū)?Electron 結(jié)束初始化
// 和創(chuàng)建瀏覽器窗口的時候調(diào)用
// 部分 API 在 ready 事件觸發(fā)后才能使用。
app.whenReady().then(() => {
createWindow()
app.on('activate', function () {
// 通常在 macOS 上，當點擊 dock 中的應用程序圖標時，如果沒有其他
// 打開的窗口，那么程序會重新創(chuàng)建一個窗口。
if (BrowserWindow.getAllWindows().length === 0) createWindow()
})
})
// 除了 macOS 外，當所有窗口都被關(guān)閉的時候退出程序。 因此，通常對程序和它們在
// 任務欄上的圖標來說，應當保持活躍狀態(tài)，直到用戶使用 Cmd + Q 退出。
app.on('window-all-closed', function () {
if (process.platform !== 'darwin') app.quit()
})
// 在這個文件中，你可以包含應用程序剩余的所有部分的代碼，
// 也可以拆分成幾個文件，然后用 require 導入。2-2. 同時開啟vite和electron服務
為了使vite和electron正常運行，需要先運行vite，使得其開發(fā)服務器的url可以正常訪問，然后再開啟electron去加載url。
此處需要安裝兩個庫：
- concurrently：阻塞運行多個命令，-k參數(shù)用來清除其它已經(jīng)存在或者掛掉的進程
- wait-on：等待資源，此處用來等待url可訪問
安裝命令為
yarn add -D concurrently wait-on 或者 npm install -D concurrently wait-on
接著更新文件package.json，scripts新增兩條命令：
{
"name": "sd",
"private": true,
"version": "0.0.0",
"main": "main.js",
//"type": "module", 創(chuàng)建項目自帶的這個要刪除,否則會有問題
"scripts": {
"dev": "vite",
"build": "vite build",
"preview": "vite preview",
"electron": "wait-on tcp:5173 && electron .", //新增更新1(這里改成自己的項目啟動端口)
"electron:serve": "concurrently -k \"npm run dev\" \"npm run electron\"" //新增更新2
},
"dependencies": {
"electron": "^27.0.0",
"vue": "^3.3.4"
},
"devDependencies": {
"@vitejs/plugin-vue": "^4.2.3",
"vite": "^4.4.5"
}
}2-3.運行
現(xiàn)已添加兩條命令：
- yarn electron為等待tcp協(xié)議5173端口可訪問，然后執(zhí)行electron
- yarn electron:serve為阻塞執(zhí)行開發(fā)服務器運行和yarn electron命令
運行項目只要執(zhí)行命令yarn electron:serve或者npm run electron:serve即可，當修改項目文件時，桌面應用也將自動更新。
到現(xiàn)在為止,熱更新也已經(jīng)完畢,最后一部分就是打包操作
3.打包操作
先說結(jié)論，重點還是在于mainWindow.loadURL()。
打包后還是加載http://localhost:5173是無法運行的，因此，此處需要先用vite打包好，然后使用electron-builder加載vite打包后的文件進行打包。
為了代碼能夠根據(jù)不同環(huán)境在運行時加載http://localhost:5173，在打包時加載文件，此處需要使用環(huán)境變量來切換生產(chǎn)和開發(fā)環(huán)境。
3-1.實現(xiàn)
3-1-1. 環(huán)境變量
此處使用環(huán)境變量NODE_ENV來切換生產(chǎn)和開發(fā)環(huán)境，生產(chǎn)環(huán)境為NODE_ENV=production，開發(fā)環(huán)境為NODE_ENV=development，若有其它如release等環(huán)境可在此基礎上拓展。
3-2. 創(chuàng)建electron文件夾
在項目根目錄下創(chuàng)建文件夾electron，將main.js和preload.js文件移動進來.
3-3. 編輯electron/main.js
該文件主要是需要根據(jù)環(huán)境變量切換electron加載的內(nèi)容，修改內(nèi)容如下：
// main.js
// 控制應用生命周期和創(chuàng)建原生瀏覽器窗口的模組
const { app, BrowserWindow } = require('electron')
const path = require('path')
const NODE_ENV = process.env.NODE_ENV //新增
// const NODE_ENV = 'development' // 判斷開發(fā)或生產(chǎn)模式(建議寫成這種,開發(fā)模式就可以用,等即將打包了再把這個變量換成打包模式)
function createWindow () {
// 創(chuàng)建瀏覽器窗口
const mainWindow = new BrowserWindow({
width: 800,
height: 600,
webPreferences: {
preload: path.join(__dirname, 'preload.js')
}
})
// 加載 index.html
// mainWindow.loadFile('dist/index.html') // 此處跟electron官網(wǎng)路徑不同，需要注意
mainWindow.loadURL(
NODE_ENV === 'development'
? 'http://localhost:5173'
:`file://${path.join(__dirname, '../dist/index.html')}`
); // 新增
// 打開開發(fā)工具
if (NODE_ENV === "development") {
mainWindow.webContents.openDevTools()
} // 新增
}
// 這段程序?qū)?Electron 結(jié)束初始化
// 和創(chuàng)建瀏覽器窗口的時候調(diào)用
// 部分 API 在 ready 事件觸發(fā)后才能使用。
app.whenReady().then(() => {
createWindow()
app.on('activate', function () {
// 通常在 macOS 上，當點擊 dock 中的應用程序圖標時，如果沒有其他
// 打開的窗口，那么程序會重新創(chuàng)建一個窗口。
if (BrowserWindow.getAllWindows().length === 0) createWindow()
})
})
// 除了 macOS 外，當所有窗口都被關(guān)閉的時候退出程序。 因此，通常對程序和它們在
// 任務欄上的圖標來說，應當保持活躍狀態(tài)，直到用戶使用 Cmd + Q 退出。
app.on('window-all-closed', function () {
if (process.platform !== 'darwin') app.quit()
})
// 在這個文件中，你可以包含應用程序剩余的所有部分的代碼，
// 也可以拆分成幾個文件，然后用 require 導入。3- 4. 編輯package.json
首先修改main 屬性，將main: main.js改為main: electron/main.js。
接著，編輯build屬性：
{
"name": "sd",
"private": true,
"version": "0.0.0",
"main": "electron/main.js", // 修改入口文件位置
"scripts": {
"dev": "vite",
"build": "vite build",
"preview": "vite preview",
"electron": "wait-on tcp:5173 && electron .",
"electron:serve": "concurrently -k \"npm run dev\" \"npm run electron\""
},
"build": {
"appId": "com.dweb.demo", //包id com.dweb.項目名
"productName": "ElectronApp", // 項目名
"copyright": "Copyright ? 2021 <your-name>", // 版權(quán)信息
"mac": {
"category": "public.app-category.utilities"
},
"nsis": {
"oneClick": false,
"allowToChangeInstallationDirectory": true
},
"files": [
"dist/**/*",
"electron/**/*"
],
"directories": {
"buildResources": "assets", //靜態(tài)文件資源獲取目錄
"output": "dist_electron" // 打包位置,會新建到項目根目錄
}
},
"dependencies": {
"electron": "^27.0.0",
"vue": "^3.3.4"
},
"devDependencies": {
"@vitejs/plugin-vue": "^4.2.3",
"concurrently": "^8.2.1",
"vite": "^4.4.5",
"wait-on": "^7.0.1"
}
}然后，更新scripts屬性。
此處需要先安裝兩個庫：
- cross-env: 該庫讓開發(fā)者只需要注重環(huán)境變量的設置，而無需擔心平臺設置
- electron-builder: electron打包庫
cross-env: 該庫讓開發(fā)者只需要注重環(huán)境變量的設置，而無需擔心平臺設置 electron-builder: electron打包庫
更新后的scripts如下：
{
"dev": "vite",
"build": "vite build",
"serve": "vite preview",
"electron": "wait-on tcp:5173 && cross-env NODE_ENV=development electron .", // 此處需要設置環(huán)境變量以保證開發(fā)時加載url
"electron:serve": "concurrently -k \"npm run dev\" \"npm run electron\"",
"electron:build": "vite build && electron-builder" // 新增打包命令
}最后，更新后的package.json完整內(nèi)容如下：
{
"name": "sd",
"private": true,
"version": "0.0.0",
"main": "electron/main.js", // 修改入口文件位置
"scripts": {
"dev": "vite",
"build": "vite build",
"preview": "vite preview",
"electron": "wait-on tcp:5173 && electron .",
"electron:serve": "concurrently -k \"npm run dev\" \"npm run electron\"",
"electron:build": "vite build && electron-builder" // 新增打包命令
},
"build": {
"appId": "com.dweb.demo", //包id com.dweb.項目名
"productName": "ElectronApp", // 項目名
"copyright": "Copyright ? 2021 <your-name>", // 版權(quán)信息
"mac": {
"category": "public.app-category.utilities"
},
"nsis": {
"oneClick": false,
"allowToChangeInstallationDirectory": true
},
"files": [
"dist/**/*",
"electron/**/*"
],
"directories": {
"buildResources": "assets", //靜態(tài)文件資源獲取目錄
"output": "dist_electron" // 打包位置,會新建到項目根目錄
}
},
"dependencies": {
"electron": "^27.0.0",
"vue": "^3.3.4"
},
"devDependencies": {
"@vitejs/plugin-vue": "^4.2.3",
"concurrently": "^8.2.1",
"vite": "^4.4.5",
"wait-on": "^7.0.1"
}
}3-5.打包
yarn electron:build 或者 npm run electron:build
報錯了:Package “electron” is only allowed in “devDependencies”. Please remove it from the “dependencies” section in your package.json.
這段意思就是說electron不允許在開發(fā)依賴,需要換到運行依賴里面,改完后package.json如下:
{
"name": "sd",
"private": true,
"version": "0.0.0",
"main": "electron/main.js", // 修改入口文件位置
"scripts": {
"dev": "vite",
"build": "vite build",
"preview": "vite preview",
"electron": "wait-on tcp:5173 && electron .",
"electron:serve": "concurrently -k \"npm run dev\" \"npm run electron\"",
"electron:build": "vite build && electron-builder" // 新增打包命令
},
"build": {
"appId": "com.dweb.demo", //包id com.dweb.項目名
"productName": "ElectronApp", // 項目名
"copyright": "Copyright ? 2021 <your-name>", // 版權(quán)信息
"mac": {
"category": "public.app-category.utilities"
},
"nsis": {
"oneClick": false,
"allowToChangeInstallationDirectory": true
},
"files": [
"dist/**/*",
"electron/**/*"
],
"directories": {
"buildResources": "assets", //靜態(tài)文件資源獲取目錄
"output": "dist_electron" // 打包位置,會新建到項目根目錄
}
},
"dependencies": {
// 將開發(fā)依賴換到了運行依賴里面
},
"devDependencies": {
"@vitejs/plugin-vue": "^4.2.3",
"concurrently": "^8.2.1",
"vite": "^4.4.5",
"wait-on": "^7.0.1",
"electron": "^27.0.0",
"vue": "^3.3.4"
}
}打包完成之后，會多出兩個文件夾dist和dist_electron
如果打包失敗,或者一直卡著一個地方,是因為打包會產(chǎn)生依賴包,都是從github下載的,需要vpn,或者國內(nèi)鏡像可以解決,具體使用淘寶鏡像方法可以看本博客最后,親測有效
至此,所有基本結(jié)束,上面這一堆參考了這個博主的文章,各位也可以看看
二.使用vite+vue3+Ts方式(某大佬已經(jīng)搭建好了,只能Ts)
使用某大佬配置好的框架,只支持ts版本,沒有選擇項(vite+vue3+ts)
執(zhí)行命令創(chuàng)建項目
方法很簡單
npm create electron-vite
首次進入會下載項目依賴,會詢問是否下載,輸入y即可
然后輸入項目名回車即可創(chuàng)建完畢安裝依賴
npm install運行項目
npm run dev
執(zhí)行命令以后會在electron窗口運行打包exe
npm run dev
(大佬已經(jīng)集成了熱部署,代碼更新窗口也更新)
三.使用vue-cli腳手架方式(支持vue2/3)
1.Node版本要求
本人用的是
v16.20.2,
原本我用的是18版本結(jié)果打包一直有問題:報錯：Error: error:0308010C:digital envelope routines::unsupported
后來查了大量資料找到了原因:因為 node.js V17版本中最近發(fā)布的OpenSSL3.0, 而OpenSSL3.0對允許算法和密鑰大小增加了嚴格的限制
當然針對17版本以上也有辦法解決,本人使用了最笨的方法就是降低版本到v16.20.2,大家可以看以下這篇博客嘗試其他解決辦法
快速解決Error: error:0308010C:digital envelope routines::unsupported的三種解決方案
2.通過vue-cli創(chuàng)建vue項目(2/3都可以)
使用vue-cli腳手架創(chuàng)建,這個方法不支持vite
vue create 項目名
3.添加vue自帶的electron-builder
下面命令執(zhí)行后會先執(zhí)行vue腳手架再運行electron
vue add electron-builder
4.打包exe程序
npm run electron:build
注意,打包過程會下載各種東西,網(wǎng)絡較差容易下載失敗,給大家推薦一個好用的方法
在項目根目錄下創(chuàng)建.npmrc文件,放入以下代碼,這樣下載的來源就是去淘寶鏡像去下載,比較快
ELECTRON_MIRROR=https://npm.taobao.org/mirrors/electron/ ELECTRON_BUILDER_BINARIES_MIRROR=http://npm.taobao.org/mirrors/electron-builder-binaries/
到此這篇關(guān)于Vue+Electron打包桌面應用(超詳細完整教程)的文章就介紹到這了,更多相關(guān)Vue打包桌面應用內(nèi)容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！
相關(guān)文章
這篇文章主要給大家介紹了關(guān)于Vue實例掛載的過程,文中通過實例代碼介紹的非常詳細,對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2022-03-03
基于Vite2.x的Vue 3.x項目的搭建實現(xiàn)
這篇文章主要介紹了基于Vite2.x的Vue 3.x項目的搭建實現(xiàn)，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2021-04-04
這篇文章給大家介紹了基于vue封裝一個帶眼睛的密碼子組件的方法,文章中有詳細的代碼講解,對大家的學習或工作有一定的幫助,需要的朋友可以參考下2023-09-09
Vue3兼容大部分Vue2的特性，用Vue2代碼開發(fā)Vue3都可以，性能上面打包大小減少 41%，初次渲染快 55%，更新快 133%，內(nèi)存使用減少 54%,本篇文章主要介紹Vue3的7種種組件通信,需要的朋友可以參考下面文章的具體內(nèi)容2021-09-09
有時候在項目中我們經(jīng)常需要設置簡單的倒計時功能,這個可以通過定時器來實現(xiàn),下面這篇文章主要給大家介紹了關(guān)于vue項目使用定時器每隔幾秒運行一次某方法的相關(guān)資料,需要的朋友可以參考下2023-04-04
這篇文章主要為大家詳細介紹了Vue實現(xiàn)簡單分頁器，具有一定的參考價值，感興趣的小伙伴們可以參考一下2018-12-12
Vue生產(chǎn)環(huán)境如何自動屏蔽console
這篇文章主要介紹了Vue生產(chǎn)環(huán)境如何自動屏蔽console問題,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-06-06
關(guān)于Vue?監(jiān)控數(shù)組的問題
這篇文章主要介紹了Vue?監(jiān)控數(shù)組的示例,主要包括Vue?是如何追蹤數(shù)據(jù)發(fā)生變化，Vue?如何更新數(shù)組以及為什么有些數(shù)組的數(shù)據(jù)變更不能被?Vue?監(jiān)測到，對vue監(jiān)控數(shù)組知識是面試比較常見的問題，感興趣的朋友一起看看吧2022-05-05
這篇文章主要介紹了關(guān)于element Drawer抽屜的使用方式,具有很好的參考價值,希望對大家有所幫助,如有錯誤或未考慮完全的地方,望不吝賜教2024-07-07
最近在研究Vue的組件庫,之前也用過$attrs和$listeners,官方文檔描述的不太詳細,也沒有太好的例子,下面這篇文章主要給大家介紹了關(guān)于Vue中$attrs和$listeners詳解以及使用的相關(guān)資料,需要的朋友可以參考下2022-11-11