Clean Code Cookbook

Рецепти за подобряване на дизайна и качеството на кода.

Софтуерните инженери и архитекти, работещи с големи и сложни кодови бази, трябва да могат да ги поддържат и разширяват ефективно. Книгата с рецепти на Максимилиано Контиери ви отвежда отвъд концепцията за чистия код, като ви показва как да идентифицирате възможностите за извършване на подобрения и да оценявате потенциалното им въздействие върху продуктовия код. Когато става дума за надеждност и еволюция на системата, тези техники носят ползи, които се отплащат във времето.

В книгата ще намерите доказани рецепти за реални ситуации на JavaScript, PHP, Python, Java и много други езици за програмиране, които ще ви помогнат при поддръжката и мащабирането на големи системи. Включени са фундаментални концепции за чист код, сред които четимост, функционална обвързаност, тестове, безопасност, разширяемост и миришещ код, заедно със съответните рецепти.

От тази книга:

• ще научите за ползите от чистия код и ще разберете как да идентифицирате възможностите за подобрение;
• ще се запознаете с техники за рефакторинг стъпка по стъпка;
• ще разберете теорията зад чистия код;
• ще видите реални примери на различни ези­ци за програмиране;
• ще получите изчерпателен каталог с миришещи кодове, заедно с обсега на въздействието им и възможните решения;
• ще започнете да пишете код по същество, отдавайки превес на четимостта.

Представените в книгата рецепти за рефакторинг и проблемите, които се решават с тях, са с нарастваща сложност.

"Изключително съдържателна книга с добре обяснена теория и много практически примери. Препоръчителна за всички, опит­ващи се да създават качествен софтуер."
Даниел Мока, софтуерен разработчик в Moka IT

"Макси е учен практик, чийто богат опит в софтуерната разработка е синтезиран по великолепен начин в книгата."
Алекс Бунарджич, софтуерен разработчик и инструктор

Максимилиано Контиери е в софтуерната индустрия повече от 25 години, като в същото време чете лекции по компютърни науки в Университета на Буенос Айрес. Пише статии за чист код, рефакторинг и миришещ код в популярни платформи. Максимилиано изповядва декларативните и поведенчески парадигми в програмирането, залагайки на основите на софтуера, с цел създаването на елегантни, мащабируеми и стабилни решения.

Асеневци трейд ЕООД
София, 1618
р-н Витоша, Еровете № 13, ет. 2
store@asenevtsi.com

Предисловие
Предговор
За кого е тази книга?
Как е организирана книгата?
Какво е необходимо за работа с книгата?
Достъп до книгата в дигитален формат
Конвенции, използвани в книгата
Използване на примерните кодове
Онлайн обучение с O'Reilly
Как да се свържете с нас?
Благодарности
Чист код

• Какво означава миришещ код?
• Какво е рефакторинг?
• Какво е рецепта?
• Защо чист код?
• Четимост, производителност или и двете
• Типове софтуер
• Машинно генериран код
• Относно употребата на някои термини в книгата
• Шаблони за дизайн
• Парадигми в езиците за програмиране
• Обекти срещу класове
• Способност да се променя

Основни аксиоми

• Въведение
• Защо е модел?
• Защо е абстрактно?
• Защо е програмируемо?
• Защо е частично?
• Защо е обяснителен?
• Защо се отнася до реалността?
• Извеждане на правилата
• Един и само един принцип за дизайн на софтуер

Анемични модели

• Въведение
• Преобразуване на анемичните обекти в богати обекти
• Идентифициране същността на обектите
• Премахване на сетърите от обектите
• Премахване генераторите на анемичен код
• Премахване на автоматичните свойства
• Премахване на DTO
• Завършване на празните конструктори
• Премахване на гетърите
• Предотвратяване на обектна оргия
• Премахване на динамичните свойства

Мания по примитиви

• Въведение
• Създаване на малки обекти
• Опредметяване на примитивните данни
• Опредметяване на асоциативните масиви
• Премахване на злоупотребата с низове
• Опредметяване на времевите отпечатъци
• Представяне на подмножествата като обекти
• Опредметяване на валидацията на низове
• Премахване на ненужнитесвойства
• Създаване на интервали от дати

Изменяемост

