코드의 표현력과 그 코드로 이루어진 함수에 아무리 신경 쓸지라도 좀 더 차원 높은 단계까지 신경쓰지 않으면 깨끗한 코드를 얻기는 어렵다.
클래스 체계
표준 자바 관례에 의하면 아래 순서로 선언하게 된다.
public static 상수private static 변수- 비공개 인스턴스 변수
- 공개 함수
- 비공개 함수
즉 추상화 단계가 순차적으로 내려간다. 그래서 프로그램은 신문 기사처럼 읽힌다.
캡슐화
변수와 유틸리티 함수는 가능한 공개하지 않는 편이 낫지만 반드시 숨겨야한다는 법칙도 없다. 때로는 변수나 유틸리티 함수를 protected로 선언해 테스트 코드에 접근을 허용하기도 한다.
같은 패키지 안에서 테스트 코드가 함수를 호출하거나 변수를 사용해야 한다면 그 함수나 변수를 protected로 선언하거나 패키지 전체로 공개한다.
하지만 그 전에 비공개 상태를 유지할 방법을 강구해야 한다.
💡 캡슐화를 풀어주는 결정은 언제나 최후의 수단이다.
클래스는 작아야 한다.
클래스를 만들 때 첫 번째 규칙은 크기다. 클래스는 작아야 한다. 클래스를 설계할 때도, 함수와 마찬가지로, 작게가 기본 규칙이다.
얼마나 작아야 할까?
함수는 물리적인 행 수로 크기를 측정했지만 클래스는 맡은 책임 수로 측정한다.
1
2
3
4
5
6
7
| public class SuperDashboard extends JFrame implements MetaDataUser {
public Component getLastFocusedCompnent();
public void setLastFocused(Component lastFocused);
public int getMajorVersionNumber();
public int getMinorVersionNumber();
public int getBuildNumber();
}
|
메서드 개수를 5개 정도로 줄인 클래스이다. 하지만 메서드 수가 적음에도 불구하고 책임이 너무 많다.
클래스 이름
클래스 이름은 해당 클래스 책임을 기술해야 한다. 실제로 클래스 작명은 크기를 줄이는 첫 번째 관문이다.
- 간결한 이름이 떠오르지 않는다면 대부분 클래스 크기가 너무 커서(책임이 많아서) 그렇다.
예를 들어 클래스 이름에 Processor, Manager, Super 등과 같이 모호한 단어가 있다면 클래스가 여러 책임을 떠안고있다는 뜻이다.
클래스 설명
클래스 설명은 만일(if), 그리고(and), (하)며(or), 하지만(but)을 사용하지 않고서 25단어 내외로 가능해야 한다.
위 SuperDashboard 의 설명을 만들면
“마지막으로 포커스를 얻었던 컴포넌트에 접근하는 방법을 제공하며, 버전과 빌드 번호를 추적하는 메커니즘을 제공한다.”
인데 “~하며”가 포함되므로 책임이 많다고 생각할 수 있다.
단일 책임 원칙 - SRP: Single Responsibility Principle
단일 책임 원칙은 클래스나 모듈을 변경할 이유가 단 하나뿐이어야 한다는 원칙이다.
SRP는 ‘책임’이라는 개념을 정의하며 적절한 클래스 크기를 제시한다. 클래스는 책임, 즉 변경할 이유가 하나여야 한다는 의미다.
겉보기에 작아보이는 위 SuperDashboard는 변경할 이유가 2가지다.
- 소프트웨어 버전 정보를 추적한다.
- 버전 정보는 소프트웨어를 출시할 때마다 달라진다.
- 자바 스윙 컴포넌트를 관리한다.
- SuperDashboard는 최상위 GUI 윈도의 스윙 표현인 JFrame에서 파생한 클래스다.
즉, 스윙 코드를 변경할 때마다 버전 번호가 달라진다.
책임(변경할 이유)을 파악하려 애쓰다 보면 코드를 추상화 하기도 쉬워진다.
1
2
3
4
5
| public class Version {
public int getMajorVersionNumber();
public int getMinorVersionNumber();
public int getBuildNumber();
}
|
버전 정보를 다루는 메서드 세 개를 따로 빼내 version이라는 독자적인 클래스를 만든다.
SRP는 객체 지향 설계에서 더욱 중요한 개념이다. 또한 이해하고 지키기 수월한 개념이기도 하다. 하지만 이상하게도 SRP는 클래스 설계자가 가장 무시하는 규칙 중 하나다.
소프트웨어를 돌아가게 만드는 활동과 소프트웨어를 깨끗하게 만드는 활동은 완전히 별개다.
개발자는 자잘한 책임 클래스가 많아지면 큰 그림을 이해하기 어려워진다고 우려한다. 큰 그림을 이해하려면 이 클래스 저 클래스를 수없이 넘나들어야 한다고 걱정한다.
하지만 작은 클래스가 많은 시스템이든 큰 클래스가 몇 개뿐인 시스템이든 익힐 내용은 그 양이 비슷하다.
클래스를 작게 유지하는 행위는 코드를 체계적으로 정리하는 과정으로, 단일 책임을 가진 클래스를 만들고 이름을 잘 붙인다면 자연스럽게 코드가 정리된다.
- 책임이 많은 클래스는 큰 공구함에 여러 공구를 마구 때려넣는 행동과 비슷하다.
응집도
클래스는 인스턴스 변수 수가 적어야 한다. 각 클래스 메서드는 클래스 인스턴스 변수를 하나 이상 사용해야 한다.
일반적으로 메서드가 변수를 더 많이 사용할수록 메서드와 클래스는 응집도가 더 높다. 모든 인스턴스 변수를 메서드마다 사용하는 클래스는 응집도가 가장 높다.
- 일반적으로 이처럼 응집도가 가장 높은 클래스는 가능하지도 바람직하지도 않다.
그렇지만 대부분 응집도가 높은 클래스를 선호한다. 응집도가 높다는 말은 클래스에 속한 메서드와 변수가 서로 의존하며 논리적인 단위로 묶인다는 의미다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
| 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;
}
}
|
위 클래스는 응집도가 아주 높다. size()를 제외한 다른 두 메서드는 두 변수를 모두 사용한다.
함수를 작게, 매개변수 목록을 짧게라는 전략을 따르다 보면 때때로 몇몇 메서드만이 사용하는 인스턴스 변수가 아주 많아진다.
응집도가 높아지도록 변수와 메서드를 적절히 분리해 새로운 클래스 두세 개로 쪼개준다.
응집도를 유지하면 작은 클래스 여럿이 나온다.
큰 함수를 작은 함수 여럿으로 나누기만 해도 클래스 수가 많아진다.
예를 들어 변수가 아주 많은 큰 함수 하나가 있다. 큰 함수 일부를 작은 함수 하나로 빼내고 싶은데, 빼내려는 코드가 큰 함수에 정의된 변수 넷을 사용한다. 그렇다면 변수 네 개를 새 함수에 인수로 넘겨야 옳은가?
전혀 아니다. 만약 네 변수를 클래스 인스턴스 변수로 승격한다면 새 함수는 인수가 필요없다. 그만큼 함수를 쪼개기 쉬워진다.
이렇게 하면 클래스가 응집력을 잃는다. 몇몇 함수만 사용하는 인스턴스 변수가 점점 더 늘어나기 때문이다.
몇몇 함수가 몇몇 변수만 사용한다면 독자적인 클래스로 분리하면 된다. 응집력을 잃는다면 쪼개라
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
| package literatePrimes;
public class PrintPrimes {
public static void main(String[] args) {
final int M = 1000;
final int RR = 50;
final int CC = 4;
final int WW = 10;
final int ORDMAX = 30;
int P[] = new int[M+1];
int PAGENUMBER;
int PAGEOFFSET;
int ROWOFFSET;
int C;
int J;
int K;
boolean JPRIME;
int ORD;
int SQUARE;
int N;
int MULT[] = new int[ORDMAX+1];
J = 1;
K = 1;
P[1] = 2;
ORD = 2;
SQUARE = 9;
while (K < M) {
do {
J = J+2;
if (J == SQUARE) {
ORD = ORD + 1;
SQUARE = P[ORD] * P[ORD];
MULT[ORD-1] = J;
}
N = 2;
JPRIME = true;
while (N < ORD && JPRIME) {
while (MULT[N] < J) {
MULT[N] = MULT[N] + P[N] + P[N];
}
if (MULT[N] == J) {
JPRIME = false;
}
N = N + 1;
}
} while (!JPRIME);
K = K + 1;
P[K] = J;
}
{
PAGENUMBER = 1;
PAGEOFFSET = 1;
while (PAGEOFFSET <= M) {
System.out.println("The First " + M + " Prime Numbers --- Page " + PAGENUMBER);
System.out.println("");
for (ROWOFFSET = PAGEOFFSET; ROWOFFSET < PAGEOFFSET + RR; ROWOFFSET++) {
for (C = 0; C < CC; C++) {
if (ROWOFFSET + C * RR <= M) {
System.out.println("%10d", P[ROWOFFSET + C * RR]);
}
}
System.out.println("");
}
System.out.println("\f");
PAGENUMBER = PAGENUMBER + 1;
PAGEOFFSET = PAGEOFFSET + RR * CC;
}
}
}
}
|
함수가 하나뿐인 위 프로그램은 엉망이다.
- 들여쓰기 심함
- 이해하기 힘든 변수 이름
- 구조가 빽빽함
→ 여러함수로 나눠야한다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
| package literatePrimes;
public class PrimePrinter {
public static void main(String[] args) {
final int NUMBER_OF_PRIMES = 1000;
int[] primes = PrimeGenerator.generate(NUMBER_OF_PRIMES);
final int ROWS_PER_PAGE = 50;
final int COLUMNS_PER_PAGE = 4;
RowColumnPagePrinter tablePrinter =
new RowColumnPagePrinter(ROWS_PER_PAGE,
COLUMNS_PER_PAGE,
"The First " + NUMBER_OF_PRIMES + " Prime Numbers");
tablePrinter.print(primes);
}
}
...
|
가장 먼저 눈에 띄는 변화가 프로그램이 길어졌다. 길이가 늘어난 이유는 여러가지다.
- 리팩터링한 프로그램은 좀 더 길고 서술적인 변수 이름을 사용한다.
- 리팩터링한 프로그램은 코드에 주석을 추가하는 수단으로 함수 선언과 클래스 선언을 활용한다.
- 가독성을 높이고자 공백을 추가하고 형식을 맞추었다.
PrimePrinter 클래스는 main 함수 하나만 포함하며 실행 환경을 책임진다. 호출 방식이 달라지면 클래스도 바뀐다. 예를들어 SOAP 서비스로 바꾸려면 PrimePrinter 클래스를 고친다.
PrimeGenerator 클래스는 소수 목록을 생성하는 방법을 안다. 코드를 살펴보면 알겠지만, 객체로 인스턴스화하는 클래스가 아니다. 단순히 변수를 선언하고 감추려고 사용하는 유용한 공간일 뿐이다.
- 소수를 계산하는 알고리즘이 바뀐다면 PrimeGenerator 클래스를 고친다.
변경하기 쉬운 클래스
대다수 시스템은 지속적인 변경이 가해진다. 그리고 뭔가 변경할 때마다 시스템이 의도대로 동작하지 않을 위험이 따른다. 깨끗한 시스템은 클래스를 체계적으로 정리해 변경에 수반하는 위험을 낮춘다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
| 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문 하나를 수정할 때도 반드시
Sql 클래스에 손대야 한다.
이렇듯 변경할 이유가 두 가지이므로 Sql 클래스는 SRP를 위반한다.
단순히 구조적인 관점에서도 Sql은 SRP를 위반한다. selectWithCriteria라는 비공개 메서드가 있는데, 이 메서드는 select문을 처리할 때만 사용한다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
| 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)
@Override public String generate();
}
public class SelectWithCriteraSql extends Sql {
public SelectWithCriteraSql(String table, Column[] columns)
@Override public String generate();
}
public class SelectWithMatchSql extends Sql {
public SelectWithMatchSql(String table, Column[] columns, Criteria criteria)
@Override public String generate();
}
public class FindByKeySql extends Sql {
public FindByKeySql(String table, Column[] columns, Column column, String pattern)
@Override public String generate();
}
public class CreateSql extends Sql {
public CreateSql(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 extends Sql {
public Where(String criteria)
@Override public String generate();
}
public class ColumnList extends Sql {
public ColumnList(Column[] columns)
@Override public String generate();
}
|
공개 인터페이스를 각각 Sql클래스에서 파생하는 클래스로 만들었다. valueList와 같은 비공개 메서드는 해당하는 파생 클래스로 옮겼다. 모든 파생 클래스가 공통으로 사용하는 비공개 메서드는 Where와 ColumnList라는 두 유틸리티 클래스에 넣었다.
- 클래스를 서로 분리하여 각 클래스는 극도로 단순하며 이해하기 쉽다. 함수 하나를 수정했다고 다른 함수가 망가질 위험도 사실상 없다. 테스트 관점에서 모든 논리를 구석구석 증명하기도 쉬워졌다.
새로운 sql을 넣을때도 기존 클래스를 변경할 필요가 전혀 없다.
- 새 기능을 수정하거나 기존 기능을 변경할 때 건드릴 코드가 최소인 시스템 구조가 바람직하다.
- 이상적인 시스템이라면 새 기능을 추가할 때 시스템을 확장할 뿐 기존 코드를 변경하지 않는다.
변경으로부터 격리
요구사항은 변하기 마련이다. 따라서 코드도 변하기 마련이다.
상세한 구현에 의존하는 코드는 테스트가 어렵다. 예를들어 Portfolio 클래스를 만든다고 가정하자.
Portfolio 클래스는 외부 TokyoStockExchange API를 이용해 포트폴리오 값을 계삲나다. 따라서 테스트 코드는 시세 변화에 영향을 받게 된다.
5분마다 값이 달라지는 API로 테스트 코드를 짜기는 어렵다.
1
2
3
| public interface StorckExchange {
Money CurrentPrice(String symbol);
}
|
Portfolio에서 TokyoStockExchange API를 직접 호출하는 대신 StockExchange라는 인터페이스를 생성한 후 메서드 하나를 선언했다.
다음으로 StockExchange 인터페이스를 구현하는 TokyoStockExchange 클래스를 구현한다.
1
2
3
4
5
6
7
| public Portfolio {
private StockExchange exchange;
public Portfolio(StockExchange exchange) {
this.exchange = exchange;
}
...
}
|
Portfolio를 수정해 StockExchange 참조자를 인수로 받는다.
이를 통해 TokyoStockExchange 클래스를 흉내내는 테스트용 클래스를 만들 수 있게 되었다.
테스트용 클래스는 StockExchange 인터페이스를 구현하며 고정된 주가를 반환한다.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
| public class PortfolioTest {
private FixedStockExchangeStub exchange;
private Portfolio portfolio;
@Before
protected void setUp() throws Exception {
exchange = new FixedStockExchangeStub();
exchange.fix("MSFT", 100);
protfolio = new Portfolio(exchange);
}
@Test
public void GivenFiveMSFTTotalShouldBe500() throws Exception {
portfolio.add(5, "MSFT");
Assert.assertEquals(500, portfolio.value());
}
}
|
위와 같은 테스트가 가능할 정도로 시스템의 결함도를 낮추면 유연성과 재사용성도 더욱 높아진다.
- 결합도가 낮다는 소리는 각 시스템 요소가 다른 요소로부터 그리고 변경으로부터 잘 격리되어 있다는 의미다.
- 시스템 요소가 서로 잘 결리되어 있으면 각 요소를 이해하기도 더 쉬워진다.
이렇게 결합도를 최소로 줄이면 자연스럽게 또 다른 클래스 설계 원칙인 DIP(Dependency Inversion Principle)를 따르는 클래스가 나온다.
본질적으로 DIP는 클래스가 상세한 구현이 아니라 추상화에 의존해야 한다는 원칙이다.
결론
- 공개가 필요할땐 최대한 캡슐화를 유지하는 방식을 강구해야 한다.
- 클래스도 작게 유지해야 한다.
- 클래스의 크기는 책임 수로 측정한다.
- 책임이 많은 클래스는 이름과 설명에 모호한 표현이 섞이게 된다.
- 응집도를 유지하면 자연스럽게 클래스가 작아진다.
- 변경은 여러 문제들을 수반한다. 따라서 기존 코드 변경이 없는것이 좋다.
- 그대로 변경은 항상 필요할 수 있으므로 변경하기 쉽게 만들어야 한다.
- 클래스를 깨끗하게 정리하면 변경하기 쉽다.
- 클래스를 작게 만들면 자연스럽게 정리된다.
- 결합도를 최대한 낮추면 변경으로 부터 격리할 수 있다.
