Spec-Zone.ru › Node.js 24 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: Приостановить выполняющийся код (как кнопка паузы в инструментах разработчика)

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

  • 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 с Node.js

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

Инспектор V8 можно включить, передав флаг --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-v24.x/docs/api/debugger.html

Spec-Zone.ru

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