클린 코드(Clean Code) - 12장 창발성

Muzi·2023년 1월 18일

독서 클린 코드

Clean Code

목록 보기

12/14

창발성

단순하지만 중요한 네 가지 규칙을 따라 설계를 하면, 창발성이 촉진되어 우수한 설계를 완성할 수 있게 된다.

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

'테스트 케이스를 만들고 계속 돌려라' 라는 단순한 규칙을 따르면 낮은 결합도와 높은 응집력을 갖는 객체 지향 코드가 나온다.

테스트를 철저히 거쳐 모든 테스트 케이스를 항상 통과하는 시스템은 '테스트가 가능한 시스템' 이다.
테스트가 가능한 시스템을 만들려고 애쓰면 설계 품질이 더불어 높아진다.
철저한 테스트가 가능한 시스템을 만들면 더 나은 설계가 얻어진다.
아래와 같은 방법을 따르면 결합도를 낮추며 설계 품질은 높아진다
- DIP와 같은 원칙을 적용
- 의존성 주입(Dependency Injection)
- 인터페이스
- 추상화

단순한 설계 규칙 2:중복을 없애라

우수한 설계에서 중복은 커다란 적이다
같은 코드는 당연히 중복이다. 비슷한 코드는 더 비슷하게 고쳐주면 리팩터링이 쉬워진다.
깔끔한 시스템을 만들려면 단 몇 줄이라도 중복을 제거하겠다는 의지가 필요하다

// 각 메서드를 따로 구현하는 방법도 있다. 하지만 size()가 개수를 반환하는 로직이다.
int size() {}
boolean isEmpty{}

// 따라서 isEmpty는 이를 이용하면 코드를 중복해서 구현할 필요가 없어진다.
boolean isEmpty() {
  return 0 == size();
}

// Code 1-1, 중복 제거 전
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;
}

‘소규모 재사용’은 시스템 복잡도를 극적으로 줄여준다
소규모 재사용을 제대로 익혀야 대규모 재사용이 가능하다
아래 TEMPLATE METHOD 패턴은 고차원 중복을 제거할 목적으로 자주 사용하는 기법이다

// Code 2-1, 최소 법정 일수를 계산하는 코드만 제외하면 두 메서드는 거의 동일하다. 
public class VacationPolicy {
  public void accrueUSDDivisionVacation() {
    // 지금까지 근무한 시간을 바탕으로 휴가 일수를 계산하는 코드
    // ...
    // 휴가 일수가 미국 최소 법정 일수를 만족하는지 확인하는 코드
    // ...
    // 휴가 일수를 급여 대장에 적용하는 코드
    // ...
  }

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


// Code 2-2, 템플릿 메서드 적용 
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() {
    // 유럽연합 최소 법정 일수를 사용한다.
  }
}

단순한 설계 규칙 3:프로그래머 의도를 표현하라

1. 좋은 이름을 선택한다

이름과 기능이 완전히 딴판인 클래스나 함수로 유지보수 담당자를 놀라게 해서는 안 된다

2. 함수와 클래스 크기를 가능한 줄인다

작은 클래스와 작은 함수는 이름 짓기도 쉽고, 구현하기도 쉽고, 이해하기도 쉽다

3. 표준 명칭을 사용한다

예를 들어, 디자인 패턴은 의사소통과 표현력 강화가 주요 목적이다. 클래스가 COMMAND나 VISITOR와 같은 표준 패턴을 사용해 구현된다면 클래스 이름에 패턴 이름을 넣어준다. 그러면 다른 개발자가 클래스 설계 의도를 이해하기 쉬워진다.

4. 단위 테스트 케이스를 꼼꼼히 작성한다

테스트 케이스는 소위 '예제로 보여주는 문서'다. 다시 말해 잘 만든 테스트 케이스를 읽어보면 클래스 기능이 한눈에 들어온다
표현력을 높이는 가장 중요한 방법은 노력이다. 흔히 코드만 돌린 후 다음 문제로 직행하는 사례가 너무 흔하다. 나중에 읽을 사람을 고려해 조금 이라도 읽기 쉽게 만들려는 충분한 고민은 거의 찾기 어렵다. 하지만 나중에 코드를 읽을 사람은 바로 자신일 가능성이 높다는 사실을 명심하자

단순한 설계 규칙 4:클래스와 메서드 수를 최소로 줄여라

때로는 무의미하고 독단적인 정책 탓에 클래스 수와 메서드 수가 늘어나기도 한다. 클래스마다 무조건 인터페이스를 생성하라고 요구하는 구현 표준이 좋은 예다. 자료 클래스와 동작 클래스는 무조건 분리해야 한다고 주장하는 개발자도 좋은 예다.

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