前言

前段时间，我用electron-vue开发了一款跨平台（目前支持Mac和Windows）的免费开源的图床上传应用——PicGo，在开发过程中踩了不少的坑，不仅来自应用的业务逻辑本身，也来自electron本身。在开发这个应用过程中，我学了不少的东西。因为我也是从0开始学习electron，所以很多经历应该也能给初学、想学electron开发的同学们一些启发和指示。故而写一份Electron的开发实战经历，用最贴近实际工程项目开发的角度来阐述。希望能帮助到大家。

预计将会从几篇系列文章或方面来展开：

说明

PicGo是采用electron-vue开发的，所以如果你会vue，那么跟着一起来学习将会比较快。如果你的技术栈是其他的诸如react、angular，那么纯按照本教程虽然在render端（可以理解为页面）的构建可能学习到的东西不多，不过在main端（electron的主进程）应该还是能学习到相应的知识的。

Electron简要介绍

一开始学习electron的时候，我被官网文档密密麻麻的概念所镇住了： 0. electron-vue入门 - 图1

概念太多，没有办法一下子接受。所以我自己学习完electron开发后，做了一张图。来看看图理解一下什么是electron，以及它包括了啥：

0. electron-vue入门 - 图2

图解

electron由Node.js+Chromium+Native APIs构成。你可以理解成，它是一个得到了Node.js和基于不同平台的Native APIs加强的Chromium浏览器，可以用来开发跨平台的桌面级应用。

它的开发主要涉及到两个进程的协作——Main（主）进程和Renderer（渲染）进程。简单的理解两个进程的作用：

  • Main进程主要通过Node.js、Chromium和Native APIs来实现一些系统以及底层的操作，比如创建系统级别的菜单，操作剪贴板，创建APP的窗口等。
  • Renderer进程主要通过Chromium来实现APP的图形界面——就是平时我们熟悉的前端开发的部分，不过得到了electron给予的加强，一些Node的模块（比如fs）和一些在Main进程里能用的东西（比如Clipboard）也能在Render进程里使用。
  • Main进程和Renderer进程通过ipcMain和ipcRenderer来进行通信。通过事件监听和事件派发来实现两个进程通信，从而实现Main或者Renderer进程里不能实现的某些功能。

进一步介绍

说完了electron的组成和需要我们开发的部分，来说说它的优缺点。

优点：

  • 从上述介绍可以发现，除了不同平台Native APIs不同以外，Node.js和Chromium都是跨平台的工具，这也为electron生来就能做跨平台的应用开发打下基础。
  • 开发图形界面前所未有的容易——比起C#\QT\MFC等传统图形界面开发技术，通过前端的图形化界面开发明显更加容易和方便。得益于Chromium，这种开发模式得以实现。
  • 成熟的社区、活跃的核心团队，大部分electron相关的问题你可以在社区、github issues、Stack Overflow里得到答案。开发的障碍进一步降低。

缺点：

  • 应用体积过大。由于内部包装了Chromium和Node.js，使得打包体积（使用electron-builder）在mac上至少是45M+起步，在windows上稍微好一点，不过也要35M+起步。不过相比早期打包体积100M+起步来说，已经好了不少。不过解压后安装依然是100M+起步。
  • 受限于Node.js和Native APIs的一些支持度的问题，它依然有所局限。一些功能依然无法实现。比如无法获取在系统文件夹里选中的文件，而必须调用web的File或者node的fs接口才可以访问系统文件。
  • 应用性能依旧是个问题。所以做轻量级应用没问题，重量级应用尤其是CPU密集型应用的话很是问题。

electron-vue的简要介绍

由于我自己是Vue的技术栈，所以就想在electron里使用vue。而vue只是在renderer进程里使用的框架，不涉及到main进程。如下图：

0. electron-vue入门 - 图3

因此react、angluar以及其他的前端开发框架同样适用。

