[10장] 클래스
10장에서는 깨끗한 클래스에 대해서 다룬다.
클래스 체계
클래스를 정의하는 표준 자바 관례
- 순차적으로 내려가는 추상화 단계
- 변수 목록
- ublic static 정적 공개 상수
- private static 정적 비공개 상수
- private 비공개 인스턴스 변수 (공개 변수가 필요한 경우는 거의 없다.)
- 함수 목록
- 생성자
- 호출하는 함수 (public)
- 호출되는 함수 (private)
- 변수 목록
추상화 단계가 순차적으로 내려가고 프로그램은 신문기사처럼 읽힌다.
캡슐화
- 변수와 유틸리티 함수는 가능한 공개하지 않는 편이 낫지만 반드시 숨겨야 하는 법칙도 없다.
- 변수나 유틸리티 함수를 protected로 선언하거나 패키지 전체로 공개해 테스트 코드에 접근을 허용하게 할 수 있다.
- 캡슐화를 풀어주는 결정은 언제나 최호의 수단이다.
클래스는 작아야 한다!
클래스를 만들 때 가장 중요한 규칙은 작게 만드는 것이다. 그렇다면 얼마나 작아야 하는가? 클래스가 맡은 책임 을 센다. (함수에서는 물리적인 행 수로 크기를 측정했었다. - 20줄 이내 (3 ~ 5 줄이 최고))
public class SuperDashboard extends JFrame implements MetaDataUser {
public Component getLastFocusedComponent()
public void setLastFocused(Component lastFocused)
public int getMajorVersionNumber()
public int getMinorVersionNumber()
public int getBuildNumber()
}
위 클래스는 충분히 작을까? 아니다. 메서드 수가 작음에도 불구하고 책임이 너무 많다. 클래스가 맡은 책임을 최소하하라! 클래스 이름은 해당 클래스 책임을 기술해야 한다. 만약 간결한 이름이 떠오르지 않는다면 클래스 책임이 너무 많다는 것이다. 함수에서 처럼 불용어(Processor, Manager, Super) 등과 같은 모호한 단어는 클래스가 너무 많은 책임을 떠안았다는 증거다. 클래스 설명은 if, and, or, but을 사용하지 않고서 25단어 내외로 가능해야 한다. 메서드 수가 작다고 작은 함수가 아니다.
단일 책임 원칙 (SRP: Single Responsibility Principle)
단일 책임 원칙 (SRP) : 클래스나 모듈을 변경할 이유는 단 한가지여야 한다는 원칙이다. 책임 : 변경할 이유
만능 클래스를 단일 책임 클래스 여러개로 나누는 것이 바람직하다. 소프트웨어를 돌아가게 만드는 활동과 소프트웨어를 깨끗하게 만드는 활동은 완전히 다르다. 우리는 처음에 시스템을 만들 때 소프트웨어를 돌아가게 만드는 활동에 집중을 한다. 바람직한 행동이다. 하지만, 여기서 대부분이 돌아가게만 만들고 깨끗하고 체계적인 소프트웨어를 만드는 다음 관심사로 넘어가지 않고 끝내버린다.
핵심
- 큰 클래스가 아니라 작은 클래스 여럿으로 이루어진 시스템이 더 바람직하다.
- 작은 클래스는 책임이 하나여야 하며(변경할 이유가 하나), 다른 작은 클래스와 협력해 시스템에 필요한 동작을 수행한다.
응집도(Cohesion)
- 클래스는 인스턴스 변수 수가 작아야 한다.
- 각 클래스 메서드는 인스턴스 변수를 하나 이상 사용해야 한다. 일반적으로 메서드가 인스턴스 변수를 많이 사용할수록 메서드와 클래스의 응집도는 더욱 높아진다.
응집도가 높다는 말은 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미이다. 즉, '함수를 작게, 매개변수 목록을 짧게' 전략을 사용해야한다.
함수를 작게, 매개변수 목록을 짧게 라는 전략을 따르다 보면 몇몇 메서드에서만 사용하는 인스턴스 변수들이 있다. 이것들을 따로 새로운 클래스로 만들어주는 것이 바람직하다. 응집도가 높아지도록 변수와 메소드를 적절히 분리해 새로운 클래스로 쪼개야 한다.
응집도를 유지하면 작은 클래스 여럿이 나온다.
큰 함수를 작은 함수 여럿으로 나누기만 해도 클래스 수가 많아진다.
예를 들어 변수가 많은 큰 함수 하나가 있다. 큰 함수를 작은 함수로 쪼개려 하는데, 작은 함수는 변수 4개가 필요하다. 이때 매겨변수로 변수 4개를 넘기는 것이 아닌, 4개의 변수를 인스턴스 변수로 승격시켜준다. 그러면 작은 함수는 매개변수가 필요없게 되고 그만큼 쪼개기 쉬워진다.
하지만, 이렇게 하면 클래스는 인스턴스 변수 목록이 많아져서 응집도를 잃게 된다. 그러나, 몇몇 함수가 몇몇 변수만 사용하므로 다른 클래스로 쪼개도 된다!
클래스가 응집력을 잃는다면 쪼개라!
변경하기 쉬운 클래스
대부분의 시스템들은 지속적인 변경이 가해진다. 변경할 때마다 시스템이 의도대로 동작하지 않을 위험이 따른다. 깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반되는 위험을 줄인다.
아래 코드를 보자. 아래 코드는 변경이 필요해 ‘손대야’하는 클래스이다.
BAD
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)
public String select(Criteria criteria)
public String preparedInsert()
private String columnList(Column[] columns)
private String valuesList(Object[] fields, final Column[] columns)
private String selectWithCriteria(String criteria)
private String placeholderList(Column[] columns)
}
아직 미완성이어서 update 문과 같은 일부 Sql 기능을 지원하지 않는다. 새로운 SQl 문을 지원하려면 반드시 Sql 클래스에 손대야 한다. 변경할 이유(책임)이 2가지 이므로 SRP를 위반한다.
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 SelectWithMatchSql extends Sql {
public SelectWithMatchSql(String table, Column[] columns, Column column, 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 placeholderList(Column[] columns)
}
public class Where {
public Where(String criteria)
public String generate()
}
public class ColumnList {
public ColumnList(Column[] columns)
public String generate()
}
public 메서드(공개 인터페이스)를 각각 Sql 클래스에서 파생하는 클래스로 만들었다. private 메서드는 각각에 해당하는 파생 클래스로 옮겼다. 모든 파생 클래스가 공통으로 사용하는 private 메서드는 Where, ColumnList라는 두 유틸리티 클래스에 넣었다.
재구성의 장점
- 클래스가 다 분리 되었기 때문에 단순해졌고 코드 이해도도 높아졌으며, 함수 하나를 수정했을 때 다른 함수에 전혀 영향을 미치지 않는다.
- 테스트 관점에서도 모든 논리를 구석구석 테스트 하기도 쉬워졌다.
- 새로운 기능을 추가할 때 새로운 클래스를 추가하면 된다.
- 결과적으로 SRP와 OCP를 지원하게 되었다.
변경으로부터 격리
요구사항은 변하기 마련이다. 따라서, 코드도 변하기 마련이다.
객체 지향 프로그래밍 입문에서 우리는 구체적인 클래스(concrete class)와 추상 클래스(abstract class)가 있다고 배웠다. 구체적인 클래스는 상세한 구현(코드)를 포함하며, 추상 클래스는 개념만 포함한다고 배웠다.
상세한 구현에 의존하는 클라이언트 클래스는 구현이 바뀌면 위험해진다. 그래서 우리는 인터페이스와 추상 클래스를 사용해 구현에 미치는 영향을 최소화한다.
예를 들어외부 API를 사용할 때 상세한 구현에 의존하는 코드는 테스트하기 어렵다!
Portfolio 클래스는 외부 API인 TokyoStockExchange를 사용해 portfolio 값을 계산한다. 따라서 Test Code는 시세 변화에 영향을 받게 되고, 이러한 5분 마다 바뀌는 API로 Test code를 짜기란 쉽지 않다.
-> 외부 API를 사용하는 클래스는 외부 API를 인터페이스로 한번 감싸자!
- 외부 API인 TokyoStockExchange 대신 StockExchange interface 구현
public interface StockExchange {
Money currentPrice(String symbol);
}
-
StockExchange interface를 구현하는 TokyoStockExchange 클래스를 구현한다.
-
portfolio 생성자를 수정해 interface StockExchange 참조자를 인수로 받는다.
public class Portfolio {
private StockExchange stockExchange;
public Portfolio(StockExchange stockExchange) {
this.stockExchange = stockExchange;
}
}
TokyoStockExchange 클래스를 흉내내는 테스트용 클래스를 만들 수 있다. 테스트용 클래스는 StockExchage 인터페이스를 구현하며 고정된 주가를 반환한다. 테스트에서 주식 5개를 구입하면 테스트용 클래스는 주가로 언제나 100불을 반환한다.
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는 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙이다.
Reference
- 클린코드 , 로버트C. 마틴
Leave a comment