012. (Clean Code) 12. 창발성(創發性) - Emergence

12. 창발성(創發性) - Emergence

창발성(創發性)
명사 남이 모르거나 하지 아니한 것을 처음으로 또는 새롭게 밝혀내거나 이루어 내는 성질.

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

네 가지 규칙만 준수하면 우수한 설계가 나온다면?

네 가지 규칙만 준수하면 코드 구조와 설계를 파악하기 쉬워진다면?

네 가지 규칙만 준수하면 단일 책임 원칙과 의존 관계 역전 원칙을 적용하기 쉬워진다면?

네 가지 규칙만 준수하면 우수한 설계의 창발성이 촉진된다면?

켄트 백은 아래 네 가지 규칙을 준수한다면 설계를 단순한 것이라고 말한다.

• 모든 테스트를 실행한다.
• 중복을 없앤다.
• 개발자의 의도를 표현한다.
• 클래스와 메서드 수를 최소로 줄인다.

이 규칙은 중요도 순으로 나열된 것이다.

각 규칙을 자세히 알아보자.

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

무엇보다도 설계는 의도한 대로 돌아가는 시스템을 내놓아야 한다.

문서상으로는 완벽한 시스템을 설계했더라도, 시스템이 의도한 대로 돌아가는지 검증할 방법이 없다면 문서화에 쏟은 리소스는 인정받기 힘든 비용이다.

테스트를 철저히 거쳐 모든 테스트 케이스를 항상 통과하는 시스템은 “테스트가 가능한 시스템”이다.

테스트가 불가능한 시스템은 검증이 불가능하므로 절대 출시해서는 안된다.

다행히도, 테스트가 가능한 시스템을 만들려고 노력할수록, 크기가 작고 하나의 목적만 수행하는 클래스가 나오므로 설계 품질이 저절로 높아진다.

즉 단일 책임 원칙을 준수하는 클래스가 테스트하기 더욱 쉽다.

테스트 케이스가 많을수록 개발자는 테스트가 쉽게 코드를 작성하므로, 철저한 테스트가 가능한 시스템을 만드는 것이 곧 더 나은 설계를 획득하는 방법이다.

이 단순한 규칙을 따르면 시스템은 낮은 결합도와 높은 응집력이라는 객체 지향 방법론이 지향하는 목표를 저절로 달성한다.

12.3. 리팩토링

규칙 1에 따라 테스트 케이스를 모두 작성했다면 코드와 클래스를 정리할 시간이다.

새로 추가하는 코드가 설계 품질을 낮춘다면 이를 먼저 정리한 후, 리그레션 테스트를 통해 기존 기능의 정상 동작을 보장하는 방식으로 접근하면

리팩토링 도중 시스템이 깨질 걱정을 할 필요가 없다.

리팩토링 단계에서는 소프트웨어 설계 품질을 높이는 기법이라면 무엇이든 적용해도 괜찮다.

결합도를 낮추고, 응집도를 높이고, 더 나은 이름을 선택하는 등 다양한 기법을 동원하고, 남은 규칙 3개를 순차적으로 적용한다.

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

우수한 설계에서 중복은 커다란 적이다.

중복은 진정한 의미는 추가 작업, 추가 위험, 불필요한 복잡도이기 때문이다.

중복을 여러 가지 형태로 표출된다.

똑같은 코드는 당연히 중복이고, 비슷한 코드는 더 비슷하게 고쳐서 리팩토링을 용이하게 해야한다.

또 다른 형태로 구현의 중복이 있다.

예를 들어 집합을 의미하는 클래스에 아래 메서드가 있다고 가정하자.

int size() {
    // ...
}

boolean isEmpty() {
    // ...
}

size()는 현재 집합 내 원소의 개수를, isEmpty()는 집합이 비어있는지를 판단해서 반환한다.

코드의 중복없이 아래와 같이 구현할 수도 있다.

int size() {
    // ...
}

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.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 * 100) * 0.01f);

    replaceImage(ImageUtilities.getScaledImage(image, scalingFactor, scalingFactor)); // HERE
}

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

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

중복을 제거하고보니 클래스가 단일 책임 원칙을 위반한다.

이를 해소하기위해 새로 만든 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() {
        // 유럽연합 최소 법정 일수를 사용한다.
    }
}

슈퍼 클래스인 VacationPolicy의 서브 클래스인 USVacationPolicy 클래스와 EUVacationPolicy 클래스는 중복되지 않는 정보만 제공해서 accrueVacation() 메서드의 달라지는 부분만 보완한다.

12.5. 단순한 설계 규칙 3 : 개발자의 의도를 표현하라

대다수의 개발자들은 엉망인 코드를 접해본 경험이 있을 것이다.

물론 스스로 엉망인 코드를 작성한 경험 또한 있을 것이다.

개발자가 자신이 이해하는 코드를 작성하는 것은 쉽지만, 나중에 해당 코드를 유지보수할 사람이 똑같은 이해도를 가질 가능성은 희박하다.

소프트웨어 프로젝트 비용 중 대다수는 장기적인 유지보수에 쓰인다.

코드를 변경하면서 오류를 발생할 가능성을 줄이려면 유지보수할 개발자가 시스템을 제대로 이해할 수 있도록 개발자의 의도를 분명히 표현하는 코드를 작성해야 한다.

첫 번째, 먼저 좋은 이름을 선택하고, 이름과 기능이 딴판인 클래스나 함수는 배제한다.

두 번째, 함수와 클래스의 크기를 가능한 줄여서 작명도, 구현도, 이해하기도 쉽게 만든다.

세 번째, 표준 명칭을 사용한다.

예를 들어 특정 디자인 패턴은 이용해 구현된다면 해당 클래스 이름에 디자인 패턴의 이름을 넣어준다.

네 번재, 단위 테스트 케이슬르 꼼꼼하게 작성한다.

테스트 케이스는 예제로 보여주는 또 다른 문서 이므로, 기능의 이해를 도와준다.

방법을 나열해봤지만 표현력을 높이는 가장 중요한 방법은 결국 노력이다.

나중에 코드를 읽을 사람을 고려해 조금이라도 쉽게 만드려는 고민을 하는 습관을 들이자.

그리고 명심하자.

나중에 코드를 읽게 될 사람이 미래의 나 자신일 수도 있다.

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

중복 제거, 의도 표현, 단일 책임 준수라는 기본적인 개념도 극단으로 치닫게 되면 득보다 실이 많아지는 경우가 있다.

클래스와 메서드의 크기를 줄이는 것에 집착해 조그마한 클래스와 메서드를 수없이 만들게 될 수도 있다.

그래서 이 규칙은 무조건 크기를 줄이라는 게 아닌, 가능한 범주에서 최소로 줄이라고 쓰는 것이다.

목표는 함수와 클래스 크기를 작게 유지하면서 동시에 시스템 크기도 작게 유지하는 데 있다.

다만 이 규칙은 4개의 규칙 중 가장 우선순위가 낮다는 것을 염두에 두어야 한다.

다시 말해 클래스와 함수를 줄이는 작업도 중요하지만, 테스트 케이스를 만들고 중복을 제거하고 의도를 표현하는 것이 더욱 중요하다.