Простий рефакторинг коду на основі WordPress
У 2011 році я багато читав про роботу зі старим кодом, якість коду та рефакторинг.
Є цитата Мартіна Фаулера (який буквально написав книгу про рефакторинг), приписувана дядькові Бобу, яка застрягла в мені – і я впевнений, у багатьох, багатьох програмістів – відтоді:
завжди залишайте код у кращому стані, ніж ви його знайшли
Справа в цій конкретній ідеї полягає в тому, що я думаю, що вона може звучати дещо більш ідеалістично, доки ви дійсно не почнете намагатися застосовувати її в усьому, що ви робите.
Тобто, якщо прийняти це за чисту монету, це звучить так, що коли вам потрібно працювати над кодовою базою, то вам потрібно залишити всю кодову базу краще, ніж тоді, коли ви її знайшли. Але чим більше я намагався застосувати це правило у своїй повсякденній роботі, тим практичнішим, чистішим і придатнішим для обслуговування ставав код WordPress.
Отже, коли справа доходить до рефакторингу коду на основі WordPress, як це виглядає?
Це не буде довгим дописом. Натомість я просто збираюся поділитися кількома пунктами, яких я дотримуюся, коли справа доходить до роботи над кодом, який я написав раніше, з яким я стикався від інших або з кодової бази, над якою я працював разом з іншими в минуле.
Без особливого порядку:
- Не будьте ідеалістами; Будьте практичними. Рефакторинг цілої кодової бази – це не практика, особливо якщо кодова база не загорнута в модульні тести. Подивіться на код, над яким ви працюєте, і подивіться, які незначні зміни ви можете зробити, щоб покращити його.
- Використовуйте останні стандарти. Вам не потрібно налаштовувати абсолютно нове середовище розробки для старішого коду. Замість цього просто переконайтеся, що у вас є хороші сніфери коду. Якщо ви перейшли зі стандартів кодування WordPress на PSR, подивіться на попередження або повідомлення, які видають сніфери, і спробуйте оновити код лише в цьому файлі (або наборі файлів).
- Напишіть допоміжні функції. Якщо ваші функції занадто довгі, шукайте способи полегшити роботу з ними. Спочатку оновіть будь-які керуючі структури, такі як цикли чи умови, а потім напишіть допоміжні функції, щоб їх було легше читати.
- Додати тести (якщо можливо). Якщо у вас уже є структура модульного тестування, додайте тести для свого нового коду. Якщо у вас немає часу або рамок, не переймайтеся. Як би це не проповідували прагматичні програмісти, не завжди є час додавати тести. (Це не означає, що вони не є корисними або не повинні бути включені, але що це не завжди практично включати їх у будь-який момент часу).
Деякі речі, які я роблю в останніх проектах, також включають прості речі:
- оновлення назв змінних і функцій відповідно до PSR,
- зміна табуляції на пробіли,
- додавання допоміжних функцій, щоб зробити умови та цикли більш читабельними,
- поділ класів, щоб вони мали вищий ступінь згуртованості,
- покращити doc-блоки кожної функції
Це лише деякі приклади, і це явно не вичерпний список. Але суть не в цьому. Натомість я хочу просто поділитися тим, як ви можете застосувати рефакторинг коду на основі WordPress, водночас виконуючи свою повсякденну роботу в керований спосіб.
Усі наведені вище зміни чи рекомендації зазвичай можна зробити за допомогою IDE, кількох ярликів і, можливо, з півгодини додаткового часу (і я ліберальний у цій оцінці).
Отже, ні, вам не потрібно переписувати всю кодову базу. Я навіть не знаю, чи це практична мета, до якої варто прагнути. Але ви можете виправити один маленький шматочок загальної системи, за яку ви відповідаєте?
А чому б хоча б не прагнути до цього?