[Clean Code] 12. 창발성 - 클린 코드 정독하기

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

켄트 벡이 제시한 네 가지 단순한 설계 규칙

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

 

켄트 벡이 제시한 규칙을 따르면 설계는 단순하다. 코드 구조와 설계를 파악하기 쉬워지고 단일 책임 원칙(SRP), 의존 관계 역전 원칙(DIP)과 같은 원칙을 적용하기 쉬워진다. 위 네 가지 규칙이 우수한 설계의 창발성을 촉진한다.

 

 

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

문서로는 시스템을 완벽하게 설계했지만, 시스템이 의도한 대로 돌아가는지 검증할 방법이 없다면, 문서 작성을 위해 투자한 노력에 대한 가치는 인정받기 힘들다.

테스트를 철저하게 거쳐 모든 테스트 케이스를 항상 통과하는 시스템은 ‘테스트가 가능한 시스템’이다. 테스트가 불가능한 시스템은 검증도 불가능하다. 논란의 여지는 있지만, 검증이 불가능한 시스템은 절대 출시하면 안 된다.

 

테스트가 가능한 시스템을 만들려고 애쓰면 설계 품질이 더불어 높아진다. 크기가 작고 목적 하나만 수행하는 클래스가 나온다. SRP를 준수하는 클래스는 테스트가 훨씬 더 쉽다. 철저한 테스트가 가능한 시스템을 만들면 더 나은 설계가 얻어진다.

결합도가 높으면 테스트 케이스를 작성하기 어렵다. 테스트 케이스를 많이 작성할수록 DIP와 같은 원칙을 적용하고, 의존성 주입(DI), 인터페이스, 추상화 등과 같은 도구를 사용해 결합도를 낮춘다.

즉, 테스트 케이스를 작성하면 설계 품질이 높아진다.

 

 

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

테스트 케이스를 모두 작성했다면 코드와 클래스를 정리해도 괜찮다. 구체적으로는 코드를 점진적으로 리팩토링 해나간다. 테스트 케이스가 있으므로 코트를 정리하면서 시스템이 깨질까 걱정할 필요가 없다.

 

리팩토링 단계에서는 소프트웨어 설계 품질을 높이는 기법이라면 무엇이든 적용해도 괜찮다. 응집도를 높이고, 결합도를 낮추고, 관심사를 분리하고, 시스템 관심사를 모듈로 나누고, 함수와 클래스 크기를 줄이고, 더 나은 이름을 선택하는 등 다양한 기법을 동원한다.

이 단계에서는 단순한 설계 규칙 중 나머지 3개를 적용해 중복을 제거하고, 프로그래머 의도를 표현하고, 클래스와 메서드 수를 최소로 줄이는 단계이기도 하다.

 

 

중복을 없애라

우수한 설계에서 중복은 커다란 적이다. 중복은 추가 작업, 추가 위험, 불필요한 복잡도를 뜻하기 때문이다. 중복은 여러 가지 형태로 표출된다. 똑같은 코드는 당연히 중복이다. 비슷한 코드는 더 비슷하게 고쳐주면 리팩토링이 쉬워진다.

 

구현 중복도 중복의 한 형태다.

예를 들어, 집합 클래스에 다음 메서드가 있다고 가정하자.

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

각 메서드를 따로 구현하는 방법도 있다. isEmpty() 메서드는 boolean 값을 반환하며 size() 메서드는 개수를 반환한다.

 

하지만 isEmpty() 메서드를 이용하면 코드를 중복해 구현할 필요가 없어진다.

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);

    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 * 100) * 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 메서드를 다른 클래스로 옮겨 SRP를 지키면서 가시성을 높일 수 있다.
• ‘소규모 재사용’은 시스템 복잡도를 극적으로 줄여준다. 소규모 재사용을 제대로 익혀야 대규모 재사용이 가능하다.

 

Template Method 패턴

Template Method 패턴은 고차원 중복을 제거할 목적으로 자주 사용하는 기법이다.

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

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

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

 

 

표현하라