• Въведение
• Смяна на var с const
• Деклариране на променливите като променливи
• Забраняване на промени в същността
• Избягване на изменяеми константни масиви
• Премахване на късната инициализация
• Замразяване на изменяемите константи
• Премахване на страничните ефекти
• Предотвратяване на повдигане

Декларативен код

• Въведение
• Стесняване на преизползваемите променливи
• Отстраняване на празните редове
• Премахване на методите с версии
• Премахване на двойните отрицания
• Промяна на неправилно поставените отговорности
• Замяна на явните итерации
• Документиране на решенията за дизайна
• Замяна на магическите числа с константи
• Разделяне на Какво от Как
• Документиране на регулярните изрази
• Пренаписване на условията на Йода
• Премахване на комичните методи
• Избягване на ада от обратни извиквания
• Генериране на добри съобщения за грешка
• Избягване на магическите корекции

Наименуване

• Въведение
• Разгръщане на съкращенията
• Преименуване и разбиване на помощниците и спомагателните програми
• Преименуване на MyObject
• Преименуване на променливите result
• Преименуване на променливите с название на типа
• Преименуване на дългите имена
• Смяна на абстрактните имена
• Коригиране на правописните грешки
• Премахване на името на класа от атрибутите
• Премахване на първата буква от класовете и интерфейсите
• Преименуване на Basic / Do функциите
• Преобразуване на имена на класове от мн.ч. в ед.ч.
• Премахване на Collection от имената
• Премахване на Impl от имената на класовете
• Преименуване на аргументите според ролята
• Премахване на повтарящите се имена на параметри
• Премахване на необоснования контекст от имената
• Избягване на data в имената

Коментари

• Въведение
• Премахване на коментирания код
• Премахване на остарелите коментари
• Премахване на логическите коментари
• Премахване коментарите на гетъра
• Преобразуване на коментарите в имена на функции
• Отстраняване на коментарите в методите
• Замяна на коментарите с тестове

Стандарти

• Въведение
• Придържане към стандарти за писане на код
• Стандартизиране на отстоянията
• Унифициране на конвенциите за регистъра на буквите
• Пишете кода на английски
• Унифициране на реда на параметрите
• Поправка на счупени прозорци

Сложност

• Въведение
• Премахване на повтарящия се код
• Премахване на Settings / Configs и превключвателите на функционалност
• Промяна на състоянието като свойство
• Премахване на хитрините в кода
• Прекъсване на многочислените обещания
• Прекъсване на дългите вериги за съвместна работа
• Изваждане на метод в обект
• Внимавайте с конструкторите на масиви
• Премахване на полтъргайст обектите

Подутини

• Въведение
• Разбиване на твърде дългите методи
• Редуциране на излишните аргументи
• Редуциране на излишните променливи
• Премахване на излишните скоби
• Премахване на излишните методи
• Разбиване на твърде многото атрибути
• Съкращаване на списъците с команди за импортиране
• Разбиване на And функции
• Разбиване на тлъстите интерфейси

YAGNI

• Въведение
• Премахване на мъртъв код
• Използване на код вместо диаграми
• Рефакторинг на класовете с един подклас
• Премахване на еднократните интерфейси
• Отстраняване на злоупотребите с шаблони за дизайн
• Замяна на бизнес колекциите

Бърз отказ

• Въведение
• Рефакторинг на повторно използваните променливи
• Налагане на предварителни условия
• Използване на по-стриктни параметри
• Премахване на Default от Switch конструкциите
• Избягване модифицирането на колекции по време на обхождане
• Предефиниране на хеша и еднаквостта
• Рефакторинг без функционални промени

If условия

• Въведение
• Замяна на инцидентни If инструкции с полиморфизъм
• Преименуване на флаговите променливи за събития
• Опредметяване на булевите променливи
• Замяна на инструкциите Switch / Case / Elseif
• Замяна на твърдо кодираните If условия с колекции
• Смяна на булевите изчисления с кратки схеми
• Добавяне на имплицитната Else клауза
• Пренаписване на условията със стъпаловидна форма
• Избягване на хакове с кратка схема
• Пренаписване на вложения стъпаловиден код
• Предотвратяване връщането на булеви стойности при проверки на условие
• Смяна на сравненията по булева стойност
• Изваждане от дълги тернарни изрази
• Преобразуване на неполиморфни функции в полиморфни
• Промяна на проверката за еднаквост
• Опредметяване на твърдо кодираните бизнес условия
• Премахване на необоснованата булевост
• Пренаписване на вложените тернарни изрази

