Рефакторинг и оптимизация программного кода зачем для чего и почему

Что такое рефакторинг кода

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

Наиболее четко определение термина указывает Мартин Фаулер в своей знаменитой книге «Refactoring: Improving the Design of Existing Code». Так указано, что рефакторинг  является контролируемой техникой оптимизации исходного кода. Его цель заключается в достижении лаконичности и простоты восприятия за счет внесения небольших корректировок, при этом работать утилита продолжает, как раньше.

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

Ошибки при определении рефакторинга

Чтобы сформировалось правильное понимание того, что это такое, необходимо отличать рефакторинг кода программного обеспечения от:

• Дебаггинга, направленного на установление и нейтрализацию ошибок, что необязательно приводит к упрощению структуры

• Обычного переписывания текста, которое применяют в рамках обучения или во время создания новых утилит

• Классической оптимизации, позволяющей улучшить функциональность

• Улучшения работы определенных компонентов ПО, когда программист отталкивается от потребностей пользователей

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

Для чего нужно оптимизировать code

У создателей софта существует правило работать так, чтобы потом с кодом можно было удобно и быстро иметь дело. Для этого нужно добиться лаконичности, но на практике сделать это часто не удается. Причины разные:

• Усталость программиста

• Неопытность разработчика

• Изменение требований заказчика в процессе работа над продуктом

• Совершенствование используемых языков программирования

Рефакторинг и оптимизация программного кода помогают подкорректировать результат, который из-за поведения создателя или по объективным причинам оказался тяжелым для понимания. С помощью изменений удается:

• Сократить затрачиваемые силы и время на поиск багов

• Увеличить продолжительность использования программного продукта

• Снизить стресс от работы с софтом

• Объективно сделать читаемость кода лучше благодаря реструктуризации либо сокращения

• Стимулировать более тщательную проработку ПО

• Решить проблемы стандартизации

• Сделать более оперативным процесс расширения функционала

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

• Сформировать фундамент для определения переиспользуемых кусков кода

Методы оптимизации

Подход к переработке кода каждый специалист выбирает сам, отталкиваясь от особенностей корректируемой функции, объекта или иного компонента. Наиболее распространенными являются такие способы:

• Red-Green-Refactor. Предполагает поиск участка кода, нуждающегося в коррекции, написание юнит-теста и последующего переписывания. Созданный заранее текст позволяет управлять софтом, задавая направление для работы кода

• Фрагментация — напоминает методику планирования задач, только в данном случае уменьшаются компоненты, но их количество возрастает. Фрагмент изначального текста вносится в новый code с четким названием функции, что положительно сказывается на читабельности и снижает сложность дальнейшей работы

• Абстракция — эффективный способ нейтрализации повторяющихся участков. Сначала необходимо придумать несколько абстрактных и других высоких классов, куда потом будут перемещаться дубликаты. Данная тактика подходит для планомерной коррекции структуры, регулярного выпуска релизов до окончания процесса оптимизации. При грамотном применении удается упростить коррекцию в потенциально проблемной ветке на этапе объединения кода

• Compose — помогает бороться с повышенной сложностью кода с помощью совокупности тактик. Среди них: Replace Temp with Query, разделение временных переменных, Inline Method, а также Inline Temp

Когда его нужно проводить, а когда нет

Учитывая то, что на оптимизацию требуются силы и время, важно четко понимать целесообразность проведения рефакторинга. Явными признаками того, что code нужно корректировать, являются:

• Неудачные попытки расширения функционала или внесения каких-либо улучшений – даже простые вроде бы операции затягиваются по времени из-за сложности кода

• Многократное проведение одинаковых процедур на разных классах или объектах вместо коррекции одного участка, который бы «подтянул» за собой остальные

• Проблемы с прогнозированием затрат времени на добавление новых опций из-за необходимости проведения детального анализа кода, напоминающего дебри

• Несоответствие кода установленным в организации стандартам оформления, что блокирует последующую разработку с учетом стартовых требований заказчика