不过想要做到把vue和electron结合起来并不是一件特别容易的事。为了方便开发，我使用的是electron-vue，这个是开发者SimulatedGREG参考vue-cli的webpack模板骨架搭建的electron和vue结合的开发脚手架。由于我对于vue-cli非常熟悉，所以上手electron-vue非常容易。相比很多其他的教程或者其他electron+前端开发框架的组装方案，electron-vue给我感觉最好的是如下：

  • 只有一个package.json。而大部分其他的项目结构依然在使用两个package.json来应对main进程和renderer进程的依赖库。
  • 内建完整的vue全家桶，省去再次配置vue-router和vuex的一些初期操作。
  • 内建完整的webpack开发、生产等配置，开发环境舒适。
  • 内建完整的开发、构建等npm scripts，使用非常方便。
  • 内建完整的Travis-ci、Appveyor配置脚本，只需少数修改就能做到利用CI自动构建的应用发布。
  • 完善的文档，清晰的项目结构。

大体的项目结构如下，根据选择的不同设置结构会有所不同：

  1. my-project
    ├─ .electron-vue
    │  └─ <build/development>.js files
    ├─ build
    │  └─ icons/
    ├─ dist
    │  ├─ electron/
    │  └─ web/
    ├─ node_modules/
    ├─ src
    │  ├─ main # 主进程
    │  │  ├─ index.dev.js
    │  │  └─ index.js
    │  ├─ renderer # 渲染进程
    │  │  ├─ components/
    │  │  ├─ router/
    │  │  ├─ store/
    │  │  ├─ App.vue
    │  │  └─ main.js
    │  └─ index.ejs
    ├─ static/
    ├─ test
    │  ├─ e2e
    │  │  ├─ specs/
    │  │  ├─ index.js
    │  │  └─ utils.js
    │  ├─ unit
    │  │  ├─ specs/
    │  │  ├─ index.js
    │  │  └─ karma.config.js
    │  └─ .eslintrc
    ├─ .babelrc
    ├─ .eslintignore
    ├─ .eslintrc.js
    ├─ .gitignore
    ├─ package.json
    └─ README.md

可以看到我们主要关注的两个文件夹：src/main和src/renderer分别对应的是main进程和renderer进程。我们的开发大体上也是围绕这两个文件夹展开。

electron-vue安装

参考electron-vue官方的文档给出的说明，搭建electron-vue的脚手架非常方便，使用vue-cli来安装它的模板即可：

  1. # 如果你没有vue-cli的话需要全局安装
    npm install -g vue-cli
    # 然后使用vue-cli来安装electron-vue的模板
    vue init simulatedgreg/electron-vue my-project

    # 安装依赖
    cd my-project
    yarn # or npm install
    # 进入开发模式
    yarn run dev # or npm run dev

如果你是windows用户，在安装期间遇到了关于node-gyp、C++库等方面的问题的话，请参考官方文档给出的解决办法。

如果上述都没有问题，那么你将会看到如下界面：

0. electron-vue入门 - 图4

总结

作为开篇，内容不多。不过把东西说清楚是必须的。对于electron开发其实是有两种声音的：

  • 很简单，不过就是web开发换了个壳
  • 很难，需要了解很多原生的概念，不知道要怎么入手

其实从本文介绍完，你应该要有一个粗略的认识。electron的开发其实包括了两个部分，一个是main进程的相关开发，一个是renderer进程的相关开发。对于renderer进程的开发对于大多数前端开发人员来说不难。main进程的相关开发，如果你想要把electron的main进程的所以特性都学一遍、都用一遍，确实是需要不少时间的。不过如果是从需求出发，从工程本身的需要出发，那么只需要用到的时候再去学习即可。不过要对Node.js能做到的事有个概念——它并不是万能的。

下一篇文章将会正式开启electron的开发，如果你对此有兴趣不妨关注我的博客的进展。

0. electron-vue入门 - 图5