在 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 精彩的手冊和教學，其中將說明更複雜的除錯案例。

需求​

附加到並除錯 Electron​

設定中斷點​

進一步閱讀​

需求

附加到並除錯 Electron

設定中斷點

進一步閱讀