Electron指南 - 快速入门

2016-07-04 13:08:00

快速入门

Electron提供了丰富的本地（操作系统）的API，使你能够使用纯JavaScript来创建桌面应用程序。与其它各种的Node.js运行时不同的是Electron专注于桌面应用程序而不是Web服务器。

这并不意味着Electron是一个绑定图形用户界面（GUI）的JavaScript库。取而代之的是，Electron使用Web页面作为它的图形界面，所以你也可以将它看作是一个由JavaScript控制的迷你的Chrominum浏览器。

主进程

在Electron里，运行package.json里的main脚本的进程被称为主进程，运行在主进程里的脚本能够通过创建Web页面来显示GUI。

渲染进程

因为Electron使用Chrominum来显示Web页面，所以Chrominum的多进程架构也同样被使用。每个页面在Electron里是运行在自己的进程里，这些进程被称为渲染进程。
在浏览器里，Web页面通常运行在一个沙盒环境里，它不能访问本地的资源。但在Electron里，在Web页面中通过使用Node.js API可以进行底层的操作系统交互。

主进程与渲染进程的不同

主进程通过构造 BrowserWindow 实例来创建Web页面。每个 BrowserWindow 实例在自己的渲染进程里运行Web页面。当一个 BrowserWindow 被销毁后，相应的渲染进程也同样被终止。

主进程管理所有的Web页面以及相关的渲染进程。每个渲染进程都是互相隔离的，并且只知道运行在该进程里的Web页面。

在Web页面里，调用本地GUI是不允许的，因为在Web页面里管理本地GUI资源是非常危险的而且非常容易导致资源泄露。如果你想在Web页面进行GUI操作，该Web页面的渲染进程必须通过和主进程通信来请求主进程处理这些操作。

在Electron里，主进程和渲染进程有很多通信的方法。比如 ipcRanderer 和 ipcMain 模块是用来发送消息的，remote 模块支持RPC风格的通信。可以参考FAQ里的如何在不同的Web页面里共享数据

编写第一个Electron应用

通常，一个Electron应用的结构类似下面：

your-app/├── package.json├── main.js└── index.html

package.json 的格式与Node的模块格式是一致的，其中 main 字段指定的脚本就是你应用的启动脚本，该脚本将运行在主进程中。你的 package.json 也许看上去像下面这个例子：

{
"name" : "your-app",
"version" : "0.1.0",
"main" : "main.js"
}
注意如果在package.json 中的 main 字段没有指定，那么Electron将尝试装载一个名为 index.js 的脚本。

main.js 应当创建窗口并且处理系统事件，一个典型的例子如下：

const electron = require('electron');
// 控制应用生命周期的模块
const {app} = electron;
// 创建本地浏览器窗口的模块
const {BrowserWindow} = electron;

// 指向窗口对象的一个全局引用，如果没有这个引用，那么当该javascript对象被垃圾回收的
// 时候该窗口将会自动关闭
let win;

function createWindow() {
// 创建一个新的浏览器窗口
win = new BrowserWindow({width: 800, height: 600});

// 并且装载应用的index.html页面
win.loadURL(file://${__dirname}/index.html);

// 打开开发工具页面
win.webContents.openDevTools();

// 当窗口关闭时调用的方法
win.on('closed', () => {
// 解除窗口对象的引用，通常而言如果应用支持多个窗口的话，你会在一个数组里
// 存放窗口对象，在窗口关闭的时候应当删除相应的元素。
win = null;
});
}

// 当Electron完成初始化并且已经创建了浏览器窗口，则该方法将会被调用。
// 有些API只能在该事件发生后才能被使用。
app.on('ready', createWindow);

// 当所有的窗口被关闭后退出应用
app.on('window-all-closed', () => {
// 对于OS X系统，应用和相应的菜单栏会一直激活直到用户通过Cmd + Q显式退出
if (process.platform !== 'darwin') {
app.quit();
}
});

app.on('activate', () => {
// 对于OS X系统，当dock图标被点击后会重新创建一个app窗口，并且不会有其他
// 窗口打开
if (win === null) {
createWindow();
}
});

// 在这个文件后面你可以直接包含你应用特定的由主进程运行的代码。
// 也可以把这些代码放在另一个文件中然后在这里导入。
最后 index.html 则是你想要展示在窗口中：

Hello World!# Hello World!We are using node document.write(process.versions.node),Chrome document.write(process.versions.chrome),and Electron document.write(process.versions.electron).