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
,将 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 精彩的手册和教程,其中解释了更复杂的调试场景。