Отладчик
Node.js включает утилиту отладки вне процесса, доступную через инспектор V8 и встроенный клиент отладки. Чтобы использовать её, запустите Node.js с аргументом inspect, за которым следует путь к сценарию для отладки; появится сообщение, указывающее на успешный запуск отладчика:
$ node inspect myscript.js
< Debugger listening on ws://127.0.0.1:9229/80e7a814-7cd3-49fb-921a-2e02228cd5ba
< For help, see: https://nodejs.org/en/docs/inspector
< Debugger attached.
Break on start in myscript.js:1
> 1 (function (exports, require, module, __filename, __dirname) { global.x = 5;
2 setTimeout(() => {
3 console.log('world');
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/80e7a814-7cd3-49fb-921a-2e02228cd5ba
< For help, see: https://nodejs.org/en/docs/inspector
< Debugger attached.
Break on start in myscript.js:1
> 1 (function (exports, require, module, __filename, __dirname) { global.x = 5;
2 setTimeout(() => {
3 debugger;
debug> cont
< hello
break in myscript.js:3
1 (function (exports, require, module, __filename, __dirname) { global.x = 5;
2 setTimeout(() => {
> 3 debugger;
4 console.log('world');
5 }, 1000);
debug> next
break in 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
< world
break in myscript.js:5
3 debugger;
4 console.log('world');
> 5 }, 1000);
6 console.log('hello');
7
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/4e3db158-9791-4274-8909-914f7facf3bd
< For help, see: https://nodejs.org/en/docs/inspector
< Debugger attached.
Break on start in main.js:1
> 1 (function (exports, require, module, __filename, __dirname) { 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-v14.x/docs/api/debugger.html