Electron 快速入門

2022-01-08 15:03 更新

快速入門

簡(jiǎn)介

Electron 可以讓你使用純 JavaScript 調(diào)用豐富的原生 APIs 來(lái)創(chuàng)造桌面應(yīng)用。你可以把它看作是專注于桌面應(yīng)用而不是 web 服務(wù)器的，io.js 的一個(gè)變體。

這不意味著 Electron 是綁定了 GUI 庫(kù)的 JavaScript。相反，Electron 使用 web 頁(yè)面作為它的 GUI，所以你能把它看作成一個(gè)被 JavaScript 控制的，精簡(jiǎn)版的 Chromium 瀏覽器。

主進(jìn)程

在 Electron 里，運(yùn)行 package.json 里 main 腳本的進(jìn)程被稱為主進(jìn)程。在主進(jìn)程運(yùn)行的腳本可以以創(chuàng)建 web 頁(yè)面的形式展示 GUI。

渲染進(jìn)程

由于 Electron 使用 Chromium 來(lái)展示頁(yè)面，所以 Chromium 的多進(jìn)程結(jié)構(gòu)也被充分利用。每個(gè) Electron 的頁(yè)面都在運(yùn)行著自己的進(jìn)程，這樣的進(jìn)程我們稱之為渲染進(jìn)程。

在一般瀏覽器中，網(wǎng)頁(yè)通常會(huì)在沙盒環(huán)境下運(yùn)行，并且不允許訪問(wèn)原生資源。然而，Electron 用戶擁有在網(wǎng)頁(yè)中調(diào)用 io.js 的 APIs 的能力，可以與底層操作系統(tǒng)直接交互。

主進(jìn)程與渲染進(jìn)程的區(qū)別

主進(jìn)程使用 BrowserWindow 實(shí)例創(chuàng)建網(wǎng)頁(yè)。每個(gè) BrowserWindow 實(shí)例都在自己的渲染進(jìn)程里運(yùn)行著一個(gè)網(wǎng)頁(yè)。當(dāng)一個(gè) BrowserWindow 實(shí)例被銷毀后，相應(yīng)的渲染進(jìn)程也會(huì)被終止。

主進(jìn)程管理所有頁(yè)面和與之對(duì)應(yīng)的渲染進(jìn)程。每個(gè)渲染進(jìn)程都是相互獨(dú)立的，并且只關(guān)心他們自己的網(wǎng)頁(yè)。

由于在網(wǎng)頁(yè)里管理原生 GUI 資源是非常危險(xiǎn)而且容易造成資源泄露，所以在網(wǎng)頁(yè)面調(diào)用 GUI 相關(guān)的 APIs 是不被允許的。如果你想在網(wǎng)頁(yè)里使用 GUI 操作，其對(duì)應(yīng)的渲染進(jìn)程必須與主進(jìn)程進(jìn)行通訊，請(qǐng)求主進(jìn)程進(jìn)行相關(guān)的 GUI 操作。

在 Electron，我們提供用于在主進(jìn)程與渲染進(jìn)程之間通訊的 ipc 模塊。并且也有一個(gè)遠(yuǎn)程進(jìn)程調(diào)用風(fēng)格的通訊模塊 remote。

打造你第一個(gè) Electron 應(yīng)用

大體上，一個(gè) Electron 應(yīng)用的目錄結(jié)構(gòu)如下：

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

package.json的格式和 Node 的完全一致，并且那個(gè)被 main 字段聲明的腳本文件是你的應(yīng)用的啟動(dòng)腳本，它運(yùn)行在主進(jìn)程上。你應(yīng)用里的 package.json 看起來(lái)應(yīng)該像：

{
  "name"    : "your-app",
  "version" : "0.1.0",
  "main"    : "main.js"
}

注意：如果 main 字段沒有在 package.json 聲明，Electron會(huì)優(yōu)先加載 index.js。

main.js 應(yīng)該用于創(chuàng)建窗口和處理系統(tǒng)事件，一個(gè)典型的例子如下：

var app = require('app');  // 控制應(yīng)用生命周期的模塊。
var BrowserWindow = require('browser-window');  // 創(chuàng)建原生瀏覽器窗口的模塊

// 保持一個(gè)對(duì)于 window 對(duì)象的全局引用，不然，當(dāng) JavaScript 被 GC，
// window 會(huì)被自動(dòng)地關(guān)閉
var mainWindow = null;

// 當(dāng)所有窗口被關(guān)閉了，退出。
app.on('window-all-closed', function() {
  // 在 OS X 上，通常用戶在明確地按下 Cmd + Q 之前
  // 應(yīng)用會(huì)保持活動(dòng)狀態(tài)
  if (process.platform != 'darwin') {
    app.quit();
  }
});

// 當(dāng) Electron 完成了初始化并且準(zhǔn)備創(chuàng)建瀏覽器窗口的時(shí)候
// 這個(gè)方法就被調(diào)用
app.on('ready', function() {
  // 創(chuàng)建瀏覽器窗口。
  mainWindow = new BrowserWindow({width: 800, height: 600});

  // 加載應(yīng)用的 index.html
  mainWindow.loadURL('file://' + __dirname + '/index.html');

  // 打開開發(fā)工具
  mainWindow.openDevTools();

  // 當(dāng) window 被關(guān)閉，這個(gè)事件會(huì)被觸發(fā)
  mainWindow.on('closed', function() {
    // 取消引用 window 對(duì)象，如果你的應(yīng)用支持多窗口的話，
    // 通常會(huì)把多個(gè) window 對(duì)象存放在一個(gè)數(shù)組里面，
    // 但這次不是。
    mainWindow = null;
  });
});

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

<!DOCTYPE html>
<html>
  <head>
    <title>Hello World!</title>
  </head>
  <body>
    <h1>Hello World!</h1>
    We are using io.js <script>document.write(process.version)</script>
    and Electron <script>document.write(process.versions['electron'])</script>.
  </body>
</html>

運(yùn)行你的應(yīng)用

一旦你創(chuàng)建了最初的 main.js， index.html 和 package.json 這幾個(gè)文件，你可能會(huì)想嘗試在本地運(yùn)行并測(cè)試，看看是不是和期望的那樣正常運(yùn)行。

electron-prebuild

如果你已經(jīng)用 npm 全局安裝了 electron-prebuilt，你只需要按照如下方式直接運(yùn)行你的應(yīng)用：

electron .

如果你是局部安裝，那運(yùn)行：

./node_modules/.bin/electron .

手工下載 Electron 二進(jìn)制文件

如果你手工下載了 Electron 的二進(jìn)制文件，你也可以直接使用其中的二進(jìn)制文件直接運(yùn)行你的應(yīng)用。

Windows

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

Linux

$ ./electron/electron your-app/

OS X

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

Electron.app 里面是 Electron 發(fā)布包，你可以在這里下載到。

以發(fā)行版本運(yùn)行

在你完成了你的應(yīng)用后，你可以按照

應(yīng)用部署

指導(dǎo)發(fā)布一個(gè)版本，并且以已經(jīng)打包好的形式運(yùn)行應(yīng)用。

以上內(nèi)容是否對(duì)您有幫助：

← Electron 教程簡(jiǎn)介

Electron 桌面環(huán)境集成 →

寫筆記

我要補(bǔ)充