클린코드 (10) - 창발성

gentledot·2021년 7월 10일

도서를 읽고서 클린코드

코드 품질에 대한 고찰

목록 보기

12/13

창발성

경험을 대신할 단순한 개발 기법? → 없다.
클린코드의 기법들은 저자들이 수십 년 동안 쌓은 경험의 정수.
단순한 설계 규칙을 따른다면 (오랜 경험 후에야 익힐) 우수한 기법과 원칙을 단번에 활용할 수 있음.

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

켄트 벡(Kent Beck)은 다음 규칙을 따르면 설계는 '단순하다'고 말한다. (중요도 순)
BeckDesignRules - martinfowler
- 모든 테스트를 실행한다.
- 중복을 없앤다.
- 프로그래머 의도를 표현한다.
- 클래스와 메서드 수를 최소로 줄인다.

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

설계는 의도한 대로 돌아가는 시스템을 내놓아야 한다.
시스템이 의도한 대로 돌아가는지 검증할 간단한 방법이 없다면, 문서 작성을 위해 투자한 노력에 대한 가치는 인정받기 어렵다. (검증이 불가능한 시스템은 절대 출시하면 안됨.)
테스트를 철저히 거쳐 모든 테스트 케이스를 항상 통과하는 시스템 ⇒ 테스트가 가능한 시스템
테스트가 가능한 시스템을 만들려고 애쓰면 설계 품질이 더불어 높아진다. (SRP(단일 책임 원칙)를 준수하는 클래스 증가)
- 시스템은 낮은 결합도와 높은 응집력이라는 목표를 저절로 달성한다. (객체 지향 방법론이 지향하는 목표)
결합도가 높으면 테스트 케이스를 작성하기 어려움
- 테스트 케이스를 많이 작성할수록 개발자는 DIP(Dependency Inversion Principle)와 같은 원칙을 적용하고 의존성 주입(Dependency Injection), 인터페이스, 추상화 등과 같은 도구를 사용해 결합도를 낮춘다. → 설계 품질 높아짐

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

테스트 케이스를 모두 작성했다면 코드와 클래스를 정리해도 괜찮음. (점진적인 리팩토링)
- 코드를 정리하면서 테스트 케이스를 작성
```
 새로 추가하는 코드가 설계 품질을 낮추는가? 
  → 깔끔히 정리 후 테스트 케이스를 돌려 기존 기능을 깨뜨리지 않았음을 확인
```
리팩토링 단계에서 적용할 수 있는 기법들
- 소프트웨어 설계 품질을 높이는 기법이라면 무엇이든 적용 가능
  - 응집도를 높이고
  - 결합도를 낮추고
  - 관심사를 분리하고
  - 시스템 관심사를 모듈로 나누고
  - 함수와 클래스 크기를 줄이고
  - 더 나은 이름을 선택
  - 중복을 제거
  - 프로그래머 의도를 표현
  - 클래스와 메서드 수를 최소로 줄임

중복을 없애라

중복은 추가 작업, 추가 위험, 불필요한 복잡도를 뜻한다.

중복 대응 유형

똑같은 코드

비슷한 코드는 더 비슷하게 고쳐주면 리팩토링이 쉬워진다.

구현 중복

각 메서드를 따로 구현하는 방법도 있음.

  int size() {} // 개수를 int로 반환 
  boolean isEmpty() {} // boolean 반환

