DevTools 扩展

Electron 支持 Chrome DevTools 扩展，可用于扩展 Chrome 开发者工具的功能，以调试流行的 Web 框架。

使用工具加载 DevTools 扩展

加载 DevTools 扩展最简单的方法是使用第三方工具来自动完成该过程。electron-devtools-installer 是一个流行的 NPM 包，它正是为此目的而设计的。

手动加载 DevTools 扩展

如果您不想使用工具方法，也可以手动完成所有必要的操作系统。要在 Electron 中加载扩展，您需要通过 Chrome 下载它，找到其文件系统路径，然后通过调用 ses.loadExtension API 将其加载到您的 Session 中。

以 React Developer Tools 为例

1. 在 Google Chrome 中安装该扩展。

2. 导航到 chrome://extensions，找到其扩展 ID，这是一个类似 fmkadmapgofadopljbjfkapdkoienihi 的哈希字符串。

3. 找出 Chrome 用于存储扩展的文件系统位置

   • 在 Windows 上是 %LOCALAPPDATA%\Google\Chrome\User Data\Default\Extensions；
   • 在 Linux 上可能是
     • ~/.config/google-chrome/Default/Extensions/
     • ~/.config/google-chrome-beta/Default/Extensions/
     • ~/.config/google-chrome-canary/Default/Extensions/
     • ~/.config/chromium/Default/Extensions/
   • 在 macOS 上是 ~/Library/Application Support/Google/Chrome/Default/Extensions。

4. 将扩展的位置传递给 ses.loadExtension API。对于 React Developer Tools v4.9.0，它看起来像这样

   const { app, session } = require('electron')
   
   const os = require('node:os')
   const path = require('node:path')
   
   // on macOS
   const reactDevToolsPath = path.join(
     os.homedir(),
     '/Library/Application Support/Google/Chrome/Default/Extensions/fmkadmapgofadopljbjfkapdkoienihi/4.9.0_0'
   )
   
   app.whenReady().then(async () => {
     await session.defaultSession.loadExtension(reactDevToolsPath)
   })

备注

• loadExtension 返回一个带有 Extension 对象的 Promise，其中包含有关已加载扩展的元数据。在加载页面之前，此 Promise 需要解析（例如，使用 await 表达式）。否则，无法保证扩展能够加载。
• loadExtension 不能在 app 模块的 ready 事件发出之前调用，也不能在内存中（非持久性）会话上调用。
• 如果您希望扩展被加载，则必须在每次应用启动时调用 loadExtension。

移除 DevTools 扩展

您可以将扩展的 ID 传递给 ses.removeExtension API，将其从您的 Session 中移除。已加载的扩展在应用启动之间不会持久化。

DevTools 扩展支持

Electron 只支持 有限的 chrome.* API 集，因此使用不受支持的 chrome.* API 的扩展可能无法正常工作。

以下 DevTools 扩展已在 Electron 中测试通过

• Ember Inspector
• React Developer Tools
• Backbone Debugger
• jQuery Debugger
• Vue.js devtools
• Cerebral Debugger
• Redux DevTools Extension
• MobX Developer Tools

如果 DevTools 扩展不起作用该怎么办？

首先，请确保该扩展仍在维护中，并且与最新版本的 Google Chrome 兼容。我们无法为不受支持的扩展提供额外支持。

如果该扩展在 Chrome 中可以正常工作但在 Electron 中不行，请在 Electron 的 issue tracker 上提交一个 bug，并描述该扩展的哪个部分未能按预期工作。