打造你的第一个 Electron 应用

Electron 可以让你使用纯 JavaScript 调用丰富的原生(操作系统) APIs 来创造桌面应用。 你可以把它看作一个专注于桌面应用的 Node. js 的变体,而不是 Web 服务器。

这不意味着 Electron 是某个图形用户界面(GUI)库的 JavaScript 版本。 相反,Electron 使用 web 页面作为它的 GUI,所以你能把它看作成一个被 JavaScript 控制的,精简版的 Chromium 浏览器。

注意 : 获取该示例的代码仓库: 立即下载并运行

从开发的角度来看, Electron application 本质上是一个 Node. js 应用程序。 与 Node.js 模块相同,应用的入口是 package.json 文件。 一个最基本的 Electron 应用一般来说会有如下的目录结构:

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

为你的新Electron应用创建一个新的空文件夹。 打开你的命令行工具,然后从该文件夹运行npm init

  1. npm init

npm 会帮助你创建一个基本的 package.json 文件。 其中的 main 字段所表示的脚本为应用的启动脚本,它将会在主进程中执行。 如下片段是一个 package.json 的示例:

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

注意:如果 main 字段没有在 package.json 中出现,那么 Electron 将会尝试加载 index.js 文件(就像 Node.js 自身那样)。 如果你实际开发的是一个简单的 Node 应用,那么你需要添加一个 start 脚本来指引 node 去执行当前的 package:

  1. {
  2. "name": "your-app",
  3. "version": "0.1.0",
  4. "main": "main.js",
  5. "scripts": {
  6. "start": "node ."
  7. }
  8. }

把这个 Node 应用转换成一个 Electron 应用也是非常简单的,我们只不过是把 node 运行时替换成了 electron 运行时。

  1. {
  2. "name": "your-app",
  3. "version": "0.1.0",
  4. "main": "main.js",
  5. "scripts": {
  6. "start": "electron ."
  7. }
  8. }

安装 Electron

现在,您需要安装electron。 我们推荐的安装方法是把它作为您 app 中的开发依赖项,这使您可以在不同的 app 中使用不同的 Electron 版本。 在您的app所在文件夹中运行下面的命令:

  1. npm install --save-dev electron

除此之外,也有其他安装 Electron 的途径。 请咨询安装指南来了解如何用代理、镜像和自定义缓存。

开发一个简易的 Electron

Electron apps 使用JavaScript开发,其工作原理和方法与Node.js 开发相同。 electron模块包含了Electron提供的所有API和功能,引入方法和普通Node.js模块一样:

  1. const electron = require('electron')

electron 模块所提供的功能都是通过命名空间暴露出来的。 比如说: electron.app负责管理Electron 应用程序的生命周期, electron.BrowserWindow类负责创建窗口。 下面是一个简单的main.js文件,它将在应用程序准备就绪后打开一个窗口:

  1. const { app, BrowserWindow } = require('electron')
  2. function createWindow () {
  3. // 创建浏览器窗口
  4. let win = new BrowserWindow({ width: 800, height: 600 })
  5. // 然后加载 app 的 index.html.
  6. win.loadFile('index.html')
  7. }
  8. app.on('ready', createWindow)

您应当在 main.js 中创建窗口,并处理程序中可能遇到的所有系统事件。 下面我们将完善上述例子,添加以下功能:打开开发者工具、处理窗口关闭事件、在macOS用户点击dock上图标时重建窗口,添加后,main. js 就像下面这样:

  1. const { app, BrowserWindow } = require('electron')
  2. // 保持对window对象的全局引用,如果不这么做的话,当JavaScript对象被
  3. // 垃圾回收的时候,window对象将会自动的关闭
  4. let win
  5. function createWindow () {
  6. // 创建浏览器窗口。
  7. win = new BrowserWindow({ width: 800, height: 600 })
  8. // 然后加载应用的 index.html。
  9. win.loadFile('index.html')
  10. // 打开开发者工具
  11. win.webContents.openDevTools()
  12. // 当 window 被关闭,这个事件会被触发。
  13. win.on('closed', () => {
  14. // 取消引用 window 对象,如果你的应用支持多窗口的话,
  15. // 通常会把多个 window 对象存放在一个数组里面,
  16. // 与此同时,你应该删除相应的元素。
  17. win = null
  18. })
  19. }
  20. // Electron 会在初始化后并准备
  21. // 创建浏览器窗口时,调用这个函数。
  22. // 部分 API 在 ready 事件触发后才能使用。
  23. app.on('ready', createWindow)
  24. // 当全部窗口关闭时退出。
  25. app.on('window-all-closed', () => {
  26. // 在 macOS 上,除非用户用 Cmd + Q 确定地退出,
  27. // 否则绝大部分应用及其菜单栏会保持激活。
  28. if (process.platform !== 'darwin') {
  29. app.quit()
  30. }
  31. })
  32. app.on('activate', () => {
  33. // 在macOS上,当单击dock图标并且没有其他窗口打开时,
  34. // 通常在应用程序中重新创建一个窗口。
  35. if (win === null) {
  36. createWindow()
  37. }
  38. })
  39. // 在这个文件中,你可以续写应用剩下主进程代码。
  40. // 也可以拆分成几个文件,然后用 require 导入。

最后,创建你想展示的 index.html

  1. <!DOCTYPE html>
  2. <html>
  3. <head>
  4. <meta charset="UTF-8">
  5. <title>Hello World!</title>
  6. </head>
  7. <body>
  8. <h1>Hello World!</h1>
  9. We are using node <script>document.write(process.versions.node)</script>,
  10. Chrome <script>document.write(process.versions.chrome)</script>,
  11. and Electron <script>document.write(process.versions.electron)</script>.
  12. </body>
  13. </html>

启动你的应用

在创建并初始化完成 main.jsindex.htmlpackage.json之后,您就可以在当前工程的根目录执行 npm start 命令来启动刚刚编写好的Electron程序了。

尝试此例

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

注意:本例需要 Gitnpm 来运行。

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

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