Советы, которые помогут вам лучше понять устаревшую кодовую базу за меньшее время
Как инженеры-программисты, мы всегда заняты созданием инновационных вещей, используя разные языки и фреймворки. Иногда от нас ждут, что мы начнем новый проект, но большую часть времени мы работаем над устаревшей кодовой базой, которая изначально была написана кем-то другим.
Недавно некоторые исследователи предложили методы автоматизации рефакторинга и связанных операций в устаревшей кодовой базе. В этой статье мы рассмотрим, как работать с устаревшими кодовыми базами вручную.
Когда мы работаем над устаревшими системами, мы не всегда знакомы с тем, что происходит внутри них. У каждого человека свой стиль написания кода. Кроме того, если кодовая база на несколько лет старше, она может следовать более традиционным программным шаблонам, которые больше не используются таким образом.
В целом, когда вы работаете с устаревшей кодовой базой, возникает множество проблем. Ниже мы обозначим некоторые моменты, о которых вам нужно помнить при работе с такими кодовыми базами.
1. Разберитесь в структуре
Могут быть некоторые шаблоны, которым следует ваша устаревшая кодовая база, или, возможно, определенный шаблон, который был реализован в ней. Хорошее понимание архитектуры поможет вам, когда вы только начинаете работать с устаревшей кодовой базой.
Как вы знаете, существуют некоторые шаблоны проектирования программного обеспечения, которым обычно следуют при написании кода. Распространенными являются MVC, MVVC, MVT и другие.
Если вы хотите лучше понять кодовую базу, то стоит потратить некоторое время, чтобы выяснить, какой шаблон проектирования программного обеспечения используется в кодовой базе, и узнать о нем больше.
2. Используйте отладчик
Существуют различные инструменты, которые помогут вам быстрее понять кодовую базу. Когда новые разработчики начинают над чем-то работать, им необходимо регистрировать данные или помещать идентификаторы в разные классы или модули, чтобы понять поток кодовой базы.
Инженеры-программисты также должны создавать сценарии на своих локальных машинах, чтобы исследовать любые проблемы, возникающие в реальном коде. Если кто-то новичок в кодовой базе, это еще более сложная задача.
Это тот момент, когда такие инструменты, как Rookout, Visual Studio Code или IntelliJ IDEA могут помочь вам отладить кодовую базу, не уделяя слишком много внимания настройкам. Например, интеграция Rookout довольно проста и может помочь вам ускорить рабочий процесс.
Что вам нужно сделать, так это интегрировать SDK в ваше действующее приложение. Когда вы закончите с этим, добавьте точки останова по всему приложению и соберите всю необходимую информацию.
Основное преимущество отладчика, такого как Rookout, заключается в том, что вам просто нужно добавить строку в журнал, и он может охватить почти все. Будь то трассировка стека, локальная или глобальная переменная или любая другая метрика, которая может вам понадобиться, инструмент это покрывает.
3. Проверьте очевидное
Если вы знакомы с языком программирования или фреймворком, который использовался для разработки определенной кодовой базы, то есть некоторые вещи, которые вы можете понять сразу же.
Затем вы можете начать с тех модулей, классов или частей, которые вам легче понять, а затем укрепить свое обучение на их основе. Выберите самые простые модули или детали, а затем приступайте к работе над ними.
4. Изучите Flow в базе кода
Веб-приложения и кодовые базы обычно основаны на определенных потоках. Если это серверная система, она может состоять из разных API, таких как логин, регистрация и других API, связанных с различными операциями CRUD.
В интерфейсных системах у нас также есть аналогичные потоки, которые используют API для выполнения определенных операций.
Чтобы получить хорошее представление о том, как работает ваша кодовая база, вам нужно выбрать определенный модуль API или поток, а затем запустить его на своем локальном компьютере, чтобы увидеть, как он работает.
5. Не торопитесь
Когда вы новичок в кодовой базе, вам всегда нужно время, чтобы правильно понять, что происходит внутри нее. Иногда инженеры-программисты начинают «исправлять» вещи сразу, не изучив кодовую базу должным образом. Неудивительно, что такой подход часто приводит к поломке того, что уже работает.
Всегда важно правильно изучить кодовую базу и понять ее. Это первоначальное вложение времени поможет вам не тратить зря в будущем. Если вы способны понять архитектуру, шаблон проектирования и общий поток кодовой базы, это значительно упростит решение проблем и внесение изменений или улучшений в дальнейшем.
Вывод
Короче говоря, если вы сможете следовать некоторым методам распутывания устаревшего кода, вы сможете быстро это понять.
Отладка, ведение журнала и тестирование являются важными частями этого процесса. Так что не забывайте использовать их, когда работаете над устаревшей кодовой базой. Обязательно ознакомьтесь с ними, чтобы иметь возможность беспрепятственно работать с любой предоставленной вам кодовой базой.
