Electron 编译工具使用手册

<p/><p class="image-package"><img class="uploaded-img" src="https://upload-images.jianshu.io/upload_images/19800061-a68050b600c5a48c.png?imageMogr2/auto-orient/strip%7CimageView2/2/w/1240" width="auto" height="auto"/></p><p><strong>一、简介</strong></p><p>Electron Build Tools 提供了一套脚本工具(<strong>e</strong> 命令行工具),用于简化 Electron 源码的获取、配置和编译流程。支持多分支、多配置的并行开发。</p>


<p><strong>二、环境准备</strong></p><ol><li><p><strong>系统要求</strong>:</p></li><ul><li><p><strong>所有平台</strong>:需安装 <strong>git</strong>、<strong>python</strong>、<strong>npm</strong>。</p></li><li><p><strong>Windows</strong>:建议使用 <strong>cmd</strong>(PowerShell 可能存在兼容性问题)。</p></li></ul><li><p><strong>安装工具</strong>:</p><pre>bashCopy Code# 全局安装 build-toolsnpm install -g @electron/build-tools# 推荐安装 yarn(非必需但优化体验)npm install -g yarn</pre></li></ol>
<p><strong>三、核心命令</strong></p><p>命令说明<strong>e init [options]</strong>创建新构建配置并初始化源码目录<strong>e sync</strong>同步源码(克隆/更新 Chromium、Node 和 Electron 仓库)<strong>e build</strong>编译当前配置的 Electron<strong>e show configs</strong>列出所有构建配置<strong>e use <name></strong>切换当前激活的构建配置<strong>e show current</strong>显示当前激活的配置</p>
<p><strong>四、关键概念</strong></p><ol><li><p><strong>构建配置(Build Config)</strong>
每个配置包含以下信息:</p></li><ul><li><p><strong>源码目录</strong>(<strong>--root</strong> 参数指定,默认为 <strong>electron</strong>)</p></li><li><p><strong>目标分支</strong>(如 <strong>main</strong>、<strong>13-x-y</strong>)</p></li><li><p><strong>编译模式</strong>(如 <strong>testing</strong> 或 <strong>release</strong>)</p></li><li><p>其他编译选项(如 Clang 的 <strong>asan</strong>/<strong>tsan</strong>)</p></li></ul><li><p><strong>多配置管理</strong></p></li><ul><li><p>类似 <strong>nvm</strong>,可创建多个配置并自由切换。</p></li><li><p>示例:同时维护 <strong>main</strong> 分支的测试版和发布版。</p></li></ul></ol>
<p><strong>五、完整流程示例</strong></p><p><strong>场景:编译 </strong></p><ol><li><p><strong>创建测试版配置</strong>:</p><pre>bashCopy Code# 初始化并自动同步源码、编译(--bootstrap)e init main-testing --root=/electron&nbsp;--bootstrap&nbsp;testing</pre></li><ul><li><p><strong>--root=/electron</strong>:源码和编译文件存放根目录。</p></li><li><p><strong>--bootstrap testing</strong>:自动执行 <strong>e sync</strong> 和 <strong>e build</strong>,并使用 <strong>testing</strong> 编译模式。</p></li></ul><ul><li><p>参数说明:</p></li></ul><li><p><strong>创建发布版配置</strong>:</p><pre>bashCopy Codee init main-release --root=~/electron --bootstrap release</pre></li><li><p><strong>切换配置</strong>:</p><pre>bashCopy Codee use main-testing    # 切换到测试版配置e use main-release    # 切换到发布版配置</pre></li><li><p><strong>手动同步和编译</strong>:</p><pre>bashCopy Codee sync   # 更新源码(仅需在需要更新时运行)e build  # 执行编译</pre></li></ol>
<p><strong>六、参数详解</strong></p><ol><li><p><strong>e init 关键参数</strong>:</p></li><ul><li><p><strong>-i/--import <mode></strong>:指定编译模式(<strong>testing</strong> 或 <strong>release</strong>)。</p></li><li><p><strong>--root <path></strong>:自定义源码和编译目录。</p></li><li><p><strong>--bootstrap</strong>:自动完成初始化后的源码同步和编译。</p></li></ul><li><p><strong>e sync 行为</strong>:</p></li><ul><li><p>首次运行:克隆 Chromium、Node 和 Electron 仓库。</p></li><li><p>后续运行:拉取最新代码并应用 Electron 补丁。</p></li></ul></ol>
<p><strong>七、注意事项</strong></p><ol><li><p><strong>存储空间</strong>
Chromium 源码约需 30GB,完整编译需额外 50GB 空间。</p></li><li><p><strong>网络问题</strong>
同步 Chromium 时可能因网络中断失败,重试命令即可。</p></li><li><p><strong>编译时间</strong>
首次编译可能耗时数小时(取决于硬件性能)。</p></li><li><p><strong>参数选择</strong>
不同编译模式(如 <strong>testing</strong> 和 <strong>release</strong>)会影响性能调试信息,按需选择。</p></li></ol><p>
</p>

©著作权归作者所有,转载或内容合作请联系作者
平台声明:文章内容(如有图片或视频亦包括在内)由作者上传并发布,文章内容仅代表作者本人观点,简书系信息发布平台,仅提供信息存储服务。

推荐阅读更多精彩内容