Чистый код. Создание, анализ и рефакторинг

Дублирование — главный враг хорошо спроектированной системы. Его последствия — лишняя работа, лишний риск и лишняя избыточная сложность. Дублирование проявляется во многих формах. Конечно, точное совпадение строк кода свидетельствует о дублировании. Похожие строки часто удается «причесать» так, чтобы сходство стало еще более очевидным; это упростит рефакторинг. Кроме того, дублирование может существовать и в других формах — таких, как дублирование реализации. Например, класс коллекции может содержать следующие методы:

int size() {}

boolean isEmpty() {}

Методы могут иметь разные реализации. Допустим, метод isEmpty может использовать логический флаг, а size — счетчик элементов. Однако мы можем устранить дублирование, связав isEmpty с определением size:

boolean isEmpty() {

   return 0 == size();

}

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

  public void scaleToOneDimension(

       float desiredDimension, float imageDimension) {

    if (Math.abs(desiredDimension - imageDimension) < errorThreshold)

       return;

    float scalingFactor = desiredDimension / imageDimension;

    scalingFactor = (float)(Math.floor(scalingFactor * 100) * 0.01f);

    RenderedOp newImage = ImageUtilities.getScaledImage(

       image, scalingFactor, scalingFactor);

    image.dispose();

    System.gc();

    image = newImage;

}

public synchronized void rotate(int degrees) {

    RenderedOp newImage = ImageUtilities.getRotatedImage(

       image, degrees);

    image.dispose();

    System.gc();

    image = newImage;

}

Чтобы обеспечить чистоту системы, следует устранить незначительное дублирование между методами scaleToOneDimension и rotate:

  public void scaleToOneDimension(

       float desiredDimension, float imageDimension) {

    if (Math.abs(desiredDimension - imageDimension) < errorThreshold)

       return;

    float scalingFactor = desiredDimension / imageDimension;

    scalingFactor = (float)(Math.floor(scalingFactor * 100) * 0.01f);

    replaceImage(ImageUtilities.getScaledImage(

       image, scalingFactor, scalingFactor));

  }

  public synchronized void rotate(int degrees) {

    replaceImage(ImageUtilities.getRotatedImage(image, degrees));

  }

  private void replaceImage(RenderedOp newImage) {

    image.dispose();

    System.gc();

    image = newImage;

  }

В ходе выделения общности конструкций на этом микроскопическом уровне начинают проявляться нарушения принципа SRP. Таким образом, только что сформированный метод можно переместить в другой класс. Это расширяет видимость метода. Другой участник группы может найти возможность дальнейшего абстрагирования нового метода и его использования в другом контексте. Таким образом, принцип «повторного использования даже в мелочах» может привести к значительному сокращению сложности системы. Понимание того, как обеспечить повторное использование в мелочах, абсолютно необходимо для его обеспечения в большом масштабе.

Паттерн ШАБЛОННЫЙ МЕТОД [GOF] относится к числу стандартных приемов устранения высокоуровневого дублирования. Пример:

public class VacationPolicy {

   public void accrueUSDivisionVacation() {

      // Код вычисления продолжительности отпуска

      // по количеству отработанных часов

      // ...

      // Код проверки минимальной продолжительности отпуска

      // по стандартам США

      // ...

      // Код внесения отпуска в платежную ведомость

      // ...

   }

   public void accrueEUDivisionVacation() {

      // Код вычисления продолжительности отпуска

      // по количеству отработанных часов

      // ...