1. 简介
Electron是一个使用 JavaScript、HTML 和 CSS 构建桌面应用程序的框架。 嵌入 Chromium 和 Node.js 到 二进制的 Electron 允许您保持一个 JavaScript 代码代码库并创建 在Windows上运行的跨平台应用 macOS和Linux——不需要本地开发 经验。
2. 快速入门
本指南将会通过使用Electron创建一个极简的 Hello World 应用一步步的带你了解,该应用与electron/electron-quick-start
类似。
通过这个教程,你的app将会打开一个浏览器窗口,来展示包含当前正在运行的 Chromium, Node.js与 Electronweb等版本信息的web界面
2.1. Prerequisites
在使用Electron进行开发之前,您需要安装 Node.js。 我们建议您使用最新的LTS版本。
请使用为你平台预构建的 Node.js 安装器来进行安装, 否则,您可能会遇到与不同开发工具不兼容的问题。
要检查 Node.js 是否正确安装,请在您的终端输入以下命令:
1 | node -v |
这两个命令应输出了 Node.js 和 npm 的版本信息。
注意 因为 Electron 将 Node.js 嵌入到其二进制文件中,你应用运行时的 Node.js 版本与你系统中运行的 Node.js 版本无关。
2.2. 创建你的应用程序
2.2.1. 使用脚手架创建
Electron 应用程序遵循与其他 Node.js 项目相同的结构。 首先创建一个文件夹并初始化 npm 包。
- npm
- Yarn
1 | mkdir my-electron-app && cd my-electron-app |
init
初始化命令会提示您在项目初始化配置中设置一些值 为本教程的目的,有几条规则需要遵循:
entry point
应为main.js
.author
与description
可为任意值,但对于应用打包是必填项。
你的 package.json
文件应该像这样:
1 | { |
然后,将 electron
包安装到应用的开发依赖中。
- npm
- Yarn
1 | yarn add --dev electron |
注意:如果您在安装 Electron 时遇到任何问题,请 参见 高级安装 指南。
最后,您希望能够执行 Electron 如下所示,在您的 package.json
配置文件中的scripts
字段下增加一条start
命令:
1 | { |
start
命令能让您在开发模式下打开您的应用
- npm
- Yarn
1 | yarn start |
注意:此脚本将告诉 Electron 在您项目根目录运行 此时,您的应用将立即抛出一个错误提示您它无法找到要运行的应用
2.2.2. 运行主进程
任何 Electron 应用程序的入口都是 main
文件。 这个文件控制了主进程,它运行在一个完整的Node.js环境中,负责控制您应用的生命周期,显示原生界面,执行特殊操作并管理渲染器进程(稍后详细介绍)。
执行期间,Electron 将依据应用中 package.json
配置下main
字段中配置的值查找此文件,您应该已在应用脚手架步骤中配置。
要初始化这个main
文件,需要在您项目的根目录下创建一个名为main.js
的空文件。
注意:如果您此时再次运行
start
命令,您的应用将不再抛出任何错误! 然而,它不会做任何事因为我们还没有在main.js
中添加任何代码。
2.2.3. 创建页面
在可以为我们的应用创建窗口前,我们需要先创建加载进该窗口的内容。 在 Electron 中,每个窗口中无论是本地的HTML文件还是远程URL都可以被加载显示。
此教程中,您将采用本地HTML的方式。 在您的项目根目录下创建一个名为index.html
的文件:
1 |
|
注意:在这个HTML文本中,您会发现主体文本中丢失了版本编号。 稍后我们将使用 JavaScript 动态插入它们。
2.2.4. 在窗口中打开您的页面
现在您有了一个页面,将它加载进应用窗口中。 要做到这一点,你需要 两个Electron模块:
app
模块,它控制应用程序的事件生命周期。BrowserWindow
模块,它创建和管理应用程序 窗口。
因为主进程运行着Node.js,您可以在文件头部将他们导入作为公共JS模块:
1 | const { app, BrowserWindow } = require('electron') |
然后,添加一个createWindow()
方法来将index.html
加载进一个新的BrowserWindow
实例。
1 | function createWindow () { |
接着,调用createWindow()
函数来打开您的窗口。
在 Electron 中,只有在 app
模块的 ready
事件被激发后才能创建浏览器窗口。 您可以通过使用 app.whenReady()
API来监听此事件。 在whenReady()
成功后调用createWindow()
。
1 | app.whenReady().then(() => { |
注意:此时,您的电子应用程序应当成功 打开显示您页面的窗口!
2.2.5. 管理窗口的生命周期
虽然你现在可以打开一个浏览器窗口,但你还需要一些额外的模板代码使其看起来更像是各平台原生的。 应用程序窗口在每个OS下有不同的行为,Electron将在app中实现这些约定的责任交给开发者们。
一般而言,你可以使用 进程
全局的 platform
属性来专门为某些操作系统运行代码。
2.2.5.1. 关闭所有窗口时退出应用 (Windows & Linux)
在Windows和Linux上,关闭所有窗口通常会完全退出一个应用程序。
To implement this, listen for the app
module’s 'window-all-closed'
event, and call app.quit()
if the user is not on macOS (darwin
).
1 | app.on('window-all-closed', function () { |
2.2.5.2. 如果没有窗口打开则打开一个窗口 (macOS)
当 Linux 和 Windows 应用在没有窗口打开时退出了,macOS 应用通常即使在没有打开任何窗口的情况下也继续运行,并且在没有窗口可用的情况下激活应用时会打开新的窗口。
为了实现这一特性,监听 app
模块的 activate
事件。如果没有任何浏览器窗口是打开的,则调用 createWindow()
方法。
因为窗口无法在 ready
事件前创建,你应当在你的应用初始化后仅监听 activate
事件。 通过在您现有的 whenReady()
回调中附上您的事件监听器来完成这个操作。
1 | app.whenReady().then(() => { |
注意:此时,您的窗口控件应功能齐全!
2.2.6. 通过预加载脚本从渲染器访问Node.js。
现在,最后要做的是输出Electron的版本号和它的依赖项到你的web页面上。
在主进程通过Node的全局 process
对象访问这个信息是微不足道的。 然而,你不能直接在主进程中编辑DOM,因为它无法访问渲染器 文档
上下文。 它们存在于完全不同的进程!
注意:如果您需要更深入地了解Electron进程,请参阅 进程模型 文档。
这是将 预加载 脚本连接到渲染器时派上用场的地方。 预加载脚本在渲染器进程加载之前加载,并有权访问两个 渲染器全局 (例如 window
和 document
) 和 Node.js 环境。
创建一个名为 preload.js
的新脚本如下:
1 | window.addEventListener('DOMContentLoaded', () => { |
上面的代码访问 Node.js process.versions
对象,并运行一个基本的 replaceText
辅助函数将版本号插入到 HTML 文档中。
要将此脚本附加到渲染器流程,请在你现有的 BrowserWindow
构造器中将路径中的预加载脚本传入 webPreferences.preload
选项。
1 | // 在文件头部引入 Node.js 中的 path 模块 |
这里使用了两个Node.js概念:
我们使用一个相对当前正在执行JavaScript文件的路径,这样您的相对路径将在开发模式和打包模式中都将有效。
2.2.7. 额外:将功能添加到您的网页内容
此刻,您可能想知道如何为您的应用程序添加更多功能。
对于与您的网页内容的任何交互,您想要将脚本添加到您的渲染器进程中。 由于渲染器运行在正常的 Web 环境中,因此您可以在 index.html
文件关闭 </body>
标签之前添加一个 <script>
标签,来包括您想要的任意脚本:
1 | <script src="./renderer.js"></script> |
复制
然后,renderer.js
中包含的代码可以使用与典型前端开发相同的 JavaScript API 和工具,例如使用 webpack
来捆绑和缩小您的代码或使用 React 来管理您的用户界面。
2.2.8. 回顾
完成上述步骤后,您应该有一个功能齐全的Electron程序,如下所示:
完整代码如下:
1 | // main.js |
1 | // preload.js |
1 | <!--index.html--> |
总结我们所做的所有步骤:
我们启动了一个Node.js程序,并将Electron添加为依赖。
- 我们创建了一个
main.js
脚本来运行我们的主要进程,它控制我们的应用程序 并且在 Node.js 环境中运行。 在此脚本中, 我们使用 Electron 的app
和BrowserWindow
模块来创建一个浏览器窗口,在一个单独的进程(渲染器)中显示网页内容。 - 为了访问渲染器中的Node.js的某些功能,我们在
BrowserWindow
的构造函数上附加了一个预加载脚本。
3. 安装指导
安装淘宝镜像
1 | npm install cnpm -g --registry=http://registry.npm.taobao.org |
使用cnpm安装electron
1 | cnpm install electron -g |
使用cnpm安装electron-packager
1 | cnpm install electron-packager -g |