Electron学习笔记 1 快速入门

Electron 快速入门

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 9 版本
大体上,一个 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”
}

注意:如果 main 字段没有在 package.json 声明,Electron会优先加载 index.js。
main.js 应该用于创建窗口和处理系统时间,一个典型的例子如下:

const { app, BrowserWindow } = require('electron')

function createWindow () {   
  // 创建浏览器窗口
  const win = new BrowserWindow({
    width: 800,
    height: 600,
    webPreferences: {
      nodeIntegration: true
    }
  })

  // 并且为你的应用加载index.html
  win.loadFile('index.html')

  // 打开开发者工具
  win.webContents.openDevTools()
}

// Electron会在初始化完成并且准备好创建浏览器窗口时调用这个方法
// 部分 API 在 ready 事件触发后才能使用。
app.whenReady().then(createWindow)

//当所有窗口都被关闭后退出
app.on('window-all-closed', () => {
  // 在 macOS 上,除非用户用 Cmd + Q 确定地退出,
  // 否则绝大部分应用及其菜单栏会保持激活。
  if (process.platform !== 'darwin') {
    app.quit()
  }
})

app.on('activate', () => {
  // 在macOS上,当单击dock图标并且没有其他窗口打开时,
  // 通常在应用程序中重新创建一个窗口。
  if (BrowserWindow.getAllWindows().length === 0) {
    createWindow()
  }
})

// 您可以把应用程序其他的流程写在在此文件中
// 代码 也可以拆分成几个文件,然后用 require 导入。

最后,你想展示的 index.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>

运行你的应用
一旦你创建了最初的 main.js, index.html 和 package.json 这几个文件,你可能会想尝试在本地运行并测试,看看是不是和期望的那样正常运行。
electron-prebuild
如果你已经用 npm 全局安装了 electron-prebuilt,你只需要按照如下方式直接运行你的应用:

electron .

如果你是局部安装,那运行:
./node_modules/.bin/electron .
npm instlal electron-prebuilt --save-dev 将 electron 安装当前项目中
如果全局安装可以使用 npm install -g electron
手工下载 Electron 二进制文件
如果你手工下载了 Electron 的二进制文件,你也可以直接使用其中的二进制文件直接运行你的应用。
Windows
$ .electronelectron.exe your-app

Linux
$ ./electron/electron your-app/

OS X
$ ./Electron.app/Contents/MacOS/Electron your-app/
运行结果如下
Electron学习笔记 1 快速入门_第1张图片有个问题: 本人electron使用9.0.0 ,但运行时后发现是8.3.0.

Electron.app 里面是 Electron 发布包,你可以在这里下载到。
以发行版本运行
在你完成了你的应用后,你可以按照
应用部署指导发布一个版本,并且以已经打包好的形式运行应用。

运行一个electron小demo出现的一个错误信息:Cannot find module app

原代码如下所示:

var app = require('app');
var BrowserWindow = require('browser-window');

修改为如下这样,就不会弹出“Cannot find module app”相关的错误信息:

const electron = require('electron');
const app = electron.app;
const BrowserWindow = electron.BrowserWindow;

错误原因:使用的Electron版本太新,这种API在 Electron v1.0.0 中被移除了。

再出现 “Cannot find module …” 的错误,基本上全是因为require直接引入模块了,其他模块的引入如果仿照还出错就得现查API了。

尝试此例

复制并运行这个库 electron/electron-quick-start。

Note: Running this requires Git and npm.

# 克隆这仓库
$ git clone https://github.com/electron/electron-quick-start
# 进入仓库
$ cd electron-quick-start
# 安装依赖库
$ npm install
# 运行应用
$ npm start

启动开发过程的有关模板文件和工具列表, 请参阅模板文件和 CLI 文档 。

你可能感兴趣的:(electron)