우리는 엉망인 코드를 접한 경험이 있을 것이며, 스스로 엉망인 코드를 작성한 경험도 있을 것이다. 자신이 이해하는 코드를 짜기는 쉽다. 코드를 짜는 동안에는 문제에 푹 빠져 코드를 구석구석 이해하니까. 하지만 나중에 코드를 유지보수할 사람이 코드를 짜는 사람만큼이나 문제를 깊이 이해할 가능성은 희박하다.

 

소프트웨어 프로젝트 비용 중 대다수는 장기적인 유지보수에 들어간다. 코드를 변경하면서 버그의 싹을 심지 않으려면 유지보수 개발자가 시스템을 제대로 이해해야 한다. 하지만 시스템이 점차 복잡해지면서 유지보수 개발자가 시스템을 이해하느라 보내는 시간은 점점 늘어나고 동시에 코드를 오해할 가능성도 점점 커진다.

따라서 코드는 개발자의 의도를 분명히 표현해야 한다. 개발자가 코드를 명백하게 짤수록 다른 사람이 그 코드를 이해하기 쉬워진다. 그래야 결함이 줄어들고 유지보수 비용이 적게 든다.

• 좋은 이름을 선택한다. 이름과 기능이 다른 클래스나 함수로 유지보수 담당자를 당황하게 해서는 안된다.
• 함수와 클래스 크기를 가능한 줄인다. 작은 클래스와 작은 함수는 이름 짓기도 쉽고, 구현하기도 쉽고, 이해하기도 쉽다.
• 표준 명칭을 사용한다. 예를 들어, 디자인 패턴은 의사소통과 표현력 강화가 주요 목적이다. 클래스가 Command나 Visitor와 같은 표준 패턴을 사용해 구현된다면 클래스 이름에 패턴 이름을 넣어준다.
• 단위 테스트 케이스를 꼼꼼히 작성한다. 테스트 케이스는 ‘예제로 보여주는 문서’다. 잘 만든 테스트 케이스를 읽어보면 클래스 기능이 한눈에 들어온다.
• 표현력을 높이기 위한 가장 중요한 방법은 노력이다. 코드만 돌린 후 다음 문제로 넘어가는 사례가 너무도 흔하다. 나중에 읽을 사람을 고려해 조금이라도 읽기 쉽게 만들려는 충분한 고민은 거의 찾기 어렵다. 하지만 나중에 코드를 읽을 사람은 바로 자신일 가능성이 높다는 사실을 명심해야 한다.

 

 

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

중복을 제거하고, 의도를 표현하고, SRP를 준수한다는 기본적인 개념도 극단으로 치달으면 득 보다 실이 많아진다. 클래스와 메서드 크기를 줄이자고 조그만 클래스와 메서드를 수없이 만드는 사례도 없지 않다. 그래서 이 규칙은 함수와 클래스 수를 가능한 줄이라고 제안한다.

 

때로는 무의미하고 독단적인 정책 탓에 클래스 수와 메서드 수가 늘어나기도 한다. 클래스마다 무조건 인터페이스를 생성하라고 요구한다거나, 자료 클래스와 동작 클래스는 무조건 분리해야 한다고 주장하는 등이 있다. 가능한 독단적인 견해는 멀리하고 실용적인 방식을 택한다.

 

목표는 함수와 클래스 크기를 작게 유지하면서 동시에 시스템 크기도 작게 유지하는 데 있다. 하지만 이 규칙은 간단한 설계 규칙 네 개 중 우선순위가 가장 낮다. 클래스와 함수 수를 줄이는 작업도 중요하지만, 테스트 케이스를 만들고 중복을 제거하고 의도를 표현하는 작업이 더 중요하다.

 

 

결론

경험을 대신할 단순한 개발 기법은 없다. 하지만 이 책에서 소개하는 기법은 저자들이 수십 년 동안 쌓은 경험의 정수다. 단순한 설계 규칙을 따른다면 우수한 기법과 원칙을 단번에 활용할 수 있다.

 

 

 

https://link.coupang.com/a/9wvsv

클린 코드 + 클린 아키텍처 세트

 

https://link.coupang.com/a/9wvAy

Clean Code(클린 코드):애자일 소프트웨어 장인 정신

"이 포스팅은 쿠팡 파트너스 활동의 일환으로, 이에 따른 일정액의 수수료를 제공받습니다."