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

  private boolean areStringsEqual() {

    return fExpected.equals(fActual);

  }

}

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

Листинг 15.3. ComparisonCompator.java (переработанная версия)

package junit.framework;

public class ComparisonCompactor {

  private int ctxt;

  private String s1;

  private String s2;

  private int pfx;

  private int sfx;

  public ComparisonCompactor(int ctxt, String s1, String s2) {

    this.ctxt = ctxt;

    this.s1 = s1;

    this.s2 = s2;

  }

  public String compact(String msg) {

    if (s1 == null || s2 == null || s1.equals(s2))

      return Assert.format(msg, s1, s2);

    pfx = 0;

    for (; pfx < Math.min(s1.length(), s2.length()); pfx++) {

      if (s1.charAt(pfx) != s2.charAt(pfx))

        break;

    }

    int sfx1 = s1.length() - 1;

    int sfx2 = s2.length() - 1;

    for (; sfx2 >= pfx && sfx1 >= pfx; sfx2--, sfx1--) {

      if (s1.charAt(sfx1) != s2.charAt(sfx2))

        break;

    }

    sfx = s1.length() - sfx1;

    String cmp1 = compactString(s1);

    String cmp2 = compactString(s2);

    return Assert.format(msg, cmp1, cmp2);

  }

  private String compactString(String s) {

    String result =

      "[" + s.substring(pfx, s.length() - sfx + 1) + "]";

    if (pfx > 0)

      result = (pfx > ctxt ? "..." : "") +

        s1.substring(Math.max(0, pfx - ctxt), pfx) + result;

    if (sfx > 0) {

      int end = Math.min(s1.length() - sfx + 1 + ctxt, s1.length());

      result = result + (s1.substring(s1.length() - sfx + 1, end) +

        (s1.length() - sfx + 1 < s1.length() - ctxt ? "..." : ""));

    }

    return result;

  }

}

Авторы оставили эту модуль в очень хорошей форме. И все же «правило бойскаута[71]» гласит: все нужно оставлять чище, чем было до вашего прихода. Итак, как же улучшить исходный код в листинге 15.2?

Первое, что мне решительно не понравилось, — префикс f у имен переменных классов [N6]. В современных средах разработки подобное кодирование области видимости излишне. Давайте уберем все префиксы:

private int contextLength;

private String expected;

private String actual;

private int prefix;

private int suffix;

Также бросается в глаза неинкапсулированная условная команда в начале функции compact [G28].

public String compact(String message) {

  if (expected == null || actual == null || areStringsEqual())

    return Assert.format(message, expected, actual);

  findCommonPrefix();

  findCommonSuffix();

  String expected = compactString(this.expected);

  String actual = compactString(this.actual);

  return Assert.format(message, expected, actual);

}

Инкапсуляция поможет лучше выразить намерения разработчика. Поэтому я создал метод с именем, поясняющим его смысл:

public String compact(String message) {

  if (shouldNotCompact())

    return Assert.format(message, expected, actual);

  findCommonPrefix();

  findCommonSuffix();

  String expected = compactString(this.expected);

  String actual = compactString(this.actual);

  return Assert.format(message, expected, actual);

}

private boolean shouldNotCompact() {