Приборкання звіра: Стратегії рефакторингу застарілого коду

Застарілий код (legacy code). Сам цей термін часто викликає образи громіздких, недокументованих систем, крихких залежностей та всеохопного відчуття страху. Багато розробників по всьому світу стикаються з проблемою підтримки та розвитку цих систем, які часто є критично важливими для бізнес-операцій. Цей вичерпний посібник пропонує практичні стратегії для рефакторингу застарілого коду, перетворюючи джерело розчарування на можливість для модернізації та вдосконалення.

Що таке застарілий код?

Перш ніж занурюватися в техніки рефакторингу, важливо визначити, що ми маємо на увазі під «застарілим кодом». Хоча цей термін може просто стосуватися старого коду, більш тонке визначення зосереджується на його придатності до супроводу. Майкл Фезерс у своїй основоположній книзі «Ефективна робота із застарілим кодом» визначає застарілий код як код без тестів. Ця відсутність тестів ускладнює безпечну модифікацію коду без внесення регресій. Однак застарілий код може мати й інші характеристики:

Брак документації: Початкові розробники могли піти, залишивши мало або зовсім ніякої документації, що пояснювала б архітектуру системи, проектні рішення чи навіть базову функціональність.
Складні залежності: Код може бути тісно зв’язаним, що ускладнює ізоляцію та модифікацію окремих компонентів без впливу на інші частини системи.
Застарілі технології: Код може бути написаний з використанням старих мов програмування, фреймворків або бібліотек, які більше не підтримуються активно, що створює ризики безпеки та обмежує доступ до сучасних інструментів.
Низька якість коду: Код може містити дубльований код, довгі методи та інші «запахи коду», що ускладнюють його розуміння та підтримку.
Крихкий дизайн: Навіть незначні зміни можуть мати непередбачувані та широкі наслідки.

Важливо зазначити, що застарілий код не є поганим за своєю суттю. Він часто представляє значні інвестиції та втілює цінні знання предметної області. Мета рефакторингу — зберегти цю цінність, одночасно покращуючи придатність коду до супроводу, надійність та продуктивність.

Навіщо рефакторити застарілий код?

Рефакторинг застарілого коду може бути складним завданням, але переваги часто переважують труднощі. Ось кілька ключових причин інвестувати в рефакторинг:

Покращена придатність до супроводу: Рефакторинг полегшує розуміння, модифікацію та налагодження коду, зменшуючи вартість та зусилля, необхідні для поточної підтримки. Для глобальних команд це особливо важливо, оскільки це зменшує залежність від конкретних осіб та сприяє обміну знаннями.
Зменшення технічного боргу: Технічний борг — це уявна вартість переробки, спричинена вибором легкого рішення зараз замість використання кращого підходу, який зайняв би більше часу. Рефакторинг допомагає виплатити цей борг, покращуючи загальний стан кодової бази.
Підвищена надійність: Виправляючи «запахи коду» та покращуючи його структуру, рефакторинг може зменшити ризик виникнення помилок та підвищити загальну надійність системи.
Збільшена продуктивність: Рефакторинг може виявити та усунути вузькі місця в продуктивності, що призводить до швидшого виконання та кращої чутливості системи.
Простіша інтеграція: Рефакторинг може полегшити інтеграцію застарілої системи з новими системами та технологіями, уможливлюючи інновації та модернізацію. Наприклад, європейській платформі електронної комерції може знадобитися інтеграція з новим платіжним шлюзом, що використовує інший API.
Покращення морального духу розробників: Працювати з чистим, добре структурованим кодом приємніше та продуктивніше для розробників. Рефакторинг може підвищити моральний дух та залучити таланти.

Визначення кандидатів на рефакторинг

Не весь застарілий код потребує рефакторингу. Важливо пріоритезувати зусилля з рефакторингу на основі наступних факторів:

