非常教程

Electron参考手册

指南·开发 | Guides: Development

构建系统概述 | Build System Overview

Electron使用gyp进行项目生成,并使用忍者进行建设。项目配置可以在.gyp.gypi文件中找到。

Gyp文件

以下gyp文件包含了构建Electron的主要规则:

  • electron.gyp 定义了Electron本身的构建方式。
  • common.gypi 调整Node的构建配置以使其与Chromium一起构建。
  • brightray/brightray.gyp定义了如何brightray构建并包含用于与Chromium进行链接的默认配置。
  • brightray/brightray.gypi 包括关于构建的一般构建配置。

组件构建

由于Chromium是一个相当大的项目,最后的连接阶段可能需要几分钟时间,这使得开发变得困难。为了解决这个问题,Chromium引入了“组件构建”,它将每个组件构建为一个单独的共享库,使得链接非常快速,但牺牲了文件大小和性能。

在Electron中,我们采用了非常类似的方法:对于Debug构建,二进制文件将链接到Chromium组件的共享库版本以实现快速链接时间; 对于Release构建,二进制文件将链接到静态库版本,因此我们可以获得最佳的二进制大小和性能。

最小引导

libchromiumcontent在运行引导脚本时,所有Chromium的预先构建的二进制文件()都会被下载。默认情况下,静态库和共享库将被下载,最终大小应该在800MB到2GB之间,具体取决于平台。

默认情况下,libchromiumcontent从Amazon Web Services下载。如果LIBCHROMIUMCONTENT_MIRROR设置了环境变量,则引导脚本将从其下载。libchromiumcontent-qiniu-mirrorlibchromiumcontent的镜像。如果您在访问AWS时遇到问题,可以通过下载地址切换到该地址export LIBCHROMIUMCONTENT_MIRROR=http://7xk3d2.dl1.z0.glb.clouddn.com/

如果您只想快速构建Electron进行测试或开发,则可以通过传递--dev参数来下载共享库版本:

$ ./script/bootstrap.py --dev
$ ./script/build.py -c D

两相项目生成

Electron与不同的两组库的链接ReleaseDebug建立。gyp但是,不支持为不同的配置配置不同的链接设置。

要解决此问题,Electron使用gyp变量libchromiumcontent_component来控制要使用的链接设置,并且在运行时仅生成一个目标gyp

目标名称

与大多数使用ReleaseDebug作为目标名称的项目不同,Electron使用RD替代。这是因为gyp如果只定义了一个ReleaseDebug构建配置,则随机崩溃,并且Electron只需要如上所述一次生成一个目标。

这只会影响开发者,如果你只是建立Electron进行品牌重塑,你不会受到影响。

测试

使用以下命令测试您的更改符合项目编码风格:

$ npm run lint

测试功能使用:

$ npm test

每当您对Electron源代码进行更改时,您需要在测试之前重新运行构建版本:

$ npm run build && npm test

通过使用Mocha的独特测试功能,您可以隔离特定测试或阻止当前正在使用的测试套件,从而加快测试套件的运行速度。只需附加.only到任何函数describeit函数调用:

describe.only('some feature', function () {
  // ... only tests in this block will be run
})

或者,您可以使用mocha的grep选项来仅运行符合给定正则表达式模式的测试:

$ npm test -- --grep child_process

包含本机模块(例如runas)的测试无法使用调试版本执行(详情请参阅#2558),但它们将与版本构建一起使用。

使用发布版本运行测试:

$ npm test -- -R
Electron

Electron 是一个使用 JavaScript, HTML 和 CSS 等 Web 技术创建原生程序的框架,它负责比较难搞的部分,你只需把精力放在你的应用的核心上即可。

主页 https://electron.atom.io/
源码 https://github.com/electron/electron
发布版本 1.7.9

Electron目录

1.指南 | Guides
2.指南·开发 | Guides: Development
3.Webview 组件 |
4.加速器 | Accelerator
5.API
6.API·对象 | API·Objects
7.app
8.autoUpdater
9.浏览器总览 | BrowserView
10.浏览器窗口 | BrowserWindow
11.浏览器窗口代理 | BrowserWindowProxy)
12.ClientRequest
13.剪贴板 | clipboard
14.内容追踪 | contentTracing
15.小型文字档案 | Cookies
16.crashReporter
17.调试器 | Debugger
18.desktopCapturer
19.dialog
20.电子下载 | DownloadItem
21.环境变量 | Environment Variables
22.无框窗口 | Frameless Window
23.globalShortcut
24.IncomingMessage
25.ipcMain
26.IPC渲染器 | ipcRenderer
27.语言环境 | Locales
28.画面 | Menu
29.MenuItem
30.本地图像 | nativeImage
31.net
32.通知 | Notification
33.权限监控 | powerMonitor
34.权限存储拦截器 | powerSaveBlocker
35.处理 | process
36.协议 | protocol
37.远程 | remote
38.sandbox
39.屏幕 | screen
40.会话 | session
41.shell
42.系统表现 | systemPreferences
43.触摸板 | TouchBar
44.触摸板按钮 | TouchBarButton
45.触摸板颜色选择器 | TouchBarColorPicker
46.触摸板组 | TouchBarGroup
47.触摸板标签 | TouchBarLabel
48.触摸板弹出框 | TouchBarPopover
49.触摸板清理 | TouchBarScrubber
50.触摸板分段控制 | TouchBarSegmentedControl
51.触摸板滑块 | TouchBarSlider
52.触摸板间隔 | TouchBarSpacer
53.Tray
54.网页内容 | webContents
55.网页框架 | webFrame
56.网页要求 | WebRequest
57.窗口开启 | window.open