• Неправильное число пробелов вначале строки

Как видите, большое значение имеют принципы работы в конкретной компании.

Изменения, которые можно вносить

Разбираясь в сути рефакторинга детальнее, опишем типичные корректировки, которые выполняют программисты:

• Уменьшение чрезмерного количества комментариев, которые мешают быстро дорабатывать программу

• Разделение функции на несколько составляющих вместо использования одной, но громоздкой. Если в функции больше 70 строк, то это перебор

• Изменение количества пробелов от начала строки, приведение текста в норму с учетом правил вкладывания одних компонентов в другие и общих принципов лаконичного оформления

• Удаление мусора в виде методов и переменных, которые не используются. Зависание в базе ненужных строк вызывает путаницу и затрудняет расширение функционала. Чаще всего для исправления применяют редакторы нового поколения наподобие VS Code

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

• Переименование функций и переменных – они должны быть понятными любому программисту

Правила проведения рефакторинга

Еще до переработки нужно определиться со следующими моментами:

• Предпочтительными задачами

• Темпами развития

• Существованием реальной потребности в оптимизации

• Уже используемыми инструментами работы с техническим долгом

• Ранее предпринятыми проверками

• Наличием навыков для внесения изменений в code

• Действующими в компании стандартами оформления документации

• Кодами, которые больше остальных ухудшают производительность

• Методами исправления, способными обеспечить максимальную отдачу

Когда проектов много, на рефакторинг по каждому программному продукту получается тратить немного времени. Так что изменения нужно вносить регулярно и по чуть-чуть, тогда технический долг не будет накапливаться. 

Универсальный способ профилактики неудачных изменений —– применение GitLab либо GitHub для хранения новшеств отдельным коммитом. Если потребуется, то всегда можно будет вернуть прошлую версию.

Вот еще несколько рекомендаций, как проводить оптимизацию правильно:

• Переписывайте только проблемные участки

• Будьте внимательными к деталям, чтобы после изменений ПО продолжало эффективно работать

• Не занимайтесь улучшением кода в ущерб дебаггингу, интеграции новых опций и других серьезных задач

• Помните о необходимости корректировки текста даже в том случае, если создаете программу с нуля и в одиночку

• Пользуйтесь метриками для расстановки приоритетов, чтобы первыми вносить именно те изменения, которые наиболее важны

• Оценивайте результативность рефакторинга

• Соотносите оптимизацию исходного текста с этапами командной работы над проектом и общими целями

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

Примеры рефакторинга

Крупные компании и сайты очень серьезно относятся к рефакторингу используемого софта, поскольку осознают последствия недостаточной лаконичности кода. Яркий пример — ресурс Kickstarter, где в 2014 году снизилась производительность запросов, при этом количество посетителей стабильно росло.

Инженерам удалось решить проблему благодаря смене системы управления базы данных (вместо MySQL стали использовать Redis). Дисперсия времени загрузки сразу уменьшилась, и платформа стала значительно быстрее функционировать.

Наиболее простой пример переработки кода можно продемонстрировать на прописанном методе сравнения двух чисел, который возвращает true, если первое число больше, и false, если оно меньше. 

Такая трансформация лучше всего демонстрирует суть и эффект изменения исходного текста. Хотя у каждой методики есть свои нюансы. Так,  Red-Green-Refactor является примером TDD. Красный — формируется набор тесто без кода, который не функционирует. Зеленый — создается текст с помощью языков программирования, причем именно такой, чтобы юнит-тесты прошли. После этого остается подобрать варианты улучшения кода.

Отдельного внимания заслуживают применяемые в рамках переработки инструменты. Это может быть как IDE, который есть во многих современных языках. Так и специализированные утилиты, такие как SonarQube, Rider, Eclipse IDE, а также Visual studio intellicode, IntelliJ IDEA и Spring Tool Suite 4. Некоторые обходятся частым тестированием и небольшими корректировками по ходу работы.

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