Что такое отладчик и как он может помочь мне в диагностике проблем?

Это общий вопрос, предназначенный для помощи новым программистам, которые столкнулись с проблемой в программе, но не знают, как использовать отладчик для диагностики причины проблемы.

Этот вопрос охватывает три класса более конкретных вопросов:

• Когда я запускаю свою программу, она не выводит ожидаемый результат для введенных данных.
• Когда я запускаю свою программу, она аварийно завершает работу и предоставляет мне трассировку стека. Я изучил трассировку стека, но все равно не знаю причины проблемы, потому что трассировка стека не предоставляет мне достаточно информации.
• Когда я запускаю свою программу, она аварийно завершает работу из-за сегментационной ошибки (SEGV).

Отладчик – это программа, которая может исследовать состояние вашей программы во время её выполнения. Технические средства, которые он использует для этого не являются необходимыми для понимания основ работы с отладчиком. Вы можете использовать отладчик, чтобы остановить выполнение вашей программы, когда она достигает определенного места в вашем коде, а затем исследовать значения переменных в программе. Вы можете использовать отладчик, чтобы запускать вашу программу очень медленно, по одной строке кода за раз (это называется пошаговым выполнением), пока вы исследуете значения её переменных.

Использование отладчика является ожидаемым базовым навыком

Отладчик – это очень мощный инструмент для диагностики проблем с программами. И отладчики доступны для всех практических языков программирования. Поэтому возможность использовать отладчик считается базовым навыком любого профессионального или любительского программиста. И использование отладчика самостоятельно считается базовой работой, которую вы должны выполнять самостоятельно перед тем, как обращаться за помощью к другим. Поскольку этот сайт предназначен для профессиональных и любительских программистов, а не для службы поддержки или наставничества, если у вас есть вопрос о проблеме с конкретной программой, но вы не использовали отладчик, ваш вопрос с большой вероятностью будет закрыт и понижен в рейтинге. Если вы будете продолжать задавать подобные вопросы, вас в конечном итоге заблокируют от размещения новых.

Как отладчик может помочь вам

Используя отладчик, вы можете выяснить, имеет ли переменная неправильное значение, и в какой части вашей программы её значение изменилось на неправильное.

Используя пошаговое выполнение, вы также можете выяснить, соответствует ли поток управления вашим ожиданиям. Например, выполняется ли ветвление if, когда вы ожидаете, что оно должно выполняться.

Общие заметки по использованию отладчика

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

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

• На практике часто легче запустить вашу программу под контролем отладчика с самого начала.

• Вы указываете где ваша программа должна прекратить выполнение, указывая файл исходного кода и номер строки, в которой выполнение должно остановиться, или указывая имя метода/функции, в которой программа должна остановиться (если вы хотите остановиться, как только выполнение войдет в метод). Техническое средство, которое отладчик использует для остановки вашей программы, называется точкой останова, и этот процесс называется установкой точки останова.

• Большинство современных отладчиков являются частью IDE и предоставляют вам удобный графический интерфейс для изучения исходного кода и переменных вашей программы, с интерфейсом “указать и нажать” для установки точек останова, запуска вашей программы и пошагового выполнения.

• Использовать отладчик может быть очень трудно, если исполняемые файлы вашей программы или байт-код не содержат информации об символах отладки и перекрестных ссылках на ваш исходный код. Вам может понадобиться собирать (или пересобирать) вашу программу немного иначе, чтобы гарантировать, что эта информация присутствует. Если компилятор выполняет обширные оптимизации, эти перекрестные ссылки могут стать запутанными. Поэтому вам может потребоваться пересобрать вашу программу с отключенными оптимизациями.

Хочу добавить, что отладчик не всегда является идеальным решением и не должен всегда быть основным решением для отладки. Вот несколько случаев, когда отладчик может не сработать для вас:

• Часть вашей программы, которая дает сбои, действительно велика (возможно, плохая модульность?) и вы не совсем уверены, с чего начать пошаговое выполнение кода. Прохождение через всё это может занять слишком много времени.
• Ваша программа использует много обратных вызовов и другие методы нелинейного управления потоками, что вызывает путаницу у отладчика, когда вы проходите через это.
• Ваша программа многопоточная. Или, что еще хуже, ваша проблема вызвана состоянием гонки.
• Код, в котором есть ошибка, выполняется много раз до того, как произойдет сбой. Это может быть особенно проблематично в главных циклах, или, что еще хуже, в физических движках, где проблема может быть численной. Даже установка точки останова в этом случае просто заставит вас многократно её достигать, а ошибка не появится.
• Ваша программа должна выполняться в реальном времени. Это большая проблема для программ, которые подключены к сети. Если вы установите точку останова в своем сетевом коде, другая сторона не будет ждать, пока вы пройдете через шаги; она просто тайм-аутится. Программы, которые зависят от системных часов, например, игры с пропуском кадров, тоже не в лучшем положении.
• Ваша программа выполняет какие-либо разрушительные действия, такие как запись в файлы или отправка электронных писем, и вы хотите ограничить количество раз, которые нужно проходить через неё.
• Вы понимаете, что ваша ошибка вызвана неправильными значениями, приходящими в функцию X, но не знаете, откуда эти значения берутся. Придется многократно проходить через программу, устанавливая точки останова всё дальше и дальше назад, что может быть большим неудобством. Особенно если функция X вызывается из многих мест в программе.

Во всех этих случаях либо резкая остановка вашей программы может привести к различию в конечных результатах, либо ручное пошаговое выполнение в поисках одной строки, где вызывается ошибка, слишком хлопотно. Это может одинаково произойти, когда ваша ошибка – это неправильное поведение, или сбой. Например, если повреждение памяти вызывает сбой, к моменту, когда произойдет сбой, это будет слишком далеко от того места, где это повреждение произошло впервые, и полезной информации не останется.

Итак, каковы альтернатива?

Самый простой способ – это просто ведение журналов и утверждения. Добавьте журналы в вашу программу в различных точках, и сравните, что у вас есть с тем, что вы ожидаете. Например, посмотрите, вызывается ли функция, в которой, как вы думаете, есть ошибка, вообще. Посмотрите, являются ли переменные в начале метода теми, какими вы думаете, что должны быть. В отличие от точек останова, нормально, если будет много строк журналов, в которых ничего особенного не происходит. Вы можете просто пройти через журнал позже. Как только вы наткнетесь на строку в журнале, которая отличается от ожидаемой, добавьте еще в той же области. Сужайте круг все дальше и дальше, пока он не станет достаточно малым, чтобы можно было зафиксировать каждую строку в проблемной области.

Утверждения могут быть использованы для обнаружения неправильных значений по мере их поступления, а не тогда, когда они оказывают видимое действие на конечного пользователя. Чем быстрее вы поймаете неправильное значение, тем ближе вы окажетесь к строке, которая его вызвала.

Рефакторинг и модульное тестирование. Если ваша программа слишком велика, возможно, стоит протестировать её по одному классу или одной функции за раз. Дайте ей входные данные и посмотрите на выходные данные, и увидьте, какие не соответствуют вашим ожиданиям. Возможность сузить ошибку с целой программы до одной функции может значительно сократить время отладки.

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

Помните, что отладка – это процесс, идущий в обратном направлении. У вас есть конечный результат – ошибка – и вам нужно найти причину, которая предшествовала ей. Это связано с тем, чтобы работать в обратном направлении и, к сожалению, отладчики только идут вперед. В этом случае хороший журнал и анализ после завершения могут дать вам намного лучшие результаты.