Основы чистого кода с примерами (Java)

Чистый код - это код, который легко читается, понимается и поддерживается. Он должен быть легко модифицируемым и расширяемым, а также должен быть написан с учетом принципов ООП и других лучших практик программирования. Вот несколько основных аспектов чистого кода:

1. Именование переменных, методов и классов. Имена должны быть понятными и описательными. Они должны отражать назначение элемента кода и должны быть написаны в соответствии с общепринятыми правилами именования.

2. Структура кода. Код должен быть структурирован и организован таким образом, чтобы он был легко читаемым и понятным. Это может включать использование отступов, комментариев, разделения кода на функциональные блоки и т.д.

3. Принцип единственной ответственности. Каждый класс или метод должен иметь только одну ответственность. Это делает код более понятным и легко поддерживаемым.

4. Кодирование на уровне интерфейса. Код должен быть написан таким образом, чтобы он был легко понят и использован другими разработчиками. Это может включать написание документации, использование абстракций и интерфейсов.

5. Тестирование. Чистый код должен быть легко тестируемым. Это может включать написание модульных тестов и использование инструментов для автоматического тестирования.

6. Устранение дублирования кода. Дублирование кода может привести к ошибкам и усложнить поддержку кода. Чистый код должен быть написан таким образом, чтобы избежать дублирования кода.

7. Эффективное использование ресурсов. Чистый код должен быть написан таким образом, чтобы он использовал ресурсы (например, память) эффективно и избегал утечек ресурсов.

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

Ниже привожу примеры по каждому из пунктов:

1. Именование переменных, методов и классов:

public class Calculator {

   private int result;

   public int add(int a, int b) {

       result = a + b;

       return result;

   }

}

2. Структура кода:

public class Main {

   public static void main(String[] args) {

       System.out.println("Hello World!");

   }

}

3. Принцип единственной ответственности:

public class User {

   private String name;

   private String email;

   private String password;

   public void setName(String name) {

       this.name = name;

   }

   public void setEmail(String email) {

       this.email = email;

   }

   public void setPassword(String password) {

       this.password = password;

   }

}

4. Кодирование на уровне интерфейса:

public interface Shape {

   double getArea();

}

public class Rectangle implements Shape {

   private double width;

   private double height;

   public Rectangle(double width, double height) {

       this.width = width;

       this.height = height;

   }

   @Override

   public double getArea() {

       return width * height;

   }

}

5. Тестирование:

import org.junit.Test;

import static org.junit.Assert.assertEquals;

public class CalculatorTest {

   @Test

   public void testAdd() {

       Calculator calculator = new Calculator();

       int result = calculator.add(2, 3);

       assertEquals(5, result);

   }

}

6. Устранение дублирования кода:

public class StringUtils {

   public static boolean isNullOrEmpty(String str) {

       return str == null || str.isEmpty();

   }

}

7. Эффективное использование ресурсов:

public class DatabaseConnection {

   private static Connection connection;

   public static Connection getConnection() throws SQLException {

       if (connection == null) {

           connection = DriverManager.getConnection("jdbc:mysql://localhost:3306/mydatabase", "root", "password");

       }

       return connection;

   }

}