在 macOS 上调试¶

如果你在 Electron 中遇到崩溃或问题，并且你认为这些问题不是由你的 JavaScript 应用引起的，而是由 Electron 本身引起的，那么调试可能会有一些棘手，尤其对于不习惯原生/C++ 调试的开发者来说。不过，使用 lldb 和 Electron 源代码，你可以启用单步调试，并在 Electron 源代码内部设置断点。如果你更喜欢图形界面，也可以使用 XCode 进行调试。

要求¶

一个 Electron 测试构建版本：最简单的方式通常是从源代码构建它，你可以按照构建说明中的说明完成。虽然你可以附加到并调试直接下载的 Electron，但你会发现它经过高度优化，使调试变得困难得多。在这种情况下，调试器将无法显示所有变量的内容，并且由于内联、尾调用和其他编译器优化，执行路径可能看起来很奇怪。
Xcode：除了 Xcode，你还应该安装 Xcode 命令行工具。它们包含 LLDB，macOS 上 Xcode 的默认调试器。它支持在桌面和 iOS 设备及模拟器上调试 C、Objective-C 和 C++。
.lldbinit：创建或编辑 ~/.lldbinit，以便正确映射 Chromium 代码的源代码。

# e.g: ['~/electron/src/tools/lldb']
script sys.path[:0] = ['<...path/to/electron/src/tools/lldb>']
script import lldbinit

附加到 Electron 并调试¶

要开始调试会话，打开终端并启动 lldb，将一个非 release 构建的 Electron 作为参数传入。

$ lldb ./out/Testing/Electron.app
(lldb) target create "./out/Testing/Electron.app"
Current executable set to './out/Testing/Electron.app' (x86_64).

设置断点¶

LLDB 是一个功能强大的工具，支持多种代码检查策略。对于这个基础介绍，让我们假设你正在调用一个行为不正确的 JavaScript 命令 - 因此你想在该命令位于 Electron 源代码中的 C++ 对应位置中断。

相关代码文件可以在 ./shell/ 中找到。

让我们假设你想调试 app.setName()，它定义在 browser.cc 中的 Browser::SetName()。使用 breakpoint 命令设置断点，指定要中断的文件和行：

(lldb) breakpoint set --file browser.cc --line 117
Breakpoint 1: where = Electron Framework`atom::Browser::SetName(std::__1::basic_string<char, std::__1::char_traits<char>, std::__1::allocator<char> > const&) + 20 at browser.cc:118, address = 0x000000000015fdb4

然后，启动 Electron：

(lldb) run

由于 Electron 在启动时会设置应用名称，应用会立即暂停：

(lldb) run
Process 25244 launched: '/Users/fr/Code/electron/out/Testing/Electron.app/Contents/MacOS/Electron' (x86_64)
Process 25244 stopped
* thread #1: tid = 0x839a4c, 0x0000000100162db4 Electron Framework`atom::Browser::SetName(this=0x0000000108b14f20, name="Electron") + 20 at browser.cc:118, queue = 'com.apple.main-thread', stop reason = breakpoint 1.1
    frame #0: 0x0000000100162db4 Electron Framework`atom::Browser::SetName(this=0x0000000108b14f20, name="Electron") + 20 at browser.cc:118
   115  }
   116
   117  void Browser::SetName(const std::string& name) {
-> 118    name_override_ = name;
   119  }
   120
   121  int Browser::GetBadgeCount() {
(lldb)

要显示当前帧的参数和局部变量，运行 frame variable（或 fr v），它会显示应用当前正在将名称设置为 "Electron"。

(lldb) frame variable
(atom::Browser *) this = 0x0000000108b14f20
(const string &) name = "Electron": {
    [...]
}

要在当前选中的线程中执行源代码级别的单步，执行 step（或 s）。这会带你进入 name_override_.empty()。要继续并执行单步跳过，运行 next（或 n）。

(lldb) step
Process 25244 stopped
* thread #1: tid = 0x839a4c, 0x0000000100162dcc Electron Framework`atom::Browser::SetName(this=0x0000000108b14f20, name="Electron") + 44 at browser.cc:119, queue = 'com.apple.main-thread', stop reason = step in
    frame #0: 0x0000000100162dcc Electron Framework`atom::Browser::SetName(this=0x0000000108b14f20, name="Electron") + 44 at browser.cc:119
   116
   117  void Browser::SetName(const std::string& name) {
   118    name_override_ = name;
-> 119  }
   120
   121  int Browser::GetBadgeCount() {
   122    return badge_count_;

注意： 如果你认为应该看到源代码但没有看到，可能你没有添加上面的 ~/.lldbinit 文件。

要在此处结束调试，运行 process continue。你也可以继续执行，直到该线程中的某一行被命中（thread until 100）。此命令将在当前帧中运行该线程，直到它到达此帧中的第 100 行，或者如果它离开当前帧则停止。

现在，如果你打开 Electron 的开发者工具并调用 setName，你将再次命中断点。

延伸阅读¶

LLDB 是一个功能强大的工具，拥有出色的文档。要了解更多信息，可以考虑 Apple 的调试文档，例如 LLDB 命令结构参考或将 LLDB 用作独立调试器的介绍。

你还可以查看 LLDB 出色的手册和教程，其中将解释更复杂的调试场景。

本页原文 Markdown：在 AtomGit 查看·内容源自开源项目 el/electron