Null

• Въведение
• Създаване на Null Обекти
• Премахване на опционалните вериги
• Преобразуване на незадължителните атрибути в колекция
• Използване на реални обекти за Null
• Представяне на неизвестни местоположения без използване на Null

Преждевременна оптимизация

• Въведение
• Избягване на ID полета в обектите
• Премахване на преждевременната оптимизация
• Премахване на побитовите преждевременни оптимизации
• Съкращаване на свръхгенерализацията
• Промяна на структурната оптимизация
• Премахване на закотвените лодки
• Изваждане на кеша от обектите на ключовата област
• Премахване на събитията за обратно извикване, базирани на имплементация
• Премахване на заявките от конструкторите
• Премахване на кода от деструкторите

Функционално обвързване

• Въведение
• Правим скритите допускания явни
• Замяна на Сек
• Разбиване на божествените обекти
• Разбиване на дивергентната промяна
• Преобразуване на специалната маркирана стойност 9999 в нормална
• Премахване на стрелбата с топ
• Премахване на незадължителните аргументи
• Предотвратяване на завистливи функции
• Премахване на посредника
• Преместване на аргументите по подразбиране в края
• Избягване на пулсиращ ефект
• Премахване на инцидентните методи от бизнес обектите
• Премахване на бизнес кода от потребителския интерфейс
• Смяна на функционалната обвързаност с класове
• Рефакторинг на скупчени данни
• Прекъсване на неуместна интимност
• Преобразуване на заменими обекти

Глобални елементи

• Въведение
• Опредметяване на глобалните функции
• Опредметяване на статичните функции
• Замяна на GoTo със структурен код
• Премахване на глобалните класове
• Смяна на глобалното създаване на дата

Йерархии

• Въведение
• Разбиване на дълбокото наследяване
• Разбиване на йо-йо йерархиите
• Разбиване на подкласификацията за повторно използване на кода
• Замяна на връзка от тип E с поведение
• Премахване на вложените класове
• Преименуване на изолираните класове
• Преобразуване конкретните класове във финални
• Явно дефиниране на наследяването
• Мигриране на празните класове
• Отлагане на преждевременната класификация
• Премахване на защитените атрибути
• Завършване на празните имплементации

Тестване

• Въведение
• Тестване на частни методи
• Добавяне на описания към твърденията
• Мигриране на assertTrue към специфични твърдения
• Замяна на имитиращите обекти с реални
• Прецизиране на общите твърдения
• Премахване на нестабилните тестове
• Смяна на твърденията с числа с плаваща запетая
• Смяна на тестовите данни с реалистични данни
• Предпазване от тестове, които нарушават капсулирането
• Премахване на нерелевантната тестова информация
• Покриване на всяка заявка за сливане
• Пренаписване на зависимите от дати тестове
• Изучаване на нов език за програмиране

Технически дълг

• Въведение
• Премахване на зависимостите от продуктовия режим
• Премахване тракерите на дефекти
• Премахване на Warning / Strict Off
• Предотвратяване и премахване на ToDo и FixMe

Изключения

• Въведение
• Премахване на празните блокове за изключения
• Премахване на ненужните изключения
• Пренаписване на изключенията за очакваните случаи
• Пренаписване на вложените Try / Catch конструкции
• Замяна на връщане на код с изключения
• Пренаписване на изключенията със стъпаловиден код
• Скриване на грешки от ниско ниво от крайните потребители
• Стесняване на try блоковете

Метапрограмиране

• Въведение
• Премахване на метапрограмирането
• Опредметяване на анонимните функции
• Премахване на предпроцесорите
• Премахване на динамичните методи

Типове

• Въведение
• Премахване на проверките за типа
• Справяне с истинните стойности
• Смяна на числата с плаваща запетая с реални числа с десетична стойност

Безопасност

• Въведение
• Саниране на входните данни
• Промяна на последователни ID
• Премахване на зависимостите от пакети
• Замяна на лошите регулярни изрази
• Защита на десериализацията на обектите

Речник на термините
Колофон
За автора