창발성은 하위계층(구성 요소)에 없는 특성이나 행동이 상위계층(전체 구조)에서 자발적으로 돌연히 출현하는 현상이다. 예컨데, 개미 한 마리는 집을 지을 지능이 없다. 하지만 큰 집단의 개미들은 서로 상호작용하며 하나의 집을 만들어 내는 것이 창발이다.
여기 따르기만 해도 우수한 설계가 나오는 간단한 규칙이 있다. 이 규칙들은 우수한 설계의 창발성을 촉진한다.
1. 모든 테스트를 실행한다.
2. 중복을 없앤다.
3. 프로그래머 의도를 표현한다.
4. 클래스와 메서드 수를 최소로 줄인다.
모든 테스트를 실행한다.
문서로 설계를 완벽히 했어도 시스템이 의도한 대로 돌아가는지 검증할 간단한 방법이 없다면, 문서 장성을 위해 투자한 노력에 대한 가치를 인정받기 힘들다.
테스트가 불가능한 시스템은 검증도 불가능하다. 테스트가 가능한 시스템을 만들면 설계 품질도 높아진다.
결합도가 높으면 테스트 케이스를 작성하기 어렵다. 따라서, 테스트 케이스를 많이 작성하면 개발자는 Dependency Inversion Principle와 같은 원칙을 적용하고, DI, 인터페이스, 추상화 등과 같은 도구를 사용해 결합도를 낮춘다.
이 규칙을 따르면 시스템은 낮은 결합도와 높은 응집력이라는 객체 지향 방법론이 지향하는 목표를 달성하게 된다. 따라서 설계 품질이 높아진다.
리팩토링(중복을 없앤다, 프로그래머 의도를 표현한다, 클래스와 메서드 수를 최소로 줄인다)
테스트 케이스를 작성했다면 코드를 리팩토링 해도 된다. 테스트 케이스가 있기 때문에 시스템이 깨질 염려를 하지 않아도 된다. 이 단계에서는 소프트웨어 설계의 품질을 높이는 것이라면 무엇이든 해도 좋다.
중복을 없애라
우수한 설계에서 중복은 적이다. 중복은 추가 작업, 추가 위험, 불필요한 복잡도를 뜻한다.
깔끔한 코드 작성을 위해서는 단 몇줄의 중복도 줄여야 한다.
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
public void scaleToOneDimension(float desiredDimension, float imageDimension) {
if (Math.abs(desiredDemension - imageDimension) < errorThreshold) {
return;
}
float scalingFactor = desiredDemension / imageDimension;
scalingFactor = (float)(Math.floor(scalingFactor * 100) * 0.01f);
RenderedOp newImage = ImageUtilities.getScaledImage(image, scalingFactor, scalingFactor);
// 중복
image.dispose();
System.gc();
image = newImage;
}
public synchronized void rotate(int degrees) {
RenderedOp newImage = ImageUtilities.getRotatedImage(image, degrees);
// 중복
image.dispose();
System.gc();
image = newImage;
}
|
cs |
위 코드는 다음과 같이 별도의 메서드를 만들어 중복을 제거할 수 있다.
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
|
public void scaleToOneDimension(float desiredDimension, float imageDimension) {
if (Math.abs(desiredDemension - imageDimension) < errorThreshold) {
return;
}
float scalingFactor = desiredDemension / imageDimension;
scalingFactor = (float)(Math.floor(scalingFactor * 100) * 0.01f);
replaceImage(ImageUtilities.getScaledImage(
image, scalingFactor, scalingFactor));
}
public synchronized void rotate(int degrees) {
replaceImage(ImageUtilities.getRotatedImage(image, degrees));
}
private void replaceImage(RenderedOp newImage) {
image.dispose();
System.gc();
image = newImage;
}
|
cs |
이렇게 새로운 메서드를 반들고 나니 클래스가 Single Responsibility Principle을 위반한다. 따라서 replaceImage
메서드를 다른 클래스로 옮겨도 좋다. 그러면 새 메서드의 가시성이 높아지며 이런 소규모 재사용은 시스템 복잡도를
극적으로 줄여준다.
Template Method 패턴은 고차원 중복을 제거할 목적으로 자주 사용된다. 예시는 다음과 같다.
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
|
public class VacationPolicy {
public void accrueUSDivisionVacation() {
// 지금까지 근무한 시간을 바탕으로 휴가 일수를 계산한다
// ... 중복
// 휴가 일수가 미국 최소 일수를 만족하는지 확인하는 코드
// ...
// 휴가 일수를 급여 대장에 적용하는 코드
// ... - 중복
}
public void accrueEUDivisionVacation() {
// 지금까지 근무한 시간을 바탕으로 휴가 일수를 계산한는 코드
// ... - 중복
// 휴가 일수가 유럽 연합 최소 법정 일수를 만족하는 확인하는 코드
// ...
// 휴가 일수를 급여 대장에 적용하는 코드
// ... - 중복
}
}
|
cs |
위 코드는 최소 법정 일수 로직을 제외하면 중복되 있따. 따라서 Template Method 패턴을 사용해 다음과 같이 중복을
제거할 수 있다.
|
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
|
abstract public class VacationPolicy {
public void accrueVacation() {
calculateBaseVacationHours();
alterForLegalMinimums();
applyToPayroll();
}
private void calculateBaseVacationHours() {...}
abstract protected void alterForLegalMinimums();
private void applyToPayroll() {...}
}
public class USVacationPolicy extends VacationPolicy {
@Override
protected void alterForLegalMinimums() {
// 미국 최소 법정 일수를 사용한다.
}
}
public class EUVacationPolicy extends VacationPolicy {
@Override
protected void alterForLegalMinimums() {
// 유럽연합 최소 법정 일수를 사용한다.
}
}
|
cs |
표현하라
코드를 작성하는 당사자는 자신이 작성한 코드에 대해 상세히 이해하고 있지만 나중에 그 코드를 유지보수할 개발자가
코드를 상세히 이해하고 있을 가능성은 희박하다. 하지만 유지보수 단계에서 버그를 야기하지 않을려면 점점 복잡해
지는 코드를 이해해야 하고, 코드를 이해하는대 점점 더 많은 시간이 투자된다. 따라서 코드는 개발자의 의도를 분형히
표현해야 한다. 그래야 결함이 줄고 유지보수 비용이 적게 든다.
1. 좋은 이름을 선택하라. 이름과 기능이 다르면 이해하기 어렵다.
2. 함수와 클래스 크기를 가능한 줄인다. 작은 클래스, 작은 함수는 이름 짓기 쉽고, 구현하고 쉽고, 이해하기 쉽다.
3. 표준 명칭을 사용한다. 예를 들어 디자인 패턴은 의사소통과 표현력 강화가 목적이다. 따라서 디자인 패턴을
사용한다면 해당 클래스 이름에 패턴 이름을 넣어 준다(factory, visitor 등).
4. 단위 테스트 케이스를 꼼꼼히 작성한다. 테스트 케이스는 예제로 보여주는 문서다. 따라서 잘 만든 테스트 케이스를
읽음으로서 클래스 기능을 알 수 있다.
하지만 표현력을 높이는 가장 좋은 방법은 노력이다. 코드가 잘 동작하는 것을 확인한 후 그냥 넘어가지 말고 읽는 사람을 고려해 표현력을 높여보아라.
클래스와 메서드 수를 최소로 줄여라
위 규칙들을 극단적으로 적용하면 득보다 실이 많다. 따라서 이 규칙은 함수와 클래스 수를 가능한 줄이라 제안한다.
목표는 함수와 클래스 크기를 작게 유지하면서 동시에 시스템 크기도 작세 유지하는 것이다. 하지만 이 규칙은 위의 3개
규칙 중 우선순위가 가장 낮다. 클래스와 함수 수를 줄이는 작업도 중요하지만, 테스트 케이스를 만들고 중복을 제거하고
의도를 표현하는 작업이 더 중요하다.
출처 - 클린 코드