持续创作，加速成长！这是我参与「掘金日新计划 · 6 月更文挑战」的第4天，点击查看活动详情

Electron主要是用来搭建桌面应用程序的，虽然有许多人不喜欢它，但是也不能撼动目前它的王者地位！使用Electron可以让我们前端开发者快速搭建出桌面应用程序，我们所熟知的VS code就是使用Electron开发的。

由于Electron更新迭代非常快，加上Vue3已经发布很长一段时间了，所以我们很有必要将我们的项目升级一下，所以这里就利用electron+Vue3搭建一个万精油的项目框架！

我们需要先借助Vite初始化一个Vue3+TS 的项目，后面我们在逐步添加electron，在任何一个文件夹下：

执行命令：

安装依赖：

运行项目：

这样一个最简单的Vue3 + TS + Vite的前端项目就初始化好了。

初始化一个基本项目后，我们需要在项目中安装一些关于electron的包。

安装electron：

如果你安装electron不成功，建议使用cnpm安装。

安装electron-builder：

主要利用electron-builder来进行打包。

安装electron-devtools-installer：

该包主要是为了方便我们开发和调试electron，可以去官网详细了解：electron-devtools-installer。

安装vite-plugin-electron：

该包集成了Vite和Electron，比如使用它之后可以让我们方便的在渲染进程中使用Node API或者Electron API，详细使用用法可以去官网学习：vite-plugin-electron。

安装rimraf ：

该包主要是辅助作用，让我们快速删除某些文件和文件夹。

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

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

代码如下：

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

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

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

代码如下：

上段代码只是一个示例，我们只是简单的打印了一下系统信息罢了，重点是需要大家理解预加载这个概念，以及预加载可以做什么。

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

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

代码如下：

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

代码如下：

在上面的配置中，我们使用到了vite-plugin-electron插件，它将我们的electron和vite很好的结合了起来。

其实到这里大家启动项目后就会发现，electron出面其实已经就出现了，界面如下：

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

代码如下：

我们配置了main入口文件，由于electron还未支持ts，所以我们需要引用打包后的index.js文件。

除此之外，我们修改了build命令，利用electron-builder进行electron项目的打包。

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

修改package.json文件，代码如下：

执行打包：

打包完成的相关文件都会放到release目录下面，目录如下：

我们经常会打包失败，很大部分原因就是因为资源下载不下来，可能是由于国内的网络环境，建议大家多试几次，比如出现下面这种问题：

打包完成后，我们只需要安装生成出来的exe文件即可，非常简单。

为了方便我们主进程与渲染进程的通信，我们借助vueuse插件库中的一个插件@vueuse/electron来简化我们的工作，具体使用方式可以查看官网：@vueuse/electron。

安装@vueuse/electron：

渲染进程App.vue，使用示例代码如下：

electron-main/index.ts中主进程监听事件：

运行项目后，我们查看命令行控制台打印结果：

这个时候我们渲染进程和主进程之间就可以正常通信了。

错误一：

可以尝试以下方法解决错误：

错误二：

解决办法：

到这里我们electron + Vue3 + TS + Vite的项目架子就搭建完成了，这只是一个最简单的项目框架，还需要有非常多的地方需要我们去填充，比如打开新窗口，桌面提醒等等，这也会在后续的文章中提及。

源码地址：Vue3-Electron-Vite-TS

如果觉得文章太繁琐或者没看懂，可以观看视频： 小猪课堂