Vue+Electron开发跨平台桌面应用

前言css

虽然 B/S 是目前开发的主流,可是 C/S 仍然有很大的市场需求。受限于浏览器的沙盒限制,网页应用没法知足某些场景下的使用需求,而桌面应用能够读写本地文件、调用更多系统资源,再加上 Web 开发的低成本、高效率的优点,这种跨平台方式愈来愈受到开发者的喜好。 html

Electron 是一个基于 Chromium 和 Node.js,使用 HTML、CSS 和 JavaScript 来构建跨平台应用的跨平台开发框架,兼容 Mac、Windows 和 Linux。目前,Electron 已经建立了包括 VScode 和 Atom 在内的大量应用。前端

环境搭建vue

建立 Electron 跨平台应用以前,须要先安装一些经常使用的工具,如 Node、vue 和 Electron 等。node

安装 Nodewebpack

进入 Node 官网下载页 http://nodejs.cn/download/,而后下载对应的版本便可,下载时建议下载稳定版本。若是安装 Node 使用 Homebrew 方式,建议安装时将 npm 仓库镜像改成淘宝镜像,以下所示。git

npm config set registry http://registry.npm.taobao.org/
或者
npm install -g cnpm --registry=https://registry.npm.taobao.orggithub

安装/升级 vue-cliweb

先执行如下命令,确认下本地安装的 vue-cli 版本。vue-router

vue -V

若是没有安装或者不是最新版,能够执行如下命令安装/升级。

npm install @vue/cli -g

安装 Electron

使用以下命令安装 Electron 插件。

npm install -g electron
或者
cnpm install -g electron

为了验证是否安装成功,可使用以下的命令。

electron --version

建立运行项目

Electron 官方提供了一个简单的项目,能够执行如下命令将项目克隆到本地。

git clone https://github.com/electron/e...

而后在项目中执行以下命令便可启动项目。

cd electron-quick-start
npm install
npm start

启动后项目的效果以下图。

除此以外,咱们可使用 vue-cli 脚手架工具来建立项目。

vue init simulatedgreg/electron-vue

而后根据下面的提示一步步选中选项便可建立项目,以下所示。

而后,使用 npm install 命令安装项目所须要的依赖包,安装完成以后,可使用 npm run dev 或 npm run build 命令运行 electron-vue 模版应用程序,运行效果以下图所示。

Electron 源码目录

Electron 的源代码主要依据 Chromium 的拆分约定被拆成了许多部分。为了更好地理解源代码,您可能须要了解一下 Chromium 的多进程架构。

Electron 源码目录结构和含义具体以下:

Electron
├──atom - Electron 的源代码
| ├── app - 系统入口代码
| ├── browser - 包含了主窗口、UI 和其余全部与主进程有关的东西,它会告诉渲染进程如何管理页面
| | ├── lib - 主进程初始化代码中 JavaScript 部分的代码
| | ├── ui - 不一样平台上 UI 部分的实现
| | | ├── cocoa - Cocoa 部分的源代码
| | | ├── gtk - GTK+ 部分的源代码
| | | └── win - Windows GUI 部分的源代码
| | ├── default_app - 在没有指定 app 的状况下 Electron 启动时默认显示的页面
| | ├── api - 主进程 API 的实现
| | | └── lib - API 实现中 Javascript 部分的代码
| | ├── net - 网络相关的代码
| | ├── mac - 与 Mac 有关的 Objective-C 代码
| | └── resources - 图标,平台相关的文件等
| ├── renderer - 运行在渲染进程中的代码
| | ├── lib - 渲染进程初始化代码中 JavaScript 部分的代码
| | └── api - 渲染进程 API 的实现
| | └── lib - API 实现中 Javascript 部分的代码
| └── common - 同时被主进程和渲染进程用到的代码,包括了一些用来将 node 的事件循环
| | 整合到 Chromium 的事件循环中时用到的工具函数和代码
| ├── lib - 同时被主进程和渲染进程使用到的 Javascript 初始化代码
| └── api - 同时被主进程和渲染进程使用到的 API 的实现以及 Electron 内置模块的基础设施
| └── lib - API 实现中 Javascript 部分的代码
├── chromium_src - 从 Chromium 项目中拷贝来的代码
├── docs - 英语版本的文档
├── docs-translations - 各类语言版本的文档翻译
├── spec - 自动化测试
├── atom.gyp - Electron 的构建规则
└── common.gypi - 为诸如 `node` 和 `breakpad` 等其余组件准备的编译设置和构建规则

