electron+vue+vite+typescript 搭建桌面程序

1、安装nodejs及环境配置;

nodejs装完后,设置python路径;

npm config set python "D:\ProgramFiles\Miniconda3\python.exe"

若报错:

npm ERR! python is not a valid npm option

原因为npm版本问题,v9存在此问题,可将其将为v8

npm install -g npm@^8

安装node-gyp:node-gyp 是一个可以编译 node 插件的工具,在使用 node-gyp 前需要安装 python 环境和 C++ 环境。

npm install -g node-gyp
c++环境,2种方式任选1:

1)安装 windows-build-tools
2)visual studio community 安装c++桌面开发工具;

image.png

安装完成后,设置msvs版本:

npm config set msvs_version 2022

最后,配置node-gyp:

node-gyp configure
node-gyp build

若configure出现报错,找不到python路径,可手动指定

node-gyp --python="D:\ProgramFiles\Miniconda3\python.exe" configure

若找不到 binding.gyp,

gyp: binding.gyp not found (cwd: D:\PWA) while trying to load binding.gyp

需手动创建,放在C:\Users\用户名 目录下。内容为

{
    "targets": [{
        "target_name": "binding",
        "sources": [ "<PATH TO NODE>" ]
    }]
}

为了加快速度,设置国内源:

npm config set registry http://registry.npm.taobao.org --global

######## 添加electron

//设置国内源,否则会卡住
npm config set ELECTRON_MIRROR http://npm.taobao.org/mirrors/electron/    
// Electron安装
npm install electron -g
// Vue项目添加Electron-builder打包工具 
vue add electron-builder

2、vue/vite/typescript;

创建项目
npm create vite@latest servermonitor --template vue-ts
//提示安装vite,然后依次选择 Vue、TypeScript
cd servermonitor  //进入到项目路径
npm install
npm run dev
image.png
安装Electron
npm install electron -D   //安装electron

安装electron-builder:用来打包成可安装exe文件 和 绿色版免安装exe程序

npm install electron-builder -D 

安装electron-devtools-installer:<meta name="source" content="lake">主要是为了方便我们开发和调试electron,可以去官网详细了解:electron-devtools-installer

npm install electron-devtools-installer -D

安装vite-plugin-electron:<meta name="source" content="lake">集成了ViteElectron,比如使用它之后可以让我们方便的在渲染进程中使用Node API或者Electron API,详细使用用法可以去官网学习:vite-plugin-electron

npm install vite-plugin-electron -D
npm install vite-plugin-electron-renderer -D

安装rimraf :辅助作用,让我们快速删除某些文件和文件夹。

npm install rimraf -D

3、初始化Electron

Electron项目分为了主进程和渲染进程,主进程其实就是我们的Electron,渲染进程就相当于我们的Vue项目。

新建主进程

为了方便修改代码和查看,我们在项目根目录新建主进程文件夹electron-main,然后在其目录下新建index.ts文件,编写主进程代码。

// electron-main/index.ts
import { app, BrowserWindow } from "electron";
import path from "path";

const createWindow = () => {
  const win = new BrowserWindow({
    webPreferences: {
      contextIsolation: false, // 是否开启隔离上下文
      nodeIntegration: true, // 渲染进程使用Node API
      preload: path.join(__dirname, "./electron-preload/index.js"), // 需要引用js文件
    },
  });

  // 如果打包了,渲染index.html
  if (app.isPackaged) {
    win.loadFile(path.join(__dirname, "../index.html"));
  } else {
    let url = "http://localhost:5173"; // 本地启动的vue项目路径。注意:vite版本3以上使用的端口5173;版本2用的是3000
    win.loadURL(url);
  }
};

app.whenReady().then(() => {
  createWindow(); // 创建窗口
  app.on("activate", () => {
    if (BrowserWindow.getAllWindows().length === 0) createWindow();
  });
});

// 关闭窗口
app.on("window-all-closed", () => {
  if (process.platform !== "darwin") {
    app.quit();
  }
});

上段代码只是一个最简单的Electron主进程的代码,大家也可以直接去官网看一下即可。这里有两个点需要大家注意:

  • 渲染进程路径引用的是js而不是ts,因为electron是不认识ts文件的,有些小伙伴可能不理解引用的js文件合适产生的,这都不用着急,我们安装的插件会帮我们解决的。
  • app.isPackaged主要是用来判断应用是否已经打包了,打包了我们只需要引用相对路径的html文件即可。
新建预加载文件

electron中有一个预加载的概念,也就是我们常说的preload,在该文件里面可以在其它脚本文件执行之前运行,它可以调用一些Node API。

在项目根目录新建electron-preload文件夹,然后在其目录下新建index.ts文件,编写代码:

// electron-preload/index.ts
import os from "os";
console.log("platform", os.platform());

