javaadmin
Чистий код (Clean Code) — це запорука зрозумілості, підтримуваності та масштабованості будь-якого програмного продукту. Код, написаний із дотриманням принципів Clean Code, легше читати, тестувати та підтримувати, навіть якщо над ним працює команда з багатьох розробників. У цій статті ми розглянемо сучасні підходи до написання чистого коду в Java, які допоможуть вам створювати не лише робочий, але й елегантний код.
У цьому уроці ми розглянемо принципи чистого кодування. Ми також зрозуміємо, чому чистий код важливий і як його досягти в Java. Крім того, ми дізнаємося, чи існують інструменти, які можуть нам у цьому допомогти.
Що таке Clean Code?
Будь-який дурень може написати код, який зрозуміє комп’ютер. Хороші програмісти пишуть код, який може зрозуміти людина.
Чистий код — це код, який:
- Легко читається та зрозумілий без потреби витрачати багато часу на розбір.
- Простий у підтримці та може бути змінений із мінімальними зусиллями.
- Відповідає SOLID-принципам і DRY (Don’t Repeat Yourself).
- Тестується та перевіряється автоматично.
Давайте розглянемо деякі характеристики чистого коду:
Сфокусованість: Шматок коду повинен бути написаний для вирішення конкретної проблеми. Він не повинен робити нічого, що строго не пов’язано з вирішенням даної проблеми. Це стосується всіх рівнів абстракції в коді, таких як метод, клас, пакет або модуль.
Простота: Це, безумовно, найважливіша і часто ігнорована характеристика чистого коду. Дизайн та реалізація програмного забезпечення повинні бути максимально простими, що допоможе нам досягти бажаних результатів. Збільшення складності коду робить його схильним до помилок, а також ускладнює його читання та підтримку.
Тестування: Чистий код, будучи простим, повинен вирішувати поставлену задачу. Тестування кодової бази має бути інтуїтивно зрозумілим і простим, бажано в автоматизованому режимі. Це допомагає встановити базову поведінку кодової бази і полегшує її зміну, не порушуючи нічого.
Це те, що допомагає нам досягти цілей, про які йшлося в попередньому розділі. Починати розробку з урахуванням цих характеристик вигідніше, ніж потім проводити рефакторинг. Це призводить до зниження загальної вартості володіння протягом життєвого циклу програмного забезпечення.
Сучасні підходи до написання чистого коду в Java
1. Людинорозумні імена
Імена класів, методів, змінних та інших елементів програми мають бути зрозумілими, описовими та такими, що легко читаються.
Поганий приклад:
int a = 100; // Що таке 'a'?Гарний приклад:
int maxAllowedConnections = 100;Принципи:
- Класи та інтерфейси: Використовуйте зрозумілі назви, які відображають суть, наприклад,
UserRepository,InvoiceService. - Методи: Називайте методи згідно з діями, які вони виконують:
calculateTotal(),fetchUserById(). - Не використовуйте скорочення, які не мають загального правила тлумачення.
2. Малі методи
Методи мають бути короткими та виконувати лише одну конкретну дію. Якщо метод виконує кілька дій, це сигнал для рефакторингу.
Поганий приклад:
public void processOrder(Order order) {
validateOrder(order);
calculateTax(order);
saveToDatabase(order);
sendNotification(order);
}Гарний приклад:
public void processOrder(Order order) {
validateOrder(order);
calculateTax(order);
saveOrder(order);
notifyCustomer(order);
}Розбийте великий метод на менші приватні методи, щоб кожен з них виконував окреме завдання.
3. DRY (Don’t Repeat Yourself)
Не дублюйте код. Якщо ви бачите повторювані фрагменти, винесіть їх у спільний метод, клас або утиліту.
Поганий приклад:
int calculateTax() {
return (int) (salary * 0.2);
}
int calculateDiscount() {
return (int) (salary * 0.2);
}Гарний приклад:
int calculatePercentage(double value, double percentage) {
return (int) (value * percentage);
}Розумне перевикористання коду допомагає уникати помилок і зменшувати технічне навантаження.
4. SOLID-принципи
Чистий код у Java має бути побудований із дотриманням принципів SOLID:
- Single Responsibility Principle (SRP): Клас має виконувати лише одну відповідальність.
- Open-Closed Principle (OCP): Класи повинні бути відкриті для розширення, але закриті для модифікації.
- Liskov Substitution Principle (LSP): Об’єкти підкласу мають заміняти об’єкти батьківського класу без порушення логіки.
- Interface Segregation Principle (ISP): Уникайте великих інтерфейсів; створюйте вузькі та спеціалізовані.
- Dependency Inversion Principle (DIP): Залежності мають будуватися на абстракціях, а не на конкретних реалізаціях.
Приклад для Single Responsibility Principle:
// Погано: Клас займається і логікою замовлень, і логуваннямclass OrderProcessor {
public void processOrder(Order order) {
// Логіка обробки замовлення
}
public void logOrder(Order order) {
// Логіка логування
}
}// Добре: Винесли логування в окремий клас
class OrderProcessor {
public void processOrder(Order order) {
// Логіка обробки замовлення
}
}
class OrderLogger {
public void logOrder(Order order) {
// Логіка логування
}
}5. Не ускладнюйте код
Програмування — це, перш за все, вміння вирішувати задачі, а не демонстрація складності. Уникайте занадто складних конструкцій і пишіть код так, щоб його могли легко зрозуміти інші розробники.
Поганий приклад:
if ((a && !b) || (!a && b)) {
// XOR логіка
}Гарний приклад:
if (a ^ b) {
// Використання логічного XOR
}Використовуйте сучасні засоби, такі як стріми та лямбда-вирази, але не доводьте це до фанатизму бо хтось потім буде це читати.
6. Використовуйте Java Streams та Functional Programming
Сучасні версії Java (Java 8 і вище) підтримують функціональний підхід, що робить код більш елегантним і читабельним.
Поганий приклад:
List<String> names = new ArrayList<>();
for (Person person : persons) {
if (person.getAge() > 18) {
names.add(person.getName());
}
}Гарний приклад:
List<String> names = persons.stream() .filter(person -> person.getAge() > 18)
.map(Person::getName)
.collect(Collectors.toList());Стріми дозволяють уникнути явно імперативного стилю та зробити код коротшим і зрозумілішим.
7. Дотримуйтесь правил форматування
Чистий код — це також правильне форматування:
- Використовуйте пробіли та відступи.
- Розділяйте логічно пов’язані блоки коду порожніми рядками.
- Зберігайте консистентність у стилі форматування.
8. Пишіть тести
Чистий код неможливий без тестування. Пишіть тести для кожного важливого функціонала:
- Unit-тести для перевірки маленьких частин коду.
- Integration-тести для перевірки взаємодії компонентів.
- Test-Driven Development (TDD): Спочатку пишіть тест, потім реалізуйте функціонал.
Приклад (JUnit 5):
@Test
void shouldCalculateTotalCorrectly() {
Order order = new Order();
order.addItem(new Item("Apple", 2.5));
order.addItem(new Item("Banana", 1.5));
assertEquals(4.0, order.calculateTotal());
}9. Логування
Логування є важливим інструментом для аналізу системи. Використовуйте сучасні бібліотеки, такі як SLF4J з Logback або Log4J 2, і логуйте лише необхідну інформацію.
10. Структура проекту
Хоча Java не нав’язує жодної структури проекту, завжди корисно дотримуватися послідовного шаблону для організації наших вихідних файлів, тестів, конфігурацій, даних та інших артефактів коду. Maven, популярний інструмент збірки для Java, пропонує певну структуру проекту. Хоча ми можемо не використовувати Maven, завжди корисно дотримуватися певної конвенції.
Conclusion
Чистий код у Java — це більше, ніж просто набір правил. Це філософія, яка допомагає створювати якісний програмний продукт. Дотримуючись принципів Clean Code та використовуючи сучасні підходи (Java Streams, SOLID, DRY, TDD), ви не тільки створюватимете код, який працює, але й забезпечите його читабельність, підтримуваність та масштабованість. Завжди ставте себе на місце іншого розробника, котрий читатиме ваш код — це і є секрет чистого коду.
Написання чистого коду – це питання особистої звички так само, як і питання навичок. Як розробник, ми з часом зростаємо завдяки досвіду та знанням. Але ми повинні запитати, чому ми повинні інвестувати в розробку чистого коду? Ми розуміємо, що іншим, ймовірно, буде легше читати наш код, але чи є це достатнім стимулом? Давайте з’ясуємо! Принципи чистого кодування допомагають нам досягти багатьох бажаних цілей, пов’язаних з програмним забезпеченням, яке ми маємо намір створити. Давайте пройдемося по ним, щоб краще їх зрозуміти:
