[클린 코드] 12장 - 창발성

[클린 코드] 11장 - 시스템

1. 창발적 설계로 깔끔한 코드를 구현하자

켄트 벡은 다음 규칙을 따르면 설계는 단순하다고 한다.

• 모든 테스트를 실행한다
• 중복을 없앤다
• 프로그래머 의도를 표현한다
• 클래스와 메서드 수를 최소로 줄인다

단순한 설계 규칙 1: 모든 테스트를 실행하라

테스트가 불가능한 시스템은 검증도 불가능하다.

테스트가 가능한 시스템을 만드려고 애쓰면 설계 품질이 더불어 높아진다. SRP, 단일 책임을 준수하는 클래스는 테스트가 더욱 쉬우며 더 나은 설계가 얻어진다.

 

높은 결합도가 있으면 테스트 케이스를 작성하기 어려우므로

테스트 케이스가 많아질수록 개발자는 DIP 원칙을 적용, DI, 인터페이스, 추상화 같은 도구로 결합도를 낮춘다. 이에 따라 자연스럽게 설계 품질은 더욱 높아진다.

 

단순한 설계 규칙 2~4 : 리팩터링

테스트 케이스 모두 작성 후 코드와 클래스를 정리한다. 코드 몇줄마다 잠시 멈추고 설계를 조감한다.

우리는 리팩터링을 하며 시스템이 망가질까 걱정할 필요가 없다. 테스트 케이스 덕분이다.

 

앞서 설명한 바와 같이 중복 제거, 프로그래머의 의도 표현, 클래스와 메서드 수를 최소로 줄이며 목표를 성취한다.

2. 중복을 없애라

중복은 추가 작업, 추가 위험, 불필요한 복잡도를 의미하기에 정교한 시스템에서 커다란 적이다.

똑같은 코드는 당연히 중복이므로 없애준다. 유사한 코드는 더욱 똑같게 고치면 리팩터링이 더욱 쉬워진다.

int size() {}
boolean isEmpty() {}

구현 중복도 중복의 한 형태이다.

위와 같은 메서드 2개가 따로 구현되어 있지만 다음과 같이 고칠 수 있다.

boolean isEmpty() {
  return 0 == size();
}

 

public void scaleToOneDimension(float desiredDimension, float imageDimension) {
  if (Math.abs(desiredDimension - imageDimension) < errorThreshold)
    return;
  float scalingFactor = desiredDimension / imageDimension;
  scalingFactor = (float)(Math.floor(scalingFactor * 100) * 0.01f);
  
  RenderedOpnewImage = ImageUtilities.getScaledImage(image, scalingFactor, scalingFactor);
  image.dispose();
  System.gc();
  image = newImage;
}

public synchronized void rotate(int degrees) {
  RenderedOpnewImage = ImageUtilities.getRotatedImage(image, degrees);
  image.dispose();
  System.gc();
  image = newImage;
}

public void scaleToOneDimension(float desiredDimension, float imageDimension) {
  if (Math.abs(desiredDimension - imageDimension) < errorThreshold)
    return;
  float scalingFactor = desiredDimension / imageDimension;
  scalingFactor = (float) Math.floor(scalingFactor * 10) * 0.01f);
  replaceImage(ImageUtilities.getScaledImage(image, scalingFactor, scalingFactor));
}

public synchronized void rotate(int degrees) {
  replaceImage(ImageUtilities.getRotatedImage(image, degrees));
}

private void replaceImage(RenderedOpnewImage) {
  image.dispose();
  System.gc();
  image = newImage;
}

위의 2개의 코드블럭을 보면 scaleToOneDimension 메서드와 rotate 메서드의 중복 부분을 replaceImage로 뽑아놓은 것이다. 이는 SRP (단일 책임 원칙)을 위반하지만 가시성이 높아진다. SRP가 신경쓰인다면 다른 클래스로 replaceImage 메서드를 옮기는 것도 좋은 방법이다.

이러한 소규모 재사용은 시스템 복잡도를 극적으로 줄여준다.

 

템플릿 메서드 패턴을 사용해 소규모 재사용을 적극 사용할 수 있다.

3. 표현하라

소프트웨어 프로젝트의 비용 대부분은 유지보수에 있다. 이는 코드를 짜는 사람은 해당 코드의 조감을 알지만 시간이 지나 유지보수를 하는 사람은 코드를 알지 못한다. 따라서 코드는 개발자의 의도를 분명히 표현해야 한다.

의도를 분명히 표현하려면 다음과 같은 방법이 있다.

1. 좋은 이름을 선택한다
2. 함수와 클래스 크기를 가능한 줄인다
3. 표준 명칭을 사용한다
4. 단위 테스트 케이스를 꼼꼼히 작성한다
5. 노력한다

4. 클래스와 메서드 수를 최소로 줄여라

중복을 제거하고, 의도를 표현하고, SRP를 준수한다는 기본적인 개념도 극단으로 치달으면 득보다 실이 많아진다. 클래스와 메서드 크기를 줄이자고 조그만 클래스와 메서드를 수없이 만드는 사례도 없지 않다. 그래서 이 규칙은 함수와 클래스 수를 가능한 한 줄이라고 제안한다.

가능한 독단적인 견해는 멀리하고 실용적인 방식을 택해야 한다.