Node.js v25.0.0 文件
- Node.js v25.0.0
- 目錄
-
索引
- 斷言測試
- 非同步上下文跟蹤
- 非同步鉤子
- 緩衝區
- C++ 外掛
- 使用 Node-API 的 C/C++ 外掛
- C++ 嵌入器 API
- 子程序
- 叢集
- 命令列選項
- 控制檯
- 加密
- 偵錯程式
- 已棄用的 API
- 診斷通道
- DNS
- 域
- 環境變數
- 錯誤
- 事件
- 檔案系統
- 全域性物件
- HTTP
- HTTP/2
- HTTPS
- 檢查器
- 國際化
- 模組:CommonJS 模組
- 模組:ECMAScript 模組
- 模組:
node:moduleAPI - 模組:包
- 模組:TypeScript
- 網路
- 作業系統
- 路徑
- 效能鉤子
- 許可權
- 程序
- Punycode
- 查詢字串
- 逐行讀取
- REPL
- 報告
- 單一可執行檔案應用
- SQLite
- 流
- 字串解碼器
- 測試執行器
- 定時器
- TLS/SSL
- 跟蹤事件
- TTY
- UDP/資料報
- URL
- 實用工具
- V8
- 虛擬機器
- WASI
- Web Crypto API
- Web Streams API
- 工作執行緒
- Zlib
- 其他版本
- 選項
偵錯程式#
Node.js 包含一個命令列除錯工具。Node.js 偵錯程式客戶端不是一個功能齊全的偵錯程式,但可以進行簡單的單步執行和檢查。
要使用它,請使用 inspect 引數啟動 Node.js,後面跟著要除錯的指令碼的路徑。
$ node inspect myscript.js
< Debugger listening on ws://127.0.0.1:9229/621111f9-ffcb-4e82-b718-48a145fa5db8
< For help, see: https://nodejs.com.tw/en/docs/inspector
<
connecting to 127.0.0.1:9229 ... ok
< Debugger attached.
<
ok
Break on start in myscript.js:2
1 // myscript.js
> 2 global.x = 5;
3 setTimeout(() => {
4 debugger;
debug>
偵錯程式會自動在第一個可執行行處中斷。如果希望程式一直執行到第一個斷點(由 debugger 語句指定),請將 NODE_INSPECT_RESUME_ON_START 環境變數設定為 1。
$ cat myscript.js
// myscript.js
global.x = 5;
setTimeout(() => {
debugger;
console.log('world');
}, 1000);
console.log('hello');
$ NODE_INSPECT_RESUME_ON_START=1 node inspect myscript.js
< Debugger listening on ws://127.0.0.1:9229/f1ed133e-7876-495b-83ae-c32c6fc319c2
< For help, see: https://nodejs.com.tw/en/docs/inspector
<
connecting to 127.0.0.1:9229 ... ok
< Debugger attached.
<
< hello
<
break in myscript.js:4
2 global.x = 5;
3 setTimeout(() => {
> 4 debugger;
5 console.log('world');
6 }, 1000);
debug> next
break in myscript.js:5
3 setTimeout(() => {
4 debugger;
> 5 console.log('world');
6 }, 1000);
7 console.log('hello');
debug> repl
Press Ctrl+C to leave debug repl
> x
5
> 2 + 2
4
debug> next
< world
<
break in myscript.js:6
4 debugger;
5 console.log('world');
> 6 }, 1000);
7 console.log('hello');
8
debug> .exit
$
repl 命令允許遠端評估程式碼。next 命令會單步執行到下一行。輸入 help 可以檢視還有哪些可用的命令。
在不輸入任何命令的情況下按 enter 鍵,將重複上一個偵錯程式命令。
監視器#
在除錯時可以監視表示式和變數的值。在每個斷點處,監視器列表中的每個表示式都將在當前上下文中被評估,並緊接在斷點原始碼列表之前顯示。
要開始監視一個表示式,請輸入 watch('my_expression')。watchers 命令將打印出活動的監視器。要移除一個監視器,請輸入 unwatch('my_expression')。
命令參考#
單步執行#
cont,c: 繼續執行next,n: 單步跳過step,s: 單步進入out,o: 單步跳出pause: 暫停正在執行的程式碼(類似於開發者工具中的暫停按鈕)
斷點#
setBreakpoint(),sb(): 在當前行設定斷點setBreakpoint(line),sb(line): 在指定行設定斷點setBreakpoint('fn()'),sb(...): 在函式體的第一條語句上設定斷點setBreakpoint('script.js', 1),sb(...): 在script.js的第一行設定斷點setBreakpoint('script.js', 1, 'num < 4'),sb(...): 在script.js的第一行設定一個條件斷點,僅當num < 4的計算結果為true時中斷clearBreakpoint('script.js', 1),cb(...): 清除script.js檔案第 1 行的斷點
也可以在一個尚未載入的檔案(模組)中設定斷點。
$ node inspect main.js
< Debugger listening on ws://127.0.0.1:9229/48a5b28a-550c-471b-b5e1-d13dd7165df9
< For help, see: https://nodejs.com.tw/en/docs/inspector
<
connecting to 127.0.0.1:9229 ... ok
< Debugger attached.
<
Break on start in main.js:1
> 1 const mod = require('./mod.js');
2 mod.hello();
3 mod.hello();
debug> setBreakpoint('mod.js', 22)
Warning: script 'mod.js' was not loaded yet.
debug> c
break in mod.js:22
20 // USE OR OTHER DEALINGS IN THE SOFTWARE.
21
>22 exports.hello = function() {
23 return 'hello from module';
24 };
debug>
也可以設定一個條件斷點,僅當給定表示式的計算結果為 true 時才中斷。
$ node inspect main.js
< Debugger listening on ws://127.0.0.1:9229/ce24daa8-3816-44d4-b8ab-8273c8a66d35
< For help, see: https://nodejs.com.tw/en/docs/inspector
<
connecting to 127.0.0.1:9229 ... ok
< Debugger attached.
Break on start in main.js:7
5 }
6
> 7 addOne(10);
8 addOne(-1);
9
debug> setBreakpoint('main.js', 4, 'num < 0')
1 'use strict';
2
3 function addOne(num) {
> 4 return num + 1;
5 }
6
7 addOne(10);
8 addOne(-1);
9
debug> cont
break in main.js:4
2
3 function addOne(num) {
> 4 return num + 1;
5 }
6
debug> exec('num')
-1
debug>
資訊#
backtrace,bt: 列印當前執行幀的回溯跟蹤list(5): 列出指令碼原始碼及 5 行上下文(前後各 5 行)watch(expr): 將表示式新增到監視列表unwatch(expr): 從監視列表中移除表示式unwatch(index): 從監視列表中移除指定索引的表示式watchers: 列出所有監視器及其值(在每個斷點處自動列出)repl: 開啟偵錯程式的 repl,以便在除錯指令碼的上下文中進行評估exec expr,p expr: 在除錯指令碼的上下文中執行一個表示式並列印其值profile: 啟動 CPU 分析會話profileEnd: 停止當前的 CPU 分析會話profiles: 列出所有已完成的 CPU 分析會話profiles[n].save(filepath = 'node.cpuprofile'): 將 CPU 分析會話以 JSON 格式儲存到磁碟takeHeapSnapshot(filepath = 'node.heapsnapshot'): 獲取堆快照並以 JSON 格式儲存到磁碟
執行控制#
run: 執行指令碼(在偵錯程式啟動時自動執行)restart: 重啟指令碼kill: 終止指令碼
其他#
scripts: 列出所有已載入的指令碼version: 顯示 V8 的版本
高階用法#
Node.js 的 V8 檢查器整合#
V8 檢查器整合允許將 Chrome 開發者工具附加到 Node.js 例項上進行除錯和效能分析。它使用了 Chrome 開發者工具協議。
V8 檢查器可以透過在啟動 Node.js 應用程式時傳遞 --inspect 標誌來啟用。也可以透過該標誌提供一個自定義埠,例如 --inspect=9222 將在 9222 埠上接受開發者工具的連線。
使用 --inspect 標誌會在偵錯程式連線之前立即執行程式碼。這意味著在你開始除錯之前程式碼就已經開始執行,如果你想從最開始進行除錯,這可能並不理想。
在這種情況下,你有兩個替代方案:
--inspect-wait標誌:此標誌會在執行程式碼前等待偵錯程式連線。這使你可以從執行的一開始就進行除錯。--inspect-brk標誌:與--inspect不同,此標誌會在偵錯程式連線後立即在程式碼的第一行中斷。當你想從最開始一步步除錯程式碼,並且不希望在除錯前有任何程式碼執行時,這非常有用。
因此,在決定使用 --inspect、--inspect-wait 還是 --inspect-brk 時,請考慮你是希望程式碼立即開始執行,還是等待偵錯程式連線後再執行,或者是在第一行中斷以便進行逐步除錯。
$ node --inspect index.js
Debugger listening on ws://127.0.0.1:9229/dc9010dd-f8b8-4ac5-a510-c1a114ec7d29
For help, see: https://nodejs.com.tw/en/docs/inspector
(在上面的示例中,URL 末尾的 UUID dc9010dd-f8b8-4ac5-a510-c1a114ec7d29 是動態生成的,在不同的除錯會話中會有所不同。)
如果 Chrome 瀏覽器版本低於 66.0.3345.0,請在上述 URL 中使用 inspector.html 而不是 js_app.html。