[개발서적] Clean Code 10. 클래스

지금까지 우리는 코드 행과 코드 블록을 올바로 작성하는 방법에 초점을 맞췄다.

이 장에서는 깨끗한 클래스를 다룬다.

 

[클래스 체계]

클래스를 정의하는 표준 자바 관례에 따르면, 가장 먼저 변수 목록이 나온다.

변수 목록의 순서는

• 정적(static) 공개(public) 상수
• 정적(static) 비공개(private) 변수
• 비공개 인스턴스 변수

변수 목록 다음에는 함수 목록이 나오는데

• 공개 함수가 먼저 나오고
• 비공개 함수가 나온다.

즉, 추상화 단계가 순차적으로 내려간다. 그래서 프로그램은 신문 기사처럼 읽힌다.

 

캡슐화

변수와 유틸리티 함수는 가능한 공개하지 않는 편이 낫지만, 반드시 숨겨야 한다는 법칙도 없다.

테스트를 위해서 protected로 선언하기도 하지만, 캡슐화를 풀어주는건 언제나 최후의 수단이다.

 

[클래스는 작아야 한다!]

클래스를 만들 때 첫번째 규칙은 크기다. 클래스는 작아야 한다.

두번째 규칙도 크기다. 더 작아야 한다.

그럼 클래스는 얼마나 작아야 할까? 클래스가 맡은 책임에 따라 달라진다.

 

클래스 이름은 해당 클래스 책임을 기술해야 한다. 실제로 작명은 클래스 크기를 줄이는 첫 번째 관문이다.

또한 클래스 설명은 if,and,or,but 등을 사용하지 않고서 25단어 내외로 가능해야 한다.

 

단일 책임 원칙

단일 책임 원칙(SRP)은 클래스나 모듈을 변경할 이유가 하나, 단 하나뿐이어야 한다는 원칙이다.

즉, 클래스는 책임, 즉 변경할 이유가 하나여야 한다.

 

목록 10-2를 살펴보자.

 

목록 10-2

public class SuperDashboard extends JFrame implements MetaDataUser {
  public Component getLastFocusedComponent();
  public void setLastFocused(Component lastFocused);
  public int getMajorVersionNumber();
  public int getMinorVersionNumber();
  public int getBuildNumber();
}

 

겉보기엔 작아 보이는 목록 10-2 SuperDashboard는 변경할 이유가 두 가지다.

1. SuperDashboard는 소프트웨어 버전 정보를 추적한다.
   1. 버전 정보는 소프트웨어를 출시할 때마다 달라진다.
2. SuperDashboard는 자바 스윙 컴포넌트를 관리한다.
   1. 스윙 코드를 변경할 때마다 버전 번호가 달라진다.

만약 버전 정보를 다루는 메서드 세 개를 따라 빼내 Version이라는 독자적인 클래스를 만든다면 각각 하나의 책임을 지게 할 수 있다.

 

목록 10-3 단일 책임 클래스

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

---

public class SuperDashboard extends JFrame implements MetaDataUser {
  public Component getLastFocusedComponent();
  public void setLastFocused(Component lastFocused);
}

 

SRP는 객체 지향 설계에서 더욱 중요한 개념이다.

하지만 이상하게도 SRP는 클래스 설계자가 가장 무시하는 규칙 중 하나다.

규모가 어느 수준에 이르는 시스템은 논리가 많고도 복잡하다.

 

이런 복잡성을 다루려면 체계적인 정리가 필수다. 그래야 개발자가 무엇이 어디에 있는지 쉽게 찾는다.

강조하는 차원에서 다시 말하면 큰 클래스 몇 개가 아니라 작은 클래스 여럿으로 이뤄진 시스템이 더 바람직하다.

 

응집도

클래스는 인스턴스 변수 수가 작아야 한다.

일반적으로 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 더 높다.

모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높다.

 

일반적으로 응집도가 높은 클래스는 가능하거나 바람직하지 않지만, 우리는 그것을 더 선호한다.

응집도가 높다는 말은 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미다.

 

목록 10-4는 Stack을 구현한 코드다. 아래 클래스는 응집도가 아주 높다.

size()를 제외한 다른 두 메서드는 두 변수 모두 사용한다.

 

목록 10-4 Stack.java 응집도가 높은 클래스

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;
  }
}

 

‘함수를 작게, 매개변수 목록을 짧게’라는 전략을 따르다 보면 때때로 몇몇 메서드만이 사용하는 인스턴스 변수가 아주 많아진다. 이게 바로 새로운 클래스로 쪼개야 한다는 신호다.

 

