在macOS上调试 | Debugging on macOS

如果您认为Electron中的崩溃或问题不是由您的JavaScript应用程序引起的，而是由Electron本身引起的，那么调试可能有点棘手，特别是对于不习惯于本机/ C ++调试的开发人员。但是，使用lldb和Electron源代码，通过Electron源代码中的断点启用逐步调试相当容易。

要求

• Electron的调试版本：最简单的方法通常是使用macOS的构建说明中列出的工具和先决条件自己构建它。虽然您可以轻松地连接并调试Electron，但您可以直接下载它，但会发现它经过大量优化，使调试更加困难：调试器将无法向您显示所有变量的内容，并且执行路径可以由于内联，尾部调用和其他编译器优化而看起来很奇怪。

• Xcode：除Xcode之外，还安装Xcode命令行工具。它们包括LLDB，它是Mac OS X上Xcode的默认调试器。它支持在桌面和iOS设备和模拟器上调试C，Objective-C和C ++。

附加和调试电子

要开始一个调试会话，打开终端并启动lldb，传递Electron的调试版本作为参数。

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

设置断点

LLDB是一个强大的工具，支持多种代码检查策略。对于这个基本的介绍，让我们假设你从JavaScript中调用了一个不正确的命令 - 所以你想在Electron源中的那个命令的C ++对象中断。

相关的代码文件可以在./atom/以及在./brightray/browser和找到的Brightray中找到./brightray/common。如果你是hardcore，你也可以直接调试Chromium，这显然是在chromium_src。

我们假设你想要调试app.setName()，这在browser.ccas中定义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/D/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_;

要完成此时的调试，请运行process continue。你也可以继续下去，直到在这个线程（thread until 100）中命中某一行。该命令将运行当前帧中的线程，直到达到该帧中的第100行，或者在离开当前帧时停止。

现在，如果您打开Electron的开发者工具并打电话setName，您将再次触及断点。

进一步阅读

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

您还可以查看LLDB的精彩手册和教程，这将解释更复杂的调试场景。