4、修改tsconfig.json

前面已经建好了渲染进程和预加载文件,但放在项目根目录里面的。自动生成的Vue3+ts项目只初始化了src目录下的文件监听,所以我们需要修改一下tsconfig.json配置文件。

在include属性里新增关于electron文件监听的配置项:

"include": [
  "src/**/*.ts",
  "src/**/*.d.ts",
  "src/**/*.tsx",
  "src/**/*.vue",
  "electron-main/**/*.ts",
  "electron-preload/**/*.ts"
]

5.修改vite.config.ts

虽然建好了electron的主进程文件和预加载文件,但是如果不做任何处理,这两个文件就和普通的脚本文件没有任何区别了。所以我们需要修改vite.config.ts配置文件,以此将electron和vite项目结合起来。

import { defineConfig } from 'vite'
import vue from '@vitejs/plugin-vue'
import electron from "vite-plugin-electron";
import electronRenderer from "vite-plugin-electron-renderer";
import polyfillExports from "vite-plugin-electron-renderer";

// https://vitejs.dev/config/
export default defineConfig({
  plugins: [
    vue(),
    electron({
      entry: "electron-main/index.ts", // 主进程文件
    }),
    electronRenderer(),
    polyfillExports(),
  ],
  build: {
    emptyOutDir: false, // 默认情况下,若 outDir 在 root 目录下,则 Vite 会在构建时清空该目录
    outDir: "dist-electron"
  },
});

6.修改package.json

package.json作为一个项目里面很重要的一个文件,我们自然是不能忽略的。在这里我们需要配置我们项目的入口文件以及打包的相关配置。

{
  "name": "servermonitor",
  "private": true,
  "version": "0.0.0",
  "main": "dist-electron/index.js",
  "scripts": {
    "dev": "vite",
    "build": "rimraf dist-electron && vite build && electron-builder",
    "preview": "vite preview"
  },
  "dependencies": {
    "vue": "^3.2.47"
  },
  "devDependencies": {
    "@vitejs/plugin-vue": "^4.1.0",
    "@vueuse/electron": "^9.13.0",
    "electron": "^23.2.1",
    "electron-builder": "^23.6.0",
    "electron-devtools-installer": "^3.2.0",
    "pkg": "^5.8.1",
    "rimraf": "^4.4.1",
    "typescript": "^4.9.3",
    "vite": "^4.2.0",
    "vite-plugin-electron": "^0.11.1",
    "vite-plugin-electron-renderer": "^0.13.14",
    "vue-tsc": "^1.2.0"
  }
}

配置了main入口文件,由于electron还未支持ts,所以需要引用打包后的index.js文件。
除此之外,修改了build命令,利用electron-builder进行electron项目的打包。

7.配置electron-builder打包脚本

想要顺利打包项目,还需要写一些关于electron-builder的打包脚本代码,如果想要详细了解脚本的各项配置项的作用的,可以去官网学习一些:electron-builder

修改package.json:

"build": {
    "appId": "com.servermonitor.desktop",
    "productName": "servermonitor",
    "asar": true,
    "copyright": "Copyright © 2023 hw",
    "directories": {
      "output": "release/${version}"
    },
    "files": [
      "./dist",
      "./package.json",
      "./dist-electron"
    ],
    "mac": {
      "artifactName": "${productName}_${version}.${ext}",
      "target": [
        "dmg"
      ]
    },
    "win": {
      "target": [
        {
          "target": "nsis",
          "arch": [
            "x64"
          ]
        }
      ],
      "artifactName": "${productName}_${version}.${ext}"
    },
    "nsis": {
      "oneClick": false,
      "perMachine": false,
      "allowToChangeInstallationDirectory": true,
      "deleteAppDataOnUninstall": false
    },
    "publish": [
      {
        "provider": "generic",
        "url": "http://127.0.0.1:8080"
      }
    ],
    "releaseInfo": {
      "releaseNotes": "发布版本"
    }
  }
npm run dev

运行效果:


image.png
执行打包:
npm run build

参考资料:
https://stackoverflow.com/questions/74522956/python-is-not-a-valid-npm-option
https://juejin.cn/post/7118412140582535175
https://github.com/nodejs/node-gyp/issues/2664
https://github.com/nodejs/node-gyp/issues/1709

https://juejin.cn/post/7137942639717908517
https://juejin.cn/post/7201195953691983927
https://zhuanlan.zhihu.com/p/521239144

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 204,684评论 6 478
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 87,143评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 151,214评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,788评论 1 277
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,796评论 5 368
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,665评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,027评论 3 399
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,679评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 41,346评论 1 299
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,664评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,766评论 1 331
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,412评论 4 321
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,015评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,974评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,203评论 1 260
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,073评论 2 350
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,501评论 2 343

推荐阅读更多精彩内容