응집도가 높아지도록 변수와 메서드를 적절히 분리해 새로운 클래스로 쪼개자.

응집도를 유지하면 작은 클래스 여럿이 나온다.

 

큰 함수를 작은 함수 여럿으로 나누기만 해도 클래스 수가 많아진다.

만약 변수가 네 개인 큰 함수를 쪼갠다면 변수 네 개를 새 함수에 인수로 넘겨야 할까?

전혀 아니다! 만약 네 변수를 클래스 인스턴스 변수로 승격한다면 새 함수는 인수가 필요없다.

그만큼 함수를 쪼개기 쉬워진다.

 

불행히도 이렇게 하면 클래스가 응집력을 잃는다(응집력은 높을수록 좋다).

몇몇 함수만 사용하는 인스턴스 변수가 점점 늘어나기 때문이다. 그럼 클래스를 분리하면 되지 않는가?

당연하다. 클래스가 응집력을 잃는다면 쪼개라!

 

그래서 큰 함수를 작은 함수 여럿으로 쪼개다 보면 종종 작은 클래스 여럿으로 쪼갤 기회가 생긴다.

그러면서 프로그램에 점점 더 체계가 잡히고 구조가 투명해진다.

 

[변경하기 쉬운 클래스]

대다수 시스템은 지속적인 변경이 가해진다.

깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춘다.

목록 10-9는 주어진 메타 자료로 적절한 SQL 문자열을 만드는 Sql 클래스다.

 

목록 10-9 변경이 필요해 ‘손대야’하는 클래스

public class Sql {
  public Sql(String table, Column[] columns){};
  public String create();
  public String insert(Object[] fields);
  public String selectAll();
  ...
}

 

위 클래스는 변경할 이유가 다음과 같이 두 가지다.

• 새로운 SQL 문을 지원하려면 반드시 Sql 클래스에 손대야 한다.
• 기존 SQL문 하나를 수정할 때도 반드시 Sql 클래스에 손대야 한다.

따라서 위 클래스는 SRP를 위반한다.

 

만약 목록 10-10처럼 수정하면 어떨까?

목록 10-9에 있던 공개 인터페이스를 각각 Sql 클래스에서 파생하는 클래스로 만들었다.

 

목록 10-10 닫힌 클래스 집합

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();
}

...

 

각 클래스는 극도로 단순하다. 코드는 순식간에 이해된다.

함수 하나를 수정했을 때 다른 함수가 망가질 위험도 사실상 사라졌다.

 

이 모든게 클래스가 서로 분리 되었기에 가능해졌다.

목록 10-10처럼 재구성한 Sql 클래스는 세상의 모든 장점만 취한다!

 

우선 SRP를 지원하고, OCP 또한 지원한다. 즉, 확장에 개방적이고 수정에 폐쇄적이다.

새 기능을 수정하거나 기존 기능을 변경할 때 건드릴 코드가 최소인 시스템이 바람직하다.

이상적인 시스템이라면 새 기능을 추가할 때 시스템을 확장할 뿐 기존 코드를 변경하지 않는다.

 

변경으로부터 격리

요구사항은 변하기 마련이다. 따라서 코드가 변하기 마련이다.

그래서 우리는 인터페이스와 추상 클래스를 사용해 구현이 미치는 영향을 격리한다.

 

상세한 구현에 의존하는 코드는 테스트가 어렵다. 예를 들어, Portfolio 클래스가 있다.

그런데 Portfolio 클래스는 외부 TokyoStockExchange API를 이용해 포트폴리아 값을 계산한다.

따라서 우리 테스트 코드는 시세 변화에 영향을 받는다.

 

Portfolio 클래스는 외부 TokyoStockExchange API를 직접 호출하는 대신, StockExchange라는 인터페이스를 생성한 후 메서드 하나를 선언한다.

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

 

다음으로 StockExchange 인터페이스를 구현하는 TokyoStockExchange 클래스를 구현한다.

public Portfolio {
  private StockExchange exchange;
  public Portfolio(StockExchange exchange) {
    this.exchange = exchange;
  }
  ...
}

 

이제 TokyoStockExchange 클래스를 흉내내는 테스트용 클래스를 만들 수 있다.

테스트용 클래스는 StockExchange 인터페이스를 구현하며 고정된 주가를 반환한다.

 

다음은 작성된 테스트 코드다.

테스트용 클래스는 단순히 미리 정해놓은 표 값만 참조한다.

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를 만족하게 된다.

본질적으로 DIP는 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙이다.

 

우리가 개선한 Portfolio 클래스는 TokyoStockExchange라는 구현 클래스에 의존하는 것이 아니라 StockExchange 인터페이스에 의존한다.