Spec-Zone.ru › Node.js 6 LTS

Отладчик

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

Node.js включает утилиту отладки вне процесса, доступную через протокол на основе TCP и встроенный клиент отладки. Для использования её, запустите Node.js с аргументом debug, за которым следует путь к скрипту, подлежащему отладке; появится сообщение, указывающее на успешный запуск отладчика:

$ node debug myscript.js
< Debugger listening on [::]:5858
connecting to 127.0.0.1:5858 ... ok
break in /home/indutny/Code/git/indutny/myscript.js:1
> 1 global.x = 5;
  2 setTimeout(() => {
  3   debugger;
debug>

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

Вставка оператора debugger; в исходный код скрипта включит точку останова в этой позиции кода:

// myscript.js
global.x = 5;
setTimeout(() => {
  debugger;
  console.log('world');
}, 1000);
console.log('hello');

После запуска отладчика произойдёт точка останова на строке 3:

$ node debug myscript.js
< Debugger listening on [::]:5858
connecting to 127.0.0.1:5858 ... ok
break in /home/indutny/Code/git/indutny/myscript.js:1
> 1 global.x = 5;
  2 setTimeout(() => {
  3   debugger;
debug> cont
< hello
break in /home/indutny/Code/git/indutny/myscript.js:3
  1 global.x = 5;
  2 setTimeout(() => {
> 3   debugger;
  4   console.log('world');
  5 }, 1000);
debug> next
break in /home/indutny/Code/git/indutny/myscript.js:4
  2 setTimeout(() => {
  3   debugger;
> 4   console.log('world');
  5 }, 1000);
  6 console.log('hello');
debug> repl
Press Ctrl + C to leave debug repl
> x
5
> 2 + 2
4
debug> next
break in /home/indutny/Code/git/indutny/myscript.js:5
< world
  3   debugger;
  4   console.log('world');
> 5 }, 1000);
  6 console.log('hello');
  7
debug> quit

Команда 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
  • clearBreakpoint('script.js', 1), cb(...) - Очистить точку останова в script.js на строке 1

Также можно установить точку останова в файле (модуле), который ещё не загружен:

$ node debug test/fixtures/break-in-module/main.js
< Debugger listening on [::]:5858
connecting to 127.0.0.1:5858 ... ok
break in test/fixtures/break-in-module/main.js:1
> 1 var mod = require('./mod.js');
  2 mod.hello();
  3 mod.hello();
debug> setBreakpoint('mod.js', 2)
Warning: script 'mod.js' was not loaded yet.
> 1 var mod = require('./mod.js');
  2 mod.hello();
  3 mod.hello();
  4 debugger;
  5
  6 });
debug> c
break in test/fixtures/break-in-module/mod.js:2
  1 exports.hello = function() {
> 2   return 'hello from module';
  3 };
  4
debug>

Информация

  • backtrace, bt - Вывести трассировку стека текущей фрейма выполнения
  • list(5) - Список исходного кода скриптов с контекстом 5 строк (5 строк до и после)
  • watch(expr) - Добавить выражение в список наблюдаемых
  • unwatch(expr) - Удалить выражение из списка наблюдаемых
  • watchers - Список всех наблюдателей и их значений (автоматически отображаются на каждой точке останова)
  • repl - Открыть repl отладчика для оценки в контексте отлаживаемого скрипта
  • exec expr - Выполнить выражение в контексте отлаживаемого скрипта

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

  • run - Запустить скрипт (автоматически запускается при запуске отладчика)
  • restart - Перезапустить скрипт
  • kill - Завершить скрипт

Разное

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

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

Альтернативный способ включения и доступа к отладчику — запуск Node.js с флагом командной строки --debug или передача сигнала существующему процессу Node.js с помощью SIGUSR1.

После того, как процесс переведён в режим отладки таким способом, его можно просмотреть с помощью отладчика Node.js, подключившись к pid работающего процесса или по ссылке URI к отлаживающему серверу:

  • node debug -p <pid> - Подключается к процессу через pid
  • node debug <URI> - Подключается к процессу через URI, например localhost:5858

Интеграция инспектора V8 для Node.js

ПРИМЕЧАНИЕ: Эта функция находится в стадии разработки.

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

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

Чтобы остановить выполнение на первой строке кода приложения, укажите флаг --debug-brk в дополнение к --inspect.

$ node --inspect index.js
Debugger listening on port 9229.
Warning: This is an experimental feature and could change at any time.
To start debugging, open the following URL in Chrome:
    chrome-devtools://devtools/remote/serve_file/@60cd6e859b9f557d2312f5bf532f6aec5f284980/inspector.html?experiments=true&v8only=true&ws=127.0.0.1:9229/3a6d0a9e-0707-48f8-a7c6-48f157b67ab5

(В примере выше UUID 3a6d0a9e-0707-48f8-a7c6-48f157b67ab5 в конце URL генерируется динамически, он отличается в различных сеансах отладки.)

© 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-v6.x/docs/api/debugger.html

Spec-Zone.ru

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