Spec-Zone.ru › Node.js 20 LTS

Отладчик

Устойчивость: 2 - Стабильно

Node.js включает утилиту отладки командной строки. Клиент отладчика Node.js не является полнофункциональным отладчиком, но простые шаги и проверка возможны.

Чтобы использовать его, запустите Node.js с аргументом inspect и указанием пути к сценарию, который нужно отладить.

$ node inspect myscript.js
< Debugger listening on ws://127.0.0.1:9229/621111f9-ffcb-4e82-b718-48a145fa5db8
< For help, see: https://nodejs.org/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> copy

Отладчик автоматически прерывается на первой исполняемой строке. Чтобы вместо этого запустить выполнение до первой точки останова (указанной оператором 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.org/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
$ copy

Команда repl позволяет удалённо оценивать код. Команда next переходит к следующей строке. Введите help для просмотра доступных команд.

Нажатие enter без ввода команды повторит предыдущую команду отладчика.

Наблюдаемые значения

Возможна просмотр значений выражений и переменных во время отладки. На каждой точке останова каждое выражение из списка наблюдаемых значений будет вычислено в текущем контексте и отображено непосредственно перед списком исходного кода точки останова.

Для начала наблюдения за выражением введите watch('my_expression'). Команда watchers выведет активные наблюдаемые значения. Чтобы удалить наблюдаемое значение, введите unwatch('my_expression').

Справочник команд

Шаги

  • cont, c: Продолжить выполнение
  • next, n: Шаг вперед
  • step, s: Шаг вглубь
  • out, o: Шаг наружу
  • pause: Приостановить выполнение кода (как кнопка паузы в DevTools)

Точки останова

  • 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.org/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> copy

Также возможно установить условную точку останова, которая останавливается только тогда, когда заданное выражение равно true:

$ node inspect main.js
< Debugger listening on ws://127.0.0.1:9229/ce24daa8-3816-44d4-b8ab-8273c8a66d35
< For help, see: https://nodejs.org/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> copy

Информация

  • backtrace, bt: Вывести стек вызовов текущей рамки выполнения
  • list(5): Список исходного кода сценариев с контекстом 5 строк (5 строк до и после)
  • watch(expr): Добавить выражение в список наблюдаемых значений
  • unwatch(expr): Удалить выражение из списка наблюдаемых значений
  • unwatch(index): Удалить выражение по указанному индексу из списка наблюдаемых значений
  • watchers: Список всех наблюдаемых значений и их значений (автоматически отображается на каждой точке останова)
  • repl: Открыть REPL отладчика для оценки в контексте сценария отладки
  • exec expr, p expr: Выполнить выражение в контексте сценария отладки и вывести его значение
  • profile: Начать сеанс профилирования процессора
  • profileEnd: Остановить текущий сеанс профилирования процессора
  • profiles: Список всех завершённых сеансов профилирования процессора
  • profiles[n].save(filepath = 'node.cpuprofile'): Сохранить сеанс профилирования процессора на диск в формате JSON
  • takeHeapSnapshot(filepath = 'node.heapsnapshot'): Сделать снимок кучи и сохранить на диск в формате JSON

Управление выполнением

  • run: Запустить сценарий (автоматически запускается при запуске отладчика)
  • restart: Перезапустить сценарий
  • kill: Остановить сценарий

Разное

  • scripts: Список всех загруженных сценариев
  • version: Отобразить версию V8

Расширенное использование

Интеграция V8 Inspector для Node.js

Интеграция V8 Inspector позволяет подключать Chrome DevTools к экземплярам Node.js для отладки и профилирования. Она использует протокол Chrome DevTools.

Интеграция V8 Inspector может быть включена путём передачи флага --inspect при запуске приложения Node.js. Также можно указать порт с этим флагом, например, --inspect=9222 для приема подключений DevTools на порту 9222.

Использование флага --inspect выполнит код немедленно перед подключением отладчика. Это означает, что код начнёт выполняться до того, как вы сможете начать отладку, что может быть нежелательно, если вы хотите отладить с самого начала.

В таких случаях у вас есть два варианта:

  1. --inspect-wait флаг: Этот флаг будет ожидать подключения отладчика перед выполнением кода. Это позволяет начать отладку с самого начала выполнения.
  2. --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.org/en/docs/inspector copy

(В приведённом примере UUID dc9010dd-f8b8-4ac5-a510-c1a114ec7d29 в конце URL генерируется динамически, он меняется в разных сеансах отладки.)

Если браузер Chrome старше 66.0.3345.0, используйте inspector.html вместо js_app.html в вышеуказанном URL.

Chrome DevTools пока не поддерживает отладку потоков-работников. Для их отладки можно использовать ndb.

© Joyent, Inc. and other Node contributors
Licensed under the MIT License.
Node.js is a trademark of Joyent, Inc. and is used with its permission.
We are not endorsed by or affiliated with Joyent.
https://nodejs.org/dist/latest-v20.x/docs/api/debugger.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API