Частота змін: Код, який часто змінюється, є головним кандидатом на рефакторинг, оскільки покращення придатності до супроводу матиме значний вплив на продуктивність розробки.
Складність: Код, який є складним і важким для розуміння, має більше шансів містити помилки та його важче безпечно змінювати.
Вплив помилок: Код, який є критично важливим для бізнес-операцій або має високий ризик спричинення дорогих помилок, повинен мати пріоритет для рефакторингу.
Вузькі місця продуктивності: Код, який визначено як вузьке місце продуктивності, слід рефакторити для покращення швидкодії.
«Запахи коду»: Слідкуйте за поширеними «запахами коду», такими як довгі методи, великі класи, дубльований код та заздрість до функціональності (feature envy). Це індикатори областей, які можуть виграти від рефакторингу.

Приклад: Уявіть собі глобальну логістичну компанію із застарілою системою управління відправленнями. Модуль, відповідальний за розрахунок вартості доставки, часто оновлюється через зміну правил та цін на пальне. Цей модуль є головним кандидатом на рефакторинг.

Техніки рефакторингу

Існує безліч технік рефакторингу, кожна з яких призначена для усунення конкретних «запахів коду» або покращення певних аспектів коду. Ось деякі з найпоширеніших технік:

Композиція методів

Ці техніки зосереджені на розбитті великих, складних методів на менші, більш керовані. Це покращує читабельність, зменшує дублювання та полегшує тестування коду.

Extract Method (Виокремлення методу): Це передбачає визначення блоку коду, який виконує конкретне завдання, та переміщення його в новий метод.
Inline Method (Вбудовування методу): Це передбачає заміну виклику методу тілом цього методу. Використовуйте це, коли назва методу настільки ж зрозуміла, як і його тіло, або коли ви збираєтеся використовувати Extract Method, але існуючий метод занадто короткий.
Replace Temp with Query (Заміна тимчасової змінної запитом): Це передбачає заміну тимчасової змінної викликом методу, який обчислює значення змінної за запитом.
Introduce Explaining Variable (Введення пояснювальної змінної): Використовуйте це для присвоєння результату виразу змінній з описовою назвою, уточнюючи її призначення.

Переміщення функціональності між об'єктами

Ці техніки зосереджені на покращенні дизайну класів та об'єктів шляхом переміщення відповідальності туди, де вона має бути.

Move Method (Переміщення методу): Це передбачає переміщення методу з одного класу до іншого, де він логічно належить.
Move Field (Переміщення поля): Це передбачає переміщення поля з одного класу до іншого, де воно логічно належить.
Extract Class (Виокремлення класу): Це передбачає створення нового класу з цілісного набору відповідальностей, виокремлених з існуючого класу.
Inline Class (Вбудовування класу): Використовуйте це для злиття класу з іншим, коли він більше не виконує достатньо роботи, щоб виправдати своє існування.
Hide Delegate (Приховування делегата): Це передбачає створення методів на сервері для приховування логіки делегування від клієнта, зменшуючи зв'язок між клієнтом та делегатом.
Remove Middle Man (Видалення посередника): Якщо клас делегує майже всю свою роботу, це допомагає усунути посередника.
Introduce Foreign Method (Введення зовнішнього методу): Додає метод до клієнтського класу для обслуговування клієнта функціями, які дійсно потрібні від серверного класу, але не можуть бути змінені через відсутність доступу або заплановані зміни в серверному класі.
Introduce Local Extension (Введення локального розширення): Створює новий клас, що містить нові методи. Корисно, коли ви не контролюєте джерело класу і не можете додати поведінку безпосередньо.

Організація даних

Ці техніки зосереджені на покращенні способу зберігання та доступу до даних, роблячи їх легшими для розуміння та модифікації.

