怎么使用vue3+ts+vite+electron搭建桌面應用

今天小編給大家分享一下怎么使用vue3+ts+vite+electron搭建桌面應用的相關知識點，內容詳細，邏輯清晰，相信大部分人都還太了解這方面的知識，所以分享這篇文章給大家參考一下，希望大家閱讀完這篇文章后有所收獲，下面我們一起來了解一下吧。

一、版本背景介紹

vite： ^4.2.0
vue: ^3.2.47
ts: ^4.9.3
electron: ^23.2.1

二、過程

1. 搭建vite+vue-ts的項目

yarn create vite@ vuets_electron --template vue-ts
cd ./vuets_electron
yarn install && yarn dev

2. 接入electron

為了保證electron能夠正常安裝，在 vuets_electron 的根目錄下創建.npmrc, 設置一下electron的鏡像源

# /.npmrc 
ELECTRON_MIRROR=https://npmmirror.com/mirrors/electron/
ELECTRON_BUILDER_BINARIES_MIRROR=https://npmmirror.com/mirrors/electron-builder-binaries/

安裝electron相關的包

# electron
yarn add -D electron
# electron-builder 用于打包
yarn add -D electron-builder
# electron-devtools-installer
yarn add -D electron-devtools-installer
# 為了保證后續步驟，這里在安裝一個concurrently,
yarn add concurrently

3. electron啟動

創建electron主進程文件main.ts: /src/main/main.ts

const { app, BrowserWindow } = require('electron')

const createWindow = () => {
	const win = new BrowserWindow({
		width: 800,
		height: 600,
		// webPreferences: {
		// 	preload: path.join(__dirname, 'preload.js')
		// }
	})
	// 加載vue url視本地環境而定，如http://localhost:5173
	win.loadURL('http://localhost:3000')
}

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

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

調整啟動命令：package.json
1 vue 啟動： yarn dev
2 那electron要如何啟動呢? 從electron官方文檔我們可以清楚的知道，electron可以加載URL，那么我們就可以在啟動electron之前啟動vue，然后將vue的訪問入口接入electron，在同時啟動electron不就可以了嗎~
3 千萬不要忘了設置入口文件喲~~~

{
	"name": "vuets_electron",
	"private": true,
	"version": "1.0.0",
	// +++ 增加入口
	"main": "src/main/main.js",
	// +++
	"scripts": {
		"dev": "vite",
		"build": "vue-tsc && vite build",
		"preview": "vite preview",
		// +++ 設置electron開發啟動命令
		"electron:dev": "concurrently \"yarn dev\" \"electron .\""
		// +++
	}
	// ...
	// 其它配置
}

到這，我們運行 yarn electron:dev 就能看到熟悉的electron頁面了

4. electron打包

1 打包vue
2 將vue的入口文件接入electron
3 打包electron這樣我們就能得到完整的安裝包

# package.json

{
	"name": "vuets_electron",
	"private": true,
	"version": "1.0.0",
	"main": "src/main/main.js",
	// +++
	"scripts": {
		"dev": "vite",
		"build": "vue-tsc && vite build",
		"preview": "vite preview",
		"electron:dev": "concurrently \"yarn dev\" \"electron .\"",
		// +++ 設置electron打包命令
		"electron:build": "yarn build && electron-builder"
		// +++
	}
	// ...
	// 其它配置
	// +++ 打包相關設置
	"build": {
		"appId": "ink.bennent_g.demo",
		"directories": {
			"output": "output"
		},
		// 其它的build相關設置，可參考 electron-builder官方文檔
	}
}

vite.config.ts調整

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'

// https://vitejs.dev/config/
export default defineConfig({
	plugins: [
		vue(),
	],
	// +++
	base: './',
	// +++
	server: {
		port: 3000
	}
	// ...
})

src/main/main.ts 調整

const { app, BrowserWindow } = require('electron')

const createWindow = () => {
	const win = new BrowserWindow({
		width: 800,
		height: 600,
		// webPreferences: {
		// 	preload: path.join(__dirname, 'preload.js')
		// }
	})
	
	// +++ 開發環境與打包后加載vue入口文件有所區別
	// and load then index.html or the app
	if(process.env.npm_lifecycle_event === 'electron:dev') {
		win.loadURL('http://localhost:3000')
		win.webContents.openDevTools()
	} else {
		win.loadFile('dist/index.html')
	}
	// +++
}

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

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

5. 項目目錄梳理

為了清晰的區分electron的主進程和渲染進程，我們可以將vue相關的文件規整到render的目錄下 移動vue相關文件，請務必注意vue相關引用的路徑問題
如下是本人的目錄結構，可參考

vuets_electron  // 項目名稱
│ —— node_modules 
│ —— dist	// vue打包目錄
│ —— output	// electron打包目錄
│ —— public
│ —— .npmrc
│ —— package.json
│ —— vite.config.ts
│ —— tsconfig.json
│
└─── src // 開發相關目錄
│   │  main.ts // vue默認入口文件
│   └───assets // 靜態資源目錄
│       │   ...
│   └───main // electron主進程目錄
│       │   main.ts
│   └───render // 渲染進程目錄即vue相關目錄結構
│       │   router
│       │   views
│       │   ...

至此 我們的electron開發框架就搭建完成了，可以愉快的擼代碼了~

三、打包首頁加載空白問題(補充)

如果項目使用了vue-router，我們在build后運行exe，會發現首頁白屏，這是因為 electron 僅支持hash模式，如果使用了createWebHistory()創建路由，可更改為createWebHashHistory()即可

const router = createRouter({
	// history: createWebHistory(),
	// 修改為
	history: createWebHashHistory(),
	routes
})

以上就是“怎么使用vue3+ts+vite+electron搭建桌面應用”這篇文章的所有內容，感謝各位的閱讀！相信大家閱讀完這篇文章都有很大的收獲，小編每天都會為大家更新不同的知識，如果還想學習更多的知識，請關注億速云行業資訊頻道。