平时开发时,须要重点关注的就是 src、package.json 和 appveyor.yml 目录。除此以外,其余须要注意的目录以下:

  • script - 用于诸如构建、打包、测试等开发用途的脚本
  • tools - 在 gyp 文件中用到的工具脚本,但与 script 目录不一样, 该目录中的脚本不该该被用户直接调用
  • vendor - 第三方依赖项的源代码,为了防止人们将它与 Chromium 源码中的同名目录相混淆, 在这里咱们不使用 third_party 做为目录名
  • node_modules - 在构建中用到的第三方 node 模块
  • out - ninja 的临时输出目录
  • dist - 由脚本 script/create-dist.py 建立的临时发布目录
  • external_binaries - 下载的不支持经过 gyp 构建的预编译第三方框架

应用工程目录

使用 electron-vue 模版建立的 Electron 工程结构以下图。

和前端工程的项目结构相似,Electron 项目的目录结构以下所示:

  • electron-vue:Electron模版配置。
  • build:文件夹,用来存放项目构建脚本。
  • config:中存放项目的一些基本配置信息,最经常使用的就是端口转发。
  • node_modules:这个目录存放的是项目的全部依赖,即 npm install 命令下载下来的文件。
  • src:这个目录下存放项目的源码,即开发者写的代码放在这里。
  • static:用来存放静态资源。
  • index.html:则是项目的首页、入口页,也是整个项目惟一的HTML页面。
  • package.json:中定义了项目的全部依赖,包括开发时依赖和发布时依赖。

对于开发者来讲, 90% 的工做都是在 src 中完成,src 中的文件目录以下。

Electron 应用程序分红三个基础模块:主进程、进程间通讯和渲染进程。

一、主进程

Electron 运行 package.json 的 main 脚本(background.js)的进程被称为主进程。在主进程中运行的脚本经过建立web页面来展现用户界面。一个 Electron 应用老是有且只有一个主进程。

二、渲染进程

因为 Electron 使用了 Chromium 来展现 Web 页面,因此 Chromium 的多进程架构也被使用到。每一个 Electron 中的 Web 页面运行在它本身的渲染进程中。在普通的浏览器中,Web 页面一般在一个沙盒环境中运行,不被容许去接触原生的资源。然而 Electron 容许用户在 Node.js 的 API 支持下能够在页面中和操做系统进行一些底层交互。

三、主进程与渲染进程通讯

主进程使用 BrowserWindow 实例建立页面。每一个 BrowserWindow 实例都在本身的渲染进程里运行页面。当一个 BrowserWindow 实例被销毁后,相应的渲染进程也会被终止。主进程管理全部的 Web 页面和它们对应的渲染进程。每一个渲染进程都是独立的,它只关心它所运行的 Web 页面。

src 目录结构

在 Electron 目录中,src 会包包含 main 和 renderer 两个目录。

main 目录

main 目录会包含 index.js 和 index.dev.js 两个文件。

  • index.js:应用程序的主文件,electron 也从这里启动的,它也被用做 webpack 产品构建的入口文件,全部的 main 进程工做都应该从这里开始。

    index.dev.js:此文件专门用于开发阶段,由于它会安装 electron-debug 和 vue-devtools。通常不须要修改此文件,但它能够扩展开发的需求。

渲染进程

renderer 是渲染进程目录,平时项目开发源码的存放目录,包含 assets、components、router、store、App.vue 和 main.js。

assets:assets 下的文件如(js、css)都会在 dist 文件夹下面的项目目录分别合并到一个文件里面去。components:此文件用于存放应用开发的组件,能够是自定义的组件。router:若是你了解 vue-router,那么 Electron 项目的路由的使用方式和 vue-router 的使用方式相似。modules:electron-vue 利用 vuex 的模块结构建立多个数据存储,并保存在 src/renderer/store/modules 中。

相关案例

往期

Vue.js纪录片

手摸手教你写出使人窒息的烂代码

[
](http://mp.weixin.qq.com/s?__b...