Replace Data Value with Object (Заміна значення даних об'єктом): Це передбачає заміну простого значення даних об'єктом, який інкапсулює пов'язані дані та поведінку.
Change Value to Reference (Зміна значення на посилання): Це передбачає зміну об'єкта-значення на об'єкт-посилання, коли кілька об'єктів мають однакове значення.
Change Unidirectional Association to Bidirectional (Зміна односпрямованої асоціації на двоспрямовану): Створює двоспрямований зв'язок між двома класами, де існує лише односторонній зв'язок.
Change Bidirectional Association to Unidirectional (Зміна двоспрямованої асоціації на односпрямовану): Спрощує асоціації, роблячи двосторонній зв'язок одностороннім.
Replace Magic Number with Symbolic Constant (Заміна магічного числа символьною константою): Це передбачає заміну літеральних значень іменованими константами, роблячи код легшим для розуміння та підтримки.
Encapsulate Field (Інкапсуляція поля): Надає методи getter і setter для доступу до поля.
Encapsulate Collection (Інкапсуляція колекції): Гарантує, що всі зміни в колекції відбуваються через ретельно контрольовані методи в класі-власнику.
Replace Record with Data Class (Заміна запису класом даних): Створює новий клас з полями, що відповідають структурі запису, та методами доступу.
Replace Type Code with Class (Заміна коду типу класом): Створюйте новий клас, коли код типу має обмежений, відомий набір можливих значень.
Replace Type Code with Subclasses (Заміна коду типу підкласами): Для випадків, коли значення коду типу впливає на поведінку класу.
Replace Type Code with State/Strategy (Заміна коду типу станом/стратегією): Для випадків, коли значення коду типу впливає на поведінку класу, але створення підкласів є недоречним.
Replace Subclass with Fields (Заміна підкласу полями): Видаляє підклас і додає до суперкласу поля, що представляють відмінні властивості підкласу.

Спрощення умовних виразів

Умовна логіка може швидко стати заплутаною. Ці техніки спрямовані на її прояснення та спрощення.

Decompose Conditional (Декомпозиція умови): Це передбачає розбиття складного умовного оператора на менші, більш керовані частини.
Consolidate Conditional Expression (Консолідація умовного виразу): Це передбачає об'єднання кількох умовних операторів в один, більш стислий.
Consolidate Duplicate Conditional Fragments (Консолідація дубльованих умовних фрагментів): Це передбачає переміщення коду, який дублюється в кількох гілках умовного оператора, за межі умови.
Remove Control Flag (Видалення керуючого прапорця): Усунення булевих змінних, що використовуються для керування потоком логіки.
Replace Nested Conditional with Guard Clauses (Заміна вкладених умов захисними операторами): Робить код більш читабельним, розміщуючи всі особливі випадки на початку і зупиняючи обробку, якщо будь-який з них істинний.
Replace Conditional with Polymorphism (Заміна умови поліморфізмом): Це передбачає заміну умовної логіки поліморфізмом, дозволяючи різним об'єктам обробляти різні випадки.
Introduce Null Object (Введення нульового об'єкта): Замість перевірки на null, створіть об'єкт за замовчуванням, який забезпечує стандартну поведінку.
Introduce Assertion (Введення твердження): Явно документуйте очікування, створюючи тест, який їх перевіряє.

Спрощення викликів методів

Rename Method (Перейменування методу): Це здається очевидним, але неймовірно корисно для прояснення коду.
Add Parameter (Додавання параметра): Додавання інформації до сигнатури методу дозволяє зробити метод більш гнучким та придатним до повторного використання.
Remove Parameter (Видалення параметра): Якщо параметр не використовується, позбудьтеся його, щоб спростити інтерфейс.
Separate Query from Modifier (Відокремлення запиту від модифікатора): Якщо метод одночасно змінює та повертає значення, розділіть його на два окремі методи.
Parameterize Method (Параметризація методу): Використовуйте це для об'єднання схожих методів в один метод з параметром, що змінює поведінку.
Replace Parameter with Explicit Methods (Заміна параметра явними методами): Зробіть протилежне до параметризації — розділіть один метод на кілька, кожен з яких представляє конкретне значення параметра.
Preserve Whole Object (Збереження цілого об'єкта): Замість передачі кількох конкретних елементів даних у метод, передайте весь об'єкт, щоб метод мав доступ до всіх його даних.
Replace Parameter with Method (Заміна параметра методом): Якщо метод завжди викликається з тим самим значенням, отриманим з поля, розгляньте можливість отримання значення параметра всередині методу.
Introduce Parameter Object (Введення об'єкта-параметра): Згрупуйте кілька параметрів в об'єкт, коли вони природно належать один до одного.
Remove Setting Method (Видалення методу-сетера): Уникайте сетерів, якщо поле повинно бути ініціалізоване, але не змінене після створення.
Hide Method (Приховування методу): Зменште видимість методу, якщо він використовується лише в одному класі.
Replace Constructor with Factory Method (Заміна конструктора фабричним методом): Більш описова альтернатива конструкторам.
Replace Exception with Test (Заміна винятку тестом): Якщо винятки використовуються як керування потоком, замініть їх умовною логікою для покращення продуктивності.

Робота з узагальненням

Pull Up Field (Підняття поля): Переміщення поля з підкласу до його суперкласу.
Pull Up Method (Підняття методу): Переміщення методу з підкласу до його суперкласу.
Pull Up Constructor Body (Підняття тіла конструктора): Переміщення тіла конструктора з підкласу до його суперкласу.
Push Down Method (Спуск методу): Переміщення методу з суперкласу до його підкласів.
Push Down Field (Спуск поля): Переміщення поля з суперкласу до його підкласів.
Extract Interface (Виокремлення інтерфейсу): Створює інтерфейс з публічних методів класу.
Extract Superclass (Виокремлення суперкласу): Переміщення спільної функціональності з двох класів до нового суперкласу.
Collapse Hierarchy (Згортання ієрархії): Об'єднання суперкласу та підкласу в один клас.
Form Template Method (Формування шаблонного методу): Створення шаблонного методу в суперкласі, який визначає кроки алгоритму, дозволяючи підкласам перевизначати конкретні кроки.
Replace Inheritance with Delegation (Заміна успадкування делегуванням): Створення поля в класі, що посилається на функціональність, замість її успадкування.
Replace Delegation with Inheritance (Заміна делегування успадкуванням): Коли делегування є занадто складним, перейдіть на успадкування.

Це лише кілька прикладів з багатьох доступних технік рефакторингу. Вибір техніки залежить від конкретного «запаху коду» та бажаного результату.

Приклад: Великий метод у Java-додатку, що використовується глобальним банком, розраховує процентні ставки. Застосування Extract Method для створення менших, більш сфокусованих методів покращує читабельність і полегшує оновлення логіки розрахунку процентної ставки, не впливаючи на інші частини методу.

Процес рефакторингу

До рефакторингу слід підходити систематично, щоб мінімізувати ризик і максимізувати шанси на успіх. Ось рекомендований процес:

Визначте кандидатів на рефакторинг: Використовуйте згадані раніше критерії для визначення ділянок коду, які найбільше виграють від рефакторингу.
Створіть тести: Перед внесенням будь-яких змін напишіть автоматизовані тести для перевірки існуючої поведінки коду. Це надзвичайно важливо для того, щоб рефакторинг не вніс регресій. Для написання юніт-тестів можна використовувати такі інструменти, як JUnit (Java), pytest (Python) або Jest (JavaScript).
Рефакторте інкрементально: Вносьте невеликі, поступові зміни та запускайте тести після кожної зміни. Це полегшує виявлення та виправлення будь-яких помилок, що виникають.
Часто робіть коміти: Часто зберігайте свої зміни в системі контролю версій. Це дозволяє легко повернутися до попередньої версії, якщо щось піде не так.
Перевіряйте код (Code Review): Попросіть іншого розробника перевірити ваш код. Це може допомогти виявити потенційні проблеми та переконатися, що рефакторинг виконано правильно.
Моніторте продуктивність: Після рефакторингу відстежуйте продуктивність системи, щоб переконатися, що зміни не спричинили регресій у швидкодії.

Приклад: Команда, що займається рефакторингом модуля на Python на глобальній платформі електронної комерції, використовує `pytest` для створення юніт-тестів для існуючої функціональності. Потім вони застосовують рефакторинг Extract Class, щоб розділити відповідальності та покращити структуру модуля. Після кожної невеликої зміни вони запускають тести, щоб переконатися, що функціональність залишається незмінною.

Стратегії впровадження тестів у застарілий код

Як влучно зазначив Майкл Фезерс, застарілий код — це код без тестів. Впровадження тестів у існуючі кодові бази може здатися величезним завданням, але це необхідно для безпечного рефакторингу. Ось кілька стратегій для вирішення цього завдання:

Характеризаційні тести (або тести «Золотого майстра»)

Коли ви маєте справу з кодом, який важко зрозуміти, характеризаційні тести можуть допомогти вам зафіксувати його існуючу поведінку, перш ніж ви почнете вносити зміни. Ідея полягає в тому, щоб написати тести, які стверджують поточний вивід коду для заданого набору вхідних даних. Ці тести не обов'язково перевіряють коректність; вони просто документують, що код *на даний момент* робить.

Кроки:

Визначте одиницю коду, яку ви хочете схарактеризувати (наприклад, функцію або метод).
Створіть набір вхідних значень, які представляють діапазон поширених та граничних випадків.
Запустіть код з цими вхідними даними та зафіксуйте отримані результати.
Напишіть тести, які стверджують, що код виробляє саме ці результати для цих вхідних даних.

Застереження: Характеризаційні тести можуть бути крихкими, якщо базова логіка складна або залежить від даних. Будьте готові оновлювати їх, якщо вам знадобиться змінити поведінку коду пізніше.

Метод «Паросток» (Sprout Method) та Клас «Паросток» (Sprout Class)

Ці техніки, також описані Майклом Фезерсом, спрямовані на впровадження нової функціональності в застарілу систему, мінімізуючи ризик пошкодження існуючого коду.

Sprout Method: Коли вам потрібно додати нову функцію, що вимагає зміни існуючого методу, створіть новий метод, який містить нову логіку. Потім викличте цей новий метод з існуючого методу. Це дозволяє ізолювати новий код і тестувати його незалежно.

Sprout Class: Аналогічно до Sprout Method, але для класів. Створіть новий клас, який реалізує нову функціональність, а потім інтегруйте його в існуючу систему.

Пісочниця (Sandboxing)

Пісочниця передбачає ізоляцію застарілого коду від решти системи, що дозволяє тестувати його в контрольованому середовищі. Це можна зробити, створюючи моки (mocks) або стабби (stubs) для залежностей, або запускаючи код у віртуальній машині.

Метод Мікадо (The Mikado Method)

Метод Мікадо — це візуальний підхід до вирішення проблем для виконання складних завдань рефакторингу. Він передбачає створення діаграми, яка представляє залежності між різними частинами коду, а потім рефакторинг коду таким чином, щоб мінімізувати вплив на інші частини системи. Основний принцип — «спробувати» зміну і подивитися, що зламається. Якщо щось ламається, поверніться до останнього робочого стану і зафіксуйте проблему. Потім вирішіть цю проблему, перш ніж повторно спробувати початкову зміну.

Інструменти для рефакторингу

Кілька інструментів можуть допомогти з рефакторингом, автоматизуючи рутинні завдання та надаючи рекомендації щодо найкращих практик. Ці інструменти часто інтегровані в інтегровані середовища розробки (IDE):

IDE (наприклад, IntelliJ IDEA, Eclipse, Visual Studio): IDE надають вбудовані інструменти рефакторингу, які можуть автоматично виконувати такі завдання, як перейменування змінних, виокремлення методів та переміщення класів.
Інструменти статичного аналізу (наприклад, SonarQube, Checkstyle, PMD): Ці інструменти аналізують код на наявність «запахів коду», потенційних помилок та вразливостей безпеки. Вони можуть допомогти визначити ділянки коду, які виграють від рефакторингу.
Інструменти покриття коду (наприклад, JaCoCo, Cobertura): Ці інструменти вимірюють відсоток коду, покритого тестами. Вони можуть допомогти визначити ділянки коду, які недостатньо протестовані.
Браузери рефакторингу (наприклад, Smalltalk Refactoring Browser): Спеціалізовані інструменти, які допомагають у великих реструктуризаційних заходах.

Приклад: Команда розробників, що працює над C# додатком для глобальної страхової компанії, використовує вбудовані інструменти рефакторингу Visual Studio для автоматичного перейменування змінних та виокремлення методів. Вони також використовують SonarQube для виявлення «запахів коду» та потенційних вразливостей.

Виклики та ризики

Рефакторинг застарілого коду не позбавлений викликів та ризиків:

Внесення регресій: Найбільший ризик — це внесення помилок під час процесу рефакторингу. Це можна пом'якшити, написавши вичерпні тести та рефакторячи інкрементально.
Брак знань про предметну область: Якщо початкові розробники пішли, може бути важко зрозуміти код та його призначення. Це може призвести до неправильних рішень щодо рефакторингу.
Тісний зв'язок: Тісно зв'язаний код важче рефакторити, оскільки зміни в одній частині коду можуть мати непередбачені наслідки для інших частин.
Часові обмеження: Рефакторинг може зайняти час, і може бути важко виправдати інвестиції перед зацікавленими сторонами, які зосереджені на доставці нових функцій.
Опір змінам: Деякі розробники можуть чинити опір рефакторингу, особливо якщо вони не знайомі з відповідними техніками.

Найкращі практики

Щоб пом'якшити виклики та ризики, пов'язані з рефакторингом застарілого коду, дотримуйтесь цих найкращих практик:

Отримайте згоду: Переконайтеся, що зацікавлені сторони розуміють переваги рефакторингу та готові інвестувати необхідний час та ресурси.
Починайте з малого: Почніть з рефакторингу невеликих, ізольованих частин коду. Це допоможе зміцнити впевненість та продемонструвати цінність рефакторингу.
Рефакторте інкрементально: Вносьте невеликі, поступові зміни та часто тестуйте. Це полегшить виявлення та виправлення будь-яких помилок, що виникають.
Автоматизуйте тести: Напишіть вичерпні автоматизовані тести для перевірки поведінки коду до та після рефакторингу.
Використовуйте інструменти для рефакторингу: Використовуйте інструменти рефакторингу, доступні у вашому IDE або інших інструментах, для автоматизації рутинних завдань та надання рекомендацій щодо найкращих практик.
Документуйте свої зміни: Документуйте зміни, які ви вносите під час рефакторингу. Це допоможе іншим розробникам зрозуміти код і уникнути внесення регресій у майбутньому.
Постійний рефакторинг: Зробіть рефакторинг постійною частиною процесу розробки, а не одноразовою подією. Це допоможе підтримувати кодову базу чистою та придатною до супроводу.

Висновок

Рефакторинг застарілого коду — це складне, але вдячне заняття. Дотримуючись стратегій та найкращих практик, викладених у цьому посібнику, ви зможете приборкати звіра та перетворити ваші застарілі системи на придатні до супроводу, надійні та високопродуктивні активи. Пам'ятайте, що до рефакторингу слід підходити систематично, часто тестувати та ефективно спілкуватися з командою. Завдяки ретельному плануванню та виконанню ви зможете розкрити прихований потенціал вашого застарілого коду та прокласти шлях для майбутніх інновацій.