• 快速入门
    • 简介
    • 主进程
    • 渲染进程
    • 主进程与渲染进程的区别
  • 打造你第一个 Electron 应用
  • 运行你的应用
    • electron-prebuild
    • 手工下载 Electron 二进制文件
      • Windows
      • Linux
      • OS X
  • 以发行版本运行

    快速入门

    简介

    Electron 可以让你使用纯 JavaScript 调用丰富的原生 APIs 来创造桌面应用。你可以把它看作是专注于桌面应用而不是 web 服务器的，io.js 的一个变体。

    这不意味着 Electron 是绑定了 GUI 库的 JavaScript。相反，Electron 使用 web 页面作为它的 GUI，所以你能把它看作成一个被 JavaScript 控制的，精简版的 Chromium 浏览器。

    主进程

    在 Electron 里，运行 package.json 里 main 脚本的进程被称为主进程。在主进程运行的脚本可以以创建 web 页面的形式展示 GUI。

    渲染进程

    由于 Electron 使用 Chromium 来展示页面，所以 Chromium 的多进程结构也被充分利用。每个 Electron 的页面都在运行着自己的进程，这样的进程我们称之为渲染进程。

    在一般浏览器中，网页通常会在沙盒环境下运行，并且不允许访问原生资源。然而，Electron 用户拥有在网页中调用 io.js 的 APIs 的能力，可以与底层操作系统直接交互。

    主进程与渲染进程的区别

    主进程使用 BrowserWindow 实例创建网页。每个 BrowserWindow 实例都在自己的渲染进程里运行着一个网页。当一个 BrowserWindow 实例被销毁后，相应的渲染进程也会被终止。

    主进程管理所有页面和与之对应的渲染进程。每个渲染进程都是相互独立的，并且只关心他们自己的网页。

    由于在网页里管理原生 GUI 资源是非常危险而且容易造成资源泄露，所以在网页面调用 GUI 相关的 APIs 是不被允许的。如果你想在网页里使用 GUI 操作，其对应的渲染进程必须与主进程进行通讯，请求主进程进行相关的 GUI 操作。

    在 Electron，我们提供用于在主进程与渲染进程之间通讯的 ipc 模块。并且也有一个远程进程调用风格的通讯模块 remote。

    打造你第一个 Electron 应用

    大体上，一个 Electron 应用的目录结构如下：

    1. your-app/
    2. ├── package.json
    3. ├── main.js
    4. └── index.html

    package.json的格式和 Node 的完全一致，并且那个被 main 字段声明的脚本文件是你的应用的启动脚本，它运行在主进程上。你应用里的 package.json 看起来应该像：

    1. {
    2.   "name"    : "your-app",
    3.   "version" : "0.1.0",
    4.   "main"    : "main.js"
    5. }

    注意：如果 main 字段没有在 package.json 声明，Electron会优先加载 index.js。

    main.js 应该用于创建窗口和处理系统时间，一个典型的例子如下：

    1. var app = require('app');  // 控制应用生命周期的模块。
    2. var BrowserWindow = require('browser-window');  // 创建原生浏览器窗口的模块
    4. // 保持一个对于 window 对象的全局引用，不然，当 JavaScript 被 GC，
    5. // window 会被自动地关闭
    6. var mainWindow = null;
    8. // 当所有窗口被关闭了，退出。
    9. app.on('window-all-closed', function() {
    10.   // 在 OS X 上，通常用户在明确地按下 Cmd + Q 之前
    11.   // 应用会保持活动状态
    12.   if (process.platform != 'darwin') {
    13.     app.quit();
    14.   }
    15. });
    17. // 当 Electron 完成了初始化并且准备创建浏览器窗口的时候
    18. // 这个方法就被调用
    19. app.on('ready', function() {
    20.   // 创建浏览器窗口。
    21.   mainWindow = new BrowserWindow({width: 800, height: 600});
    23.   // 加载应用的 index.html
    24.   mainWindow.loadURL('file://' + __dirname + '/index.html');
    26.   // 打开开发工具
    27.   mainWindow.openDevTools();
    29.   // 当 window 被关闭，这个事件会被发出
    30.   mainWindow.on('closed', function() {
    31.     // 取消引用 window 对象，如果你的应用支持多窗口的话，
    32.     // 通常会把多个 window 对象存放在一个数组里面，
    33.     // 但这次不是。
    34.     mainWindow = null;
    35.   });
    36. });

    最后，你想展示的 index.html ：

    1. <!DOCTYPE html>
    2. <html>
    3.   <head>
    4.     <title>Hello World!</title>
    5.   </head>
    6.   <body>
    7.     <h1>Hello World!</h1>
    8.     We are using io.js <script>document.write(process.version)</script>
    9.     and Electron <script>document.write(process.versions['electron'])</script>.
    10.   </body>
    11. </html>

    运行你的应用

    一旦你创建了最初的 main.js， index.html 和 package.json 这几个文件，你可能会想尝试在本地运行并测试，看看是不是和期望的那样正常运行。

    electron-prebuild

    如果你已经用 npm 全局安装了 electron-prebuilt，你只需要按照如下方式直接运行你的应用：

    1. electron .

    如果你是局部安装，那运行：

    1. ./node_modules/.bin/electron .

    手工下载 Electron 二进制文件

    如果你手工下载了 Electron 的二进制文件，你也可以直接使用其中的二进制文件直接运行你的应用。

    Windows

    1. $ .\electron\electron.exe your-app\

    Linux

    1. $ ./electron/electron your-app/

    OS X

    1. $ ./Electron.app/Contents/MacOS/Electron your-app/

    Electron.app 里面是 Electron 发布包，你可以在这里下载到。

    以发行版本运行

    在你完成了你的应用后，你可以按照应用部署指导发布一个版本，并且以已经打包好的形式运行应用。