[CleanCode] -12. 창발성

Young Min Sim ·2021년 4월 26일
0

CleanCode

목록 보기
12/16

단순한 설계 규칙

우수한 설계의 창발성을 촉진하는 4가지 규칙


1. 모든 테스트를 실행하라

테스트가 가능한 시스템을 만들려고 애쓰면 설계 품질이 더불어 높아진다.

결합도가 높으면 테스트 케이스를 작성하기 어렵다.
테스트케이스를 많이 작성할수록 개발자는 DIP, DI, 인터페이스, 추상화 같은 도구를 사용하여 결합도를 낮춘다.
즉, 테스트 케이스를 만들고 계속 돌려라라는 간단하고 단순한 규칙을 따르면
시스템은 낮은 결합도와 높은 응집력이라는 객체 지향 방법론이 지향하는 목표를 저절로 달성한다.

결합도를 낮춰야 하는 이유에는 수정하는데 드는 비용뿐만 아니라,
테스트 케이스를 쉽게 작성하기 위함도 있음


2. 리팩토링

테스트 케이스를 모두 작성했다면 코드와 클래스를 정리해도 괜찮다.
점진적으로 리팩토링하면서 테스트케이스를 통해 검증한다.
이 단계에서는 SW 설계 품질을 높이는 기법들을 적용한다.
중복을 제거하고, 프로그래머의 의도를 표현하고, 클래스와 메서드 수를 최소로 줄인다.


3. 중복을 없애라

예시) TEMPLATE METHOD 패턴을 이용

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

4. 표현하라

SW 프로젝트 비용 중 대다수는 장기적인 유지보수에 들어간다.
코드로 개발자의 의도를 분명히 표현하여 다른 사람이 코드를 이해하기 쉽게 해야한다.
그래야 유지보수 개발자가 시스템을 이해하느라 보내는 시간을 줄이고 비용을 적게 들게 할 수 있다.

  • 방법
    • 좋은 이름을 선택한다.
    • 함수와 클래스 크기를 가능한 줄인다
    • 표준명칭을 사용한다. 예를 들어 디자인 패턴을 사용한 경우 클래스 이름에 넣어주면 다른 개발자가 쉽게 이해할 수 있다.
    • 단위 테스트 케이스를 꼼꼼히 작성한다. 잘 만든 테스트 케이스를 읽어보면 클래스 기능이 한 눈에 들어온다.
    • 무엇보다 중요한건 읽기 쉽게 만들기 위한 노력이다. 나중에 코드를 읽을 사람은 바로 자신일 가능성이 높다는 사실을 명심하자.

극단으로 치닫지 말자

중복을 제거, SRP를 준수한다는 개념도 극단적으로 치달으면 득보다 실이 많아진다.
클래스와 메서드를 줄이자고 조그만 클래스와 메서드를 수 없이 만드는 사례, 모든 클래스마다 무조건 인터페이스를 생성하라고 요구하는 구현 표준 등 이러한 독단적인 견해는 멀리하고 실용적인 방식을 택한다.

0개의 댓글