Clean Code 12. 창발성(Emergence)

in Study on Clean Code


창발성(Emergence)이란 국어사전의 뜻은 새롭게 발생하는 성질이라는 뜻이고, 위키에서의 의미를 풀어서 보자면 단순한 결합이 복잡한 결과를 나타내는 것을 뜻한다. 좀더 쉽게 풀어서 이야기하자면, 개개 구성원들은 가지고 있지 않은 특성이 조직에서는 일어나는 현상을 말한다.

  • 뉴런 자체는 단순한 자극을 전달해주는 세포지만, 뉴런의 결합으로 사고가 가능해지는 현상
  • 수소나 질소에는 존재하지 않지만, 암모니아에서는 냄세가 나는 현상

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

따르기만 하면 우수한 설계가 나오는 간단한 규칙 4가지가 있다면?
그렇게만 하면 코드 구조와 설계 파익이 쉬워진다면?
그래서 SRP나 DIP같은 원칙 적용이 쉬워진다면?

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

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

(중요도 순)

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

즉, 테스트가 가능한 시스템이어야 한다. 테스트가 가능한 시스템을 만들려고 애쓰면 품질이 높아진다. SRP를 준수하는 클래스는 테스트가 쉽다. 결합도가 높으면 테스트를 작성하기 어렵다. 테스트 케이스를 많이 작성할수록 DIP같은 원칙을 적용하고 interface, 추상화와 같은 도구를 사용해 결합도를 낮추고, 설계 품질은 높아진다.

단순한 설계 규칙 2~4 Refactoring

테스트 케이스를 모두 작성했으면 이제 코드와 클래스를 정리해도 괜찮다. 코드를 정리하면서 시스템이 깨질까 걱정할 필요가 없다! 리펙터링 단계에서는 소프트웨어 설계 품질을 높이는 기법이면 무엇이든 적용해도 괜찮다. 응집도를 높이고, 결합도를 낮추고, 관심사를 분리하고, 시스템 관심사를 모듈로 나누고, 함수와 클래스 크기를 줄이고, 더 나은 이름을 선택한다. 그리고 나머지 2~4번 규칙을 적용한다.

중복을 없애라.

중복은 추가 작업, 추가 위험, 불필요한 복잡도를 뜻한다. 똑같은 코드는 당연히 중복이고, 비슷한 코드는 더 비슷하게 고쳐주면 리펙터링이 가능해진다. 구현중복도 중복이다.

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

isEmpty와 size의 코드 중 동일한 구현을 중복할 필요가 없다.

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

size를 이용하여 isEmpty를 구현하면 코드 중복이 사라진다.

단 몇 줄이라도 중복을 제거하겠다는 의지가 필요하다.

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를 위반한다. replaceImage를 다른 클래스로 옮기면 새 메서드의 가시성도 높아지고, 다른 팀원이 새 메서드를 좀 더 추상화해 다른 맥락에서 재사용할 기회를 포착할 수도 있다. 이런 소규모 재사용은 시스템 복잡도를 극적으로 줄여준다. 소규모 재사용을 제대로 익혀야 대규모 재사용이 가능하다.

Template method pattern은 고차원 중복을 제거할 목적으로 자주 사용한다.

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

표현하라

자신이 이해하는 코드를 짜기는 쉽다. 코드를 짜는 동안 코드 구석구석을 이해하니까. 하지만 나중에 코드를 유지보수할 사람이 코드를 짠 사람만큼 깊게 문제를 이해할 가능성은 희박하다. 소프트웨어 프로젝트 비용 중 대다수는 장기적인 유지보수에 들어간다. 코드는 개발자의 의도를 분명히 표현해야 한다.

  1. 좋은 이름을 선택한다.
  2. 함수와 클래스 크기를 가능한 줄인다.
  3. 표준 명칭을 사용한다. 디자인 패턴을 사용했다면 패턴 이름을 넣어줘라. 그러면 클래스 설계 의도를 이해하기 쉬워진다.
  4. 단위 테스트를 꼼꼼히 작성한다. 예제로 보여주는 문서역할을 한다.

표현력을 높이는 가장 중요한 방법은 노력이다. 코드만 돌려보고 바로 넘어가지 말고 다음 사람을 위해 조금 더 고민하자. 나중에 코드를 읽을 가능성이 가장 높은 사람은 자신이다.

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

아무리 좋은 규칙들도 극단으로 치달으면 득보다 실이 많아진다. 크기를 줄이고자 클래스와 메서드를 수없이 만드는 사례도 있고, 클래스마다 무조건 인터페이스를 생성하라는 것도 마찬가지다. 자료와 동작 클래스를 무조건 분리해야 한다는 주장도 좋은 예다. 가능한 독단적인 견해는 멀리하고 실용적인 방식을 택한다.

이 규칙은 4가지 규칙 중 우선순위가 가장 낮다.

이 글이 도움이 되셨다면 공감 및 광고 클릭을 부탁드립니다 :)