[클린 코드] 10장. 클래스

클래스 체계

• 가장 먼저 변수 목록이 나온다.
  정적 공개 상수가 있다면 맨 처음에 나온다.
  다음으로 정적 비공개 변수가 나오며, 이어서 비공개 인스턴스가 나온다.
  공개 변수가 필요한 경우는 거의 없다.
• 변수 목록 다음에는 공개 함수가 나온다.
  비공개 함수는 자신을 호출하는 공개 함수 직후에 넣는다.
  즉, 추상화 단계가 순차적으로 내려간다.
• 변수와 유틸리티 함수는 가능한 공개하지 않는 편이 낫지만 반드시 숨겨야 한다는 법칙도 없다.
• 테스트는 아주 중요하므로 같은 패키지 안에서 테스트 코드가 함수를 호출하거나 변수를 사용해야 한다면
  protected로 선언하거나 패키지 정체로 공개해야 한다. 하지만 그 전에 비공개 상태를 유지할 온갖 방법을 강구한다.

클래스는 작아야 한다!

• 클래스를 설계할 때도, 함수와 마찬가지로, '작게'가 기본 규칙이다.
• 함수는 물리적인 행 수로 크기를 측정했지만, 클래스는 클래스가 맡은 책임을 센다.
• 클래스 이름은 해당 클래스 책임을 기술해야 한다.
  간결한 이름이 떠오르지 않는다면 필경 클래스 크기가 너무 커서 그렇다.
  클래스 이름이 모호하다면 필경 클래스 책임이 너무 많아서다.
• 클래스 설명은 만일(if), 그리고(and), -(하)며(or), 하지만(but)을 사용하지 않고서 25단어 내외로 가능해야 한다.

// bad
// SuperDashboard는 마지막으로 포커스를 얻었던 컴포넌트에 접근하는 방법을 제공하며,
// 버전과 빌드 번호를 추적하는 메커니즘을 제공한다.
public class SuperDashboard extends JFrame implements MetaDataUser {
  public Component getLastFocusedComponent()
  public void setLastFocused(Component lastFocused)
  public int getMajorVersionNumber()
  public int getMinorVersionNumber()
  public int getBuildNumber()
}

• 단일 책임 원칙(SRP)은 클래스나 모듈을 변경할 이유가 단 하나뿐이어야 한다는 원칙이다.
• 버전 정보와 관련된 코드는 소프트웨어를 출시할 때마다 달라진다.
• 책임, 즉 변경할 이유를 파악하려 애쓰다 보면 코드를 추상화하기도 쉬워진다. 더 좋은 추상화가 더 쉽게 떠오른다.
• 작은 클래스는 각자 맡은 책임이 하나며, 변경할 이유가 하나며, 다른 작은 클래스와 협력해 시스템에 필요한 동작을 수행한다.

// good
// 버전 정보를 다루는 메서드 세 개를 따로 빼내 Version이라는 독자적인 클래스를 만듦
public class SuperDashboard extends JFrame implements MetaDataUser {
  public Component getLastFocusedComponent()
  public void setLastFocused(Component lastFocused)
}

public class Version {
  public int getMajorVersionNumber()
  public int getMinorVersionNumber()
  public int getBuildNumber()
}

• 클래스는 인스턴스 변수 수가 작아야 한다.
• 일반적으로 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 더 높다.
• 몇몇 메서드만이 사용하는 인스턴스가 변수가 많아질 경우
  응집도가 높아지도록 변수와 메서드를 적절히 분리해 새로운 클래스 두세 개로 쪼개준다.

// good
public class Stack {
  private int topOfStack = 0;
  List<Integer> elements = new LinkedList<Integer>();
  
  public int size() {
    return topOfStack();
  }
  
  public void push(int element) {
    topOfStack++;
    elements.add(element);
  }
  
  public int pop() throws PoppedWhenEmpty {
    if (topOfStack == 0) throw new PoppedWhenEmpty();
    int element = elements.get(--topOfStack);
    elements.remove(topOfStack);
    return element;
  }
}

• 함수가 하나뿐인 프로그램을
  작은 함수와 클래스로 나눈 후 함수와 클래스와 변수에 좀 더 의미 있는 이름을 부여할 경우, 프로그램 길이가 늘어난다.
• 길이가 늘어난 이유는 여러 가지다.
  첫째, 리팩터링한 프로그램은 더 길고 서술적인 변수 이름을 사용한다.
  둘째, 리팩터링한 프로그램은 코드에 주석을 추가하는 수단을 함수 선언와 클래스 선언을 활용한다.
  셋째, 가독성을 높이고자 공백을 추가하고 형식을 맞추었다.

변경하기 쉬운 클래스

• 대다수 시스템은 지속적인 변경이 가해진다.
• 깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춘다.
• 미완성인 코드는 언젠가 특정 문을 지원할 시점이 오면 클래스에 '손대어' 고쳐야 한다.
  또한 기존의 코드 하나를 수정할 때도 클래스에 손대야 한다.
  이렇게 변경할 이유가 두 가지이므로 SRP를 위반하게 된다.
