CS/Clean Code

CS Clean Code - 창발성

강태종 2022. 3. 24. 02:14

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

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

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

위 목록은 중요도 순이다.

 

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

문서로는 시스템을 완벽하게 설계했지만, 시스템이 의도한 대로 돌아가는지 검증할 간단한 방법이 없다면, 문서 작성을 위해 투자한 노력에 대한 가치는 인정받기 힘들다.

 

놀랍게도 "테스트 케이스를 만들고 계속 돌려라"라는 간단하고 단순한 규칙을 따르면 낮은 결합도, 높은 응집력, 객체 지향 방법론이 지향하는 목표를 저절히 달성하게 된다. 즉, 테스트 케이스를 작성하면 설계 품질이 높아진다.

결합도가 높으면 테스트 케이스를 작성하기 어렵다. 그러면 개발자는 의존 관계 역전 원칙, 의존성 주입, 인터페이스, 추상화 등 다양한 방법으로 결합도를 낮춰 설계 품질을 높인다.

 

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

구체적으로는 코드를 점진적으로 리팩터링 해나간다. 새로 추가한 코드가 설계 품질을 낮춘다면 깔끔히 정리한 후 테스트를 진행한다. 리팩토링 과정이 시스템을 깨트릴까 걱정할 필요가 없다. 테스트 코드가 있으니까!

  • 응집도 높이기
  • 결합도 높이기
  • 관심사 분리
  • 모듈화
  • 함수와 클래스 크기 줄이기
  • 더 나은 이름 선택하기

 

중복을 없애라

우수한 설계에서 중복은 커다란 적이다. 중복은 추가 작업, 추가 위험, 불필요한 복잡도를 뜻하기 때문이다.

 

중복은 여러 가지 형태로 표출된다. 구현 중복도 중복의 한 형태다.

int size() {
    // Something
}

boolean isEmpty() {
    // Something
}

 

각 메서드를 따로 구현하는 방법도 있지만 isEmpty()에서 size() 함수를 호출하면 중복을 제거할 수 있다.

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

 

깔끔한 시스템을 만들려면 단 몇 줄이라도 중복을 제거하겠다는 의지가 필요하다.

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

 

  • 적은 양이지만 코드의 중복을 제거했다.
  • 새 메서드로 뽑고 보니 SRP를 위반하는 사실을 발견했다.
  • 좀 더 추상화를 진행하여 재사용할 기회를 높일 수 있다.

소규모 재사용을 제대로 익혀야 대규모 재사용이 가능하다.

 

TEMPLATE METHOD 패턴은 고차원 중복을 제거할 목적으로 자주 사용한다.

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

 

최소 법정 일수를 계산하는 코드만 제외하면 두 메서드는 거의 동일하다.

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() {
    // 유럽연합 최소 법정 일수를 사용한다.
  }
}

 

표현하라

자신이 이해하는 코드를 짜기는 쉽다. 코드를 짜는 동안에는 문제에 푹 빠져 코드를 구석구석 이해하니까. 하지만 나중에 코드를 유지보수할 사람이 코드를 짜는 사람만큼이나 문제를 깊이 이해할 가능성은 희박하다.

 

소프트웨어 프로젝트 비용 중 대다수는 장기적인 유지보수에 들어간다. 시스템이 점차 복잡해지면서 시스템을 이해하느라 보내는 시간은 점점 늘어나고 오해할 가능성도 점점 커진다. 그러므로 코드는 개발자의 의도를 분명히 표현해야 한다.

  • 좋은 이름을 선택한다. (이름과 기능이 다른 클래스나 함수로 놀라게 해서는 안 된다.)
  • 함수와 클래스 크기는 가능한 줄인다. (작을 수록 이름 짓기도 쉽고, 구현도 쉽고, 이해하기 쉽다.)
  • 표준 명칭을 사용한다. (클래스가 디자인 패턴을 사용한다면, 디자인 패턴 이름을 넣어준다.)
  • 단위 테스트 케이스를 꼼꼼히 작성한다. (테스트 케이스는 예제이다. 테스트 케이스를 읽어보면 클래스 기능이 한눈에 들어온다.)
  • 표현력을 높이는 가장 중요한 방법은 노력이다.

 

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

중복을 제거하고, 의도를 표현하고, SRP를 준수한다는 기본적인 개념도 극단으로 치달으면 득보다 실이 많다. 때로는 무의미하고 독단적인 정책 탓에 클래스 수와 메서드 수가 늘어나기도 한다. 클래스와 메서드의 수를 줄이는 것도 주용하지만, 테스트 케이스를 만들고 중복을 제거하고 의도를 표현하는 작업이 더 중요하다.

 

결론

경험을 대신할 개발 기법은 없다. 이 책에서 소개하는 기법은 저자들이 수십 년 동안 쌓은 경험의 정수다. 단순한 설계 규칙을 따른다면 우수한 기법과 원칙을 단번에 활용할 수 있다.