통합하여 구현하면 코드를 중복해 구현할 필요가 없어진다.
```
  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);
  RenderedOp newImage = ImageUtilities.getScaledImage(
          image, scalingFactor, scalingFactor);
  image.dispose();
  System.gc();
  image = newImage;
}

public synchronized void rotate(int degrees) {
  RenderedOp newImage = ImageUtilities.getRoatedImage(
          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 * 100) * 0.01f);
    replaceImage(ImageUtilities.getScaledImage(
            image, scalingFactor, scalingFactor));
}

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

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

공통적인 코드를 새 메서드로 뽑고 보니 클래스가 SRP를 위반한다.
- 새로 만든 replaceImage 메서드를 다른 클래스로 옮기는 것을 고려할 수 있음
- 메서드의 가시성 증가
- 다른 팀원이 새 메서드를 좀 더 추상화해 다른 맥락에서 재사용할 기회를 포착할 수 있음
'소규모 재사용'은 시스템 복잡도를 극적으로 줄여준다.
- 소규모 재사용을 제대로 익혀야 대규모 재사용이 가능하다.

TEMPLATE METHOD 패턴의 활용 (고차원 중복을 제거할 목적으로 자주 사용하는 기법)

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

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

최소 법정 일수를 계산하는 코드만 제외하면 두 메서드는 거의 동일하다.
- 최소 법정 일수를 계산하는 알고리즘은 직원 유형에 따라 살짝 변한다.

Template Method 패턴을 적용해 눈에 들어오는 중복을 제거

abstract public class VacationPolicy {
    public void accrueVacation() {
				// 지금까지 근무한 시간을 바탕으로 휴가 일수를 계산하는 코드
        // 휴가 일수가 법정 일수롤 만족하는지 확인하는 코드
        // 휴가 일수를 급여 대장에 적용하는 코드
        calculateBaseVacationHours();
        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() {
        // 유럽연합 최소 법정 일수를 사용한다.
    }
}

하위 클래스는 중복되지 않는 정보만 제공해 accureVacation 알고리즘에서 빠진 '구멍'을 메운다.

개발자의 의도를 분명히 표현하자.

자신이 이해하는 코드를 짜기는 쉽다. (코드를 짜는 동안에는 문제에 푹 빠져 코드를 구석구석 이해하니...)
- 나중에 코드를 유지보수할 사람이 코드를 짜는 사람만큼이나 문제를 깊이 이해할 가능성은 희박하다.
소프트웨어 프로젝트 비용 중 대다수는 장기적인 유지보수에 들어간다.
코드를 변경하면서 버그의 싹을 심지 않으려면 유지보수 개발자가 시스템을 제대로 이해해야 한다.
- 시스템이 점차 복잡해지며 유지보수 개발자가 시스템을 이해하느라 보내는 시간은 점점 늘어나고 동시에 코드를 오해할 가능성도 점점 커진다.
의도를 분명히 표현하려면
- 좋은 이름을 선택한다.
- 함수와 클래스 크기를 가능한 줄인다. (작은 클래스, 작은 함수) ≠ SRP 원칙 무조건 준수하기
- 표준 명칭을 사용한다.
- 단위 테스트 케이스를 꼼꼼히 작성한다.
나중에 읽을 사람을 고려해 조금이라도 읽기 쉽게 만드려는 노력(고민)을 들인다.
- 함수와 클래스에 조금 더 시간을 투자하자
- 더 나은 이름을 선택하자
- 큰 함수를 작은 함수 여럿으로 나누자
- 자신의 작품에 조금만 더 주의를 기울이자
- 주의는 대단한 재능이다.

클래스와 메서드 수를 (가능한) 최소로 줄여라

중복을 제거하고, 의도를 표현하고, SRP를 준수한다는 기본적인 개념도 극단으로 치달으면 득보다 실이 많아진다.
때론 무의미하고 독단적인 정책 탓에 클래스 수와 메서드 수가 늘어나기도 한다. ⇒ 가능한 독단적인 견해는 멀리하고 실용적인 방식을 택한다.
- 클래스마다 무조건 인터페이스를 생성하라고 요구하는 구현 표준
- 자료 클래스와 동작 클래스는 무조건 분리해야 한다는 주장
목표는 함수와 클래스 크기를 작게 유지하면서 동시에 시스템 크기도 작게 유지하는데에 있음.
- 클래스와 함수 수를 줄이는 작업도 중요하지만, 테스트 케이스를 만들고 중복을 제거하고 의도를 표현하는 작업이 더 중요하다는 뜻.

정해진 개발 일정에 쫒기는 상황에서 작성하는 코드에 의도를 분명히 표현하려 추가적인 시간과 노력을 투자하는 것은 정말 어려운 일이라 느낍니다.
하지만 코드 작업을 진행하게 된다면 꼭! 최대한 다음을 염두하면서 작업해보도록 노력할 생각입니다.

좋은 이름을 고민하면서, 표준 명칭 사용을 우선적으로 하고

method와 class가 갖는 책임의 크기를 최소화하려 고려해보고

단위 테스트를 통해 단위의 명세와 단위로의 리팩토링을 고려할 수 있다면
수정, 개선에 용이한 코드의 답을 찾을 수 있지 않을까 생각합니다. (경험을 쌓아가면서 이에 대한 저만의 철학을 갖고 싶은 욕심이 생깁니다.)

gentledot

그동안 마신 커피와 개발 지식, 경험을 기록하는 공간

이전 포스트

클린코드 (9) - 시스템

다음 포스트