源代码目录结构

Electron 的源代码主要依据 Chromium 的拆分约定被拆成了许多部分。

为了更好地理解源代码,您可能需要了解一下 Chromium 的多进程架构

源代码结构

  1. Electron
  2. ├── atom/ - C ++源代码.
  3. | ├── app/ - 系统入口代码
  4. | ├── browser/ - 前端包含了主窗口、UI 和其他所有与主进程有关的东西,它会告诉渲染进程如何管理页面
  5. | | ├── ui/ - 不同平台上 UI 部分的实现
  6. | | | ├── cocoa/ - Cocoa特定的源代码
  7. | | | ├── win/ - Windows GUI特定的源代码
  8. | | | └── x/ - X11 特定的源代码
  9. | | ├── api/ - 主进程 API 的实现
  10. | | ├── net/ - 网络相关的代码
  11. | | ├── mac/ - Mac特定的Objective-C源代码
  12. | | └── resources/ -图标,平台相关的文件等
  13. | ├── renderer/ - 在渲染器进程中运行的代码
  14. | | └── api/ - 渲染器进程API的实现
  15. | └── common/ - 同时被主进程和渲染进程用到的代码,包括了一些用来将 node 的事件循环
  16. | | 整合到 Chromium 的事件循环中时用到的工具函数和代码
  17. | └── api/ - 实现常见的API,以及Electron的内置模块的基础
  18. ├── chromium_src/ - Chromium复制的源代码
  19. ├── default_app/ - Electron未启动时显示的默认应用
  20. ├── docs/ - 文档
  21. ├── lib/ - JavaScript源代码
  22. | ├── browser/ - 主进程中的Javascript初始化代码
  23. | | └── api/ - Javascript API实现.
  24. | ├── common/ - 主进程和渲染进程公用的JavaScript
  25. | | └── api/ - Javascript API实现.
  26. | └── renderer/ - 渲染进程中的Javascript初始化代码
  27. | └── api/ - Javascript API实现.
  28. ├── spec/ - 自动测试
  29. ├── electron.gyp - Electron 的构建规则
  30. └── common.gypi -为诸如 `node` `breakpad` 等其他组件准备的编译设置和构建规则

其他目录的结构

  • script - 用于诸如构建、打包、测试等开发用途的脚本
  • tools - 在 gyp 文件中用到的工具脚本,但与 script 目录不同, 该目录中的脚本不应该被用户直接调用
  • vendor - 第三方依赖项的源代码,为了防止人们将它与 Chromium 源码中的同名目录相混淆, 在这里我们不使用 third_party 作为目录名
  • node_modules - 在构建中用到的第三方 node 模块
  • out - ninja 的临时输出目录
  • dist - 由脚本 script/create-dist.py 创建的临时发布目录
  • external_binaries - 下载的不支持通过 gyp 构建的预编译第三方框架

保持Git子模块为最新

/vendor目录中有一些Electron存储库的依赖项。运行 git status时你可能看到这样的提示:

  1. $ git status
  2. modified: vendor/libchromiumcontent (new commits)
  3. modified: vendor/node (new commits)

要更新这些被提供的依赖关系,请运行以下命令:

  1. git submodule update --init --recursive

如果你发现自己经常运行这个命令,你可以在你的 ~/.gitconfig文件中为它创建一个别名:

  1. [alias]
  2. su = submodule update --init --recursive