Отладчик
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
<
< Debugger attached.
<
ok
Break on start in myscript.js:2
1 // myscript.js
> 2 global.x = 5;
3 setTimeout(() => {
4 debugger;
debug> Клиент отладчика Node.js не является полноценным отладчиком, но простые шаги и инспекция возможны.
Вставка оператора debugger; в исходный код скрипта позволит установить точку останова в этой позиции кода:
// myscript.js
global.x = 5;
setTimeout(() => {
debugger;
console.log('world');
}, 1000);
console.log('hello'); После запуска отладчика точка останова будет достигнута на строке 3:
$ 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
<
< Debugger attached.
<
ok
Break on start in myscript.js:2
1 // myscript.js
> 2 global.x = 5;
3 setTimeout(() => {
4 debugger;
debug> cont
< 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: Приостановить выполнение кода (аналогично кнопке паузы в Developer Tools)
Точки останова
-
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
<
< Debugger attached.
<
ok
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.org/en/docs/inspector
< 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): Удалить выражение из списка наблюдаемых -
watchers: Вывести список всех наблюдаемых и их значений (автоматически выводится на каждой точке останова) -
repl: Открыть REPL отладчика для вычисления в контексте отлаживаемого скрипта -
exec expr: Выполнить выражение в контексте отлаживаемого скрипта
Управление выполнением
-
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-brk вместо --inspect.
$ 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
(В примере 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-v16.x/docs/api/debugger.html