이 포스트는 클린코드 12장 - 창발성 을 정리한 내용입니다.

창발(創發)또는 떠오름 현상은 하위 계층(구성 요소)에는 없는 특성이나 행동이 상위 계층(전체 구조)에서 자발적으로 돌연히 출현하는 현상이다.

Overview

소프트웨어 설계 품질을 크게 높여준다고 믿어지는 켄트 벡이 제시한 단순한 설계 규칙 네가지 가 있다.

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

위 목록은 중요도 순이다.

네가지 규칙을 따르면 코드 구조와 설계를 파악하기 쉬워져 SRP, DIP와 같은 원칙을 적용하기 쉬워지며 우수한 설계의 창발성을 촉진시킬 수 있다.

단순한 설계 규칙 1 - 모든 테스트를 실행한다.

모든 테스트를 실행해도 오는 이점은 아래와 같다.

  1. 문서로는 시스템을 완벽하게 설계했다고 하더라도 의도한 대로 돌아가는지 검증할 방법이 필요
    • 검증할 방법이 없다면 투자한 노력에 대한 가치를 인정 받을 수 없음
  2. 테스트가 가능한 시스템이 만들어 짐
    • 테스트가 불가능한 시스템은 검증도 불가능하기 때문에 출시해서는 안됨
  3. 수월한 테스트를 위해 SRP를 준수하는 클래스가 나옴
  4. 결합도가 높으면 테스트 케이스를 작성하기 어렵기 때문에 이를 낮추는 노력을 하게 됨
    • DIP와 같은 원칙을 적용
    • 의존성 주입, 인터페이스, 추상화 등과 같은 도구 사용

결국, 이 규칙을 따르면 시스템은 낮은 결합도와 높은 응집력이라는 객체 지향 방법론이 지향하는 목표를 달성하게 되고 이를 통해 설계 품질을 높힐 수 있다.

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

테스트 코드를 모두 작성하면 코드와 클래스를 정리할 수 있어진다.

  1. 코드를 추가하고
  2. 추가한 코드가 품질을 낮추는지 보고
  3. 그렇다면 정리한 이후 테스트 케이스 돌려보고
  4. 넘어가면 된다!!!

코드를 정리하면서 시스템이 깨질까 걱정할 필요가 전혀 없다. 왜냐면 테스트 케이스를 통과했으니까~! 룰루 랄라

이 리펙터링 단계에서는 소프트웨어 설계 품질을 높이는 기법이라면 뭐든 적용해도 좋다. 앞으로 나오는 2~4번째 항목이 바로 그것이다.

응집도 높이고, 결합도 낮추고, 관심사 분리하고, 시스템 관심사를 모듈로 나누고, 함수와 클래스 크기를 줄이고, 이름 바꾸고 등등

중복을 없애라

우수한 설계에서 중복은 커다란 적이다.

  • 추가 작업, 추가 위험, 불필요한 복잡도를 뜻하기 때문

구현 중복 예시

집합 클래스에 다음 메서드가 있다고 가정했을 때:

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

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

이런식으로 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;
}

scaleToOneDimension 메서드와 rotate 메서드에는 동일한 코드가 일부 존재한다.

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(RenderedOp newImage) {
  image.dispose();
  System.gc();
  image = newImage;
}

Templete Method 패턴 예시

public class VacationPolicy {
  public void accrueUSDDivisionVacation() {
    // 지금까지 근무한 시간을 바탕으로 휴가 일수를 계산하는 코드
    // ...
    // 휴가 일수가 미국 최소 법정 일수를 만족하는지 확인하는 코드
    // ...
    // 휴가 일수를 급여 대장에 적용하는 코드
    // ...
  }
  
  public void accrueEUDivisionVacation() {
    // 지금까지 근무한 시간을 바탕으로 휴가 일수를 계산하는 코드
    // ...
    // 휴가 일수가 유럽연합 최소 법정 일수를 만족하는지 확인하는 코드
    // ...
    // 휴가 일수를 급여 대장에 적용하는 코드
    // ...
  }
}

최소 법정 일수를 계산하는 코드만 제외하면 두 메서드는 거의 동일하기 때문에, template method 패턴을 적용해 중복을 제거할 수 있다.

abstract public class VacationPolicy {
  public void accrueVacation() {
    caculateBseVacationHours();
    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() {
    // 유럽연합 최소 법정 일수를 사용한다.
  }
}

하위 클래스에서 method를 구현하여 각각의 중복되지 않는 정보(기능)을 채운다.

프로그래머 의도를 표현한다.

자신이 이해하는 코드를 짜기는 쉽지만 코드를 유지보수할 사람이 코드를 짜는 사람만큼이나 문제를 깊이 이해할 가능성은 희박하다.

  1. 소프트웨어 프로젝트 비용의 대다수는 유지보수에 들어간다.
  2. 시스템이 점차 복잡해지면서 유지보수 개발자가 시스템을 이해하느라 보내는 시간은 점점 늘어나고 오해할 가능성도 높아짐
  3. 그러므로 코드는 개발자의 의도를 분명히 표현해야 함
    • 코드를 명백하게 짤수록 다른 사람이 이해하기 쉬움
    • 그래야 결함이 줄어듦 -> 유지보수 비용 감소

구체적으로는:

  1. 좋은 이름을 선택
    • 이름과 기능이 딴판이여서는 아니된다.
  2. 함수와 클래스 크기를 가능한 줄임
    • 이름 짓기도 쉽고, 구현도 쉽고, 이해도 쉬움
  3. 표준 명칭을 사용
    • 표준 패턴을 사용할 경우 그 이름을 넣어주면 의도를 알기 쉬움
  4. 단위 테스트 케이스를 꼼꼼히 작성
    • 테스트 케이스는 예제가 되기도 함
    • 잘 만든 테스트 케이스만 봐도 클래스 기능을 쉽게 이해할 수 있다.

위의 사항을 노력을 들여 지킬 필요가 있다.

  • 그냥 코드만 돌리고 다음 문제로 직행하지 말고…
  • 후세를 위해 조금이라도 더 읽기 쉽게 만들려는 고민을 좀…
  • 그게 본인이 될 가능성도 높음

클래스와 메서드 수를 최소로 줄인다.

가능하다면, 함수와 클래스 크기를 작게 유지하면서 시스템 크기도 작게 유지하는 것이 좋다.

  • 중복 제거, 의도 표현, SRP 준수를 극단적으로 하게 되면 크기를 줄이기 위해 이것들의 수를 수없이 만들 수 있다.

결론

개발 기법들이 아무리 날고 기어도 경험을 대신할 수는 없다. 하지만 여기 나온 이 단순한 설계 규칙을 따른다면 경험이 쌓인 이후에 익힐 기법과 원칙들도 단번에 활용할 수 있을 것이다. 왜냐면 우리가 쌓은 경험으로 이 내용을 적었기 때문이다. 껄껄껄

Reference

Clean Code 클린코드 : 애자일 소프트웨어 장인 정신 창발 – 위키백과