• 시스템에 변할 때, 클래스 일부에서만 사용되는 비공개 메서드는 코드를 개선할 여지가 있다.
• 그러므로 공개 인터페이스를 각각 파생하는 클래스를 만들고, 특정 비공개 메서드는 해당하는 파생 클래스로 옮기며
  모든 파생 클래스가 공통으로 사용하는 비공개 메서드는 유틸리티 클래스에 넣도록 한다.
  이로인해 함수 하나를 수정했다고 다른 함수가 망가질 위험도 사라지며, 테스트 관점에서 모든 논리를 증명하기도 쉬워졌다.
• 이는 SRP만이 아니라, 클래스는 확장에 개방적이고 수정에 폐쇄적이어야 한다는 개방-폐쇄 원칙(OCP)도 지원한다.
• 이상적인 시스템이라면 새 기능을 추가할 때 시스템을 확장할 뿐 기존 코드를 변경하지는 않는다.

// bad
// 메타 자료로 적절한 SQL 문자열을 만드는 Sql 클래스
public class Sql {
  public Sql(String table, Column[] columns)
  public String create()
  public String insert(Object[] fields)
  public String selectAll()
  public String findByKey(String keyColumn, String keyValue)
  public String select(Column column, String pattern)
  pulbic String select(Criteria criteria)
  public String preparedInsert()
  private String columnList(Colunm[] columns)
  private String valuesList(Object[] fields, final Column[] columns)
  private String selectWithCriteria(String criteria)
  private String placeholderList(Column[] columns)
}

// good
abstract public class Sql {
  public Sql(String table, Column[] columns)
  abstract public String generate();
}

public class CreateSql extends Sql {
  public CreateSql(String table, Column[] columns)
  @Override public String generate()
}

public class SelectSql extends Sql {
  public SelectSql(String table, Column[] columns)
  @Override public String generate()
}

public class InsertSql extends Sql {
  public InsertSql(String table, Column[] columns, Object[] fields)
  @Override public String generate()
  // 비공개 메서드는 해당하는 파생 클래스로 옮김
  private String valuesList(Object[] fields, final Column[] columns)
}

public class SelectWithCriteriaSql extends Sql {
  public SelectWithCriteriaSql(String table, Column[] columns, Criteria criteria)
  @Override public String generate()
}

public class SelectWithMathSql extends Sql {
  public SelectWithMathSql(String table, Column[] columns, String pattern)
  @Override public String generate()
}

public class FindByKeySql extends Sql {
  public FindByKeySql(String table, Column[] columns, String keyColumn, String keyValue)
  @Override public String generate()
}

public class PreparedInsertSql extends Sql {
  public PreparedInsertSql(String table, Column[] columns)
  @Override public String generate()
  // 비공개 메서드는 해당하는 파생 클래스로 옮김
  private String placehoderList(Column[] columns)
}

// update문을 추가할 때 기존 클래스를 변경할 필요가 없음
/**
public class UpdateSql extends Sql {
  public UpdateSql(String table, Column[] columns ...)
  @Override public String generate()
}
**/

// 모든 파생 클래스가 공통으로 사용하는 비공개 메서드는 유틸리티 클래스로
public class Where {
  public Where(String criteria)
  public String generate()
}

public class ColumnList {
  public ColumnList(Column[] columns)
  public String generate()
}

• 요구사항은 변하기 마련이다. 따라서 코드도 변하기 마련이다.
• 객체 지향 프로그래밍에는 구체적인 클래스는 상세한 구현을 포함하며 추상 클래스는 개념만 포함한다.
• 그래서 우리는 인터페이스와 추상 클래스를 사용해 상세한 구현에 의존하는 클라이언트 클래스에 미치는 영향을 격리한다.

// good
public interface StockExchange {
  Money currentPrice(String symbol);
}

// 상세한 구현 클래스가 아니라 인터페이스에 의존
public Portfolio {
  private StockExchange exchange;
  public Portfolio(StockExchange exchange) {
    this.exchange = exchange;
  } 
  // ...
}

• 인터페이스를 생성한 후, 인터페이스를 구현하는 클래스를 구현할 경우 테스트용 클래스를 만들 수 있다.

// test
public class PortfolioTest {
  private FixedStockExchangeStub exchange;
  private Portfolio portfolio;
  
  @Before
  protected void setUp() throws Exception {
    exchange = new FixedStockExchangeStub();
    exchange.fix("MSFT", 100);
    portfolio = new Portfolio(exchange);
  }
  
  @Test
  public void GivenFiveMSFTTotalShouldBe500() throws Exception {
    portfolio.add(5, "MSFT");
    Assert.assertEquals(500, portfolio.value());
  }
}

• 테스트가 가능할 정도로 시스템의 결합도를 낮추면 유연성과 재상용성도 더욱 높아진다.
• 시스템 요소가 서로 잘 격리되어 있으면 각 요소를 이해하기도 더 쉬워진다.
• 결합도를 최소로 줄이면
  자연스럽게 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 의존성 역전 원칙(DIP)을 따르는 클래스가 나온다.