Clean Code - 소프트웨어 창발성(Emergence)

창발성(Emergence)

창발 현상이란 단순한 결합이 의도와 관계 없이 어떠한 결과를 나타나는 현상을 의미한다.

 

가령, 붉은악마 신드롬은 정부나 월드컵조직위원회가 특정한 계획에 따라 조직한 것이 아니라, 국민들이 인터넷과 방송매체, 주변과의 접촉 등을 통해 자발적으로 상호작용을 일으키며 나타난 현상이다.

 

아래 켄트 벡이 제시하는 단순한 설계 규칙 네 가지를 따르면 소프트웨어 설계 품질을 크게 높여주는 결과가 발생한다고 믿는다.

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

 

위 목록은 중요도 순이다.

모든 테스트를 실행하라.

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

 

테스트를 철저히 거쳐 모든 테스트 케이스를 항상 통과하는 시스템은 테스트가 가능한 시스템이다. 테스트가 불가능한 시스템은 검증도 불가능하다. 검증이 불가능한 시스템은 출시하면 안된다.

 

테스트가 가능한 시스템을 만들면 설계 품질이 더불어 높아진다. 크기가 작고 목적 하나만 수행하는 클래스가 나온다. SRP를 준수하는 클래스는 테스트가 훨씬 더 쉽다. 테스트 케이스가 많을수록 개발자는 테스트하기 쉽게 코드를 작성한다.  따라서 철저한 테스트가 가능한 시스템을 만들면 더 나은 설계가 얻어진다.

 

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

 

정리하면 테스트 케이스를 많이 만들고 돌리는 원칙만 지키더라도 개발자는 낮은 결합도와 높은 응집력이라는 객체 지향 방법론이 지향하는 목표를 저절로 달성한다.

리팩터링

테스트 케이스를 모두 작성했다면 이제 코드와 클래스를 리팩토링할 수 있다.

 

코드를 몇 줄 추가할 때마다 잠시 멈추고 '새로 추가하는 코드가 설계 품질을 낮추는 지' 생각해본 후 깔끔하게 정리하고 테스크 케이스를 돌려 기존 기능이 깨지지 않는 지 확인한다.

 

이 때 코드를 정리하면서 시스템이 깨질 까 걱정할 필요가 없다. 테스트 케이스가 있으니까! 그래서 단위 테스트와 통합 테스트를 잘 유지하면 리팩토링이라는 작업이 훨씬 가볍게 느껴진다.

 

중복을 없애라

중복은 추가 작업, 추가 위험, 불필요한 복잡도를 의미한다. 적은 양이라도 메소드 추출 기법(Extract method)를 사용해서 메서드를 재사용하면 메서드의 가시성이 높아지고 중복을 제거할 수 있다.

 

추가로 다른 팀원이 새 메서드를 좀 더 추상화해 다른 맥락에서 재사용할 기회를 포착할 지도 모른다. 지저분한 프로젝트가 커지면 손을 대기가 무서워진다.

 

템플릿 메서드 패턴(Template Method Pattern)을 사용하면 고차원 중복을 제거할 목적으로 자주 사용된다. 예를 보자.

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

최종 법정 일수를 계산하는 코드만 제외하면 두 메서드는 거의 동일하다. 여기에 Template Method 패턴을 적용할 수 있다.

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

이 코드에서 하위 클래스는 중복되지 않는 정보만을 제공해서 accureVacation() 메서드에서 빠진 구멍을 메운다.

표현하라

아마 우리 대다수는 엉망인 코드를 접한 경험이 있으리라. 자신이 이해하는 코드를 짜기는 쉽다.

 

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

 

그러므로 코드는 개발자의 의도를 분명히 표현해야 한다. 개발자가 코드를 명백하게 짤수록 다른 사람이 그 코드를 이해하기 쉬워진다. 그래야 결함이 줄어들고 유지보수 비용이 적게 든다. 다음의 규칙은 코드를 표현하기 위한 방법이다.

• 좋은 이름을 선택한다. 이름과 기능이 완전히 딴판인 클래스나 함수로 개발자를 놀라게 해서는 안 된다.
• 함수와 클래스 크기를 가능한 줄인다. 작은 클래스와 작은 함수는 이름 짓기도 쉽고, 구현하기도 쉽고, 이해하기도 쉽다.
• 표준 명칭을 사용한다. 예를 들어, 디자인 패턴은 의사소통과 표현력 강화가 주요 목적이다. 클래스가 COMMAND나 VISITOR와 같은 표준 패턴을 사용해 구현된다면 클래스 이름에 패턴 이름을 넣어준다. 그러면 다른 개발자가 클래스 설계 의도를 이해하기 쉬워진다.
• 넷째, 단위 테스트 케이스를 꼼꼼히 작성한다. 테스트 케이스는 소위 '예제로 보여주는 문서'다. 다시 말해, 잘 만든 테스트 케이스를 읽어보면 클래스 기능이 한눈에 들어온다.

하지만 표현력을 높이는 가장 중요한 방법은 노력이다. 흔히 코드만 돌린 후 다음 문제로 직행하는 사례가 너무도 흔하다. 나중에 읽을 사람을 고려해 조금이라도 읽기 쉽게 만드려는 충분한 고민은 거의 찾기 어렵다. 하지만 나중에 코드를 읽을 사람은 바로 자신일 가능성이 높다는 사실을 명심하자.

 

그러므로 자신의 작품을 조금 더 자랑하자. 함수와 클래스에 조금 더 시간을 투자하자. 더 나은 이름을 선택하고, 큰 함수를 작은 함수 여럿으로 나누고, 자신의 작품에 조금만 더 주의를 기울이자. 주의는 대단한 재능이다.

 

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

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

 

그래서 이 규칙은 함수와 클래스 수를 가능한 한 줄이라고 제안한다. 때로는 무의미하고 독단적인 정책 탓에 클래스 수와 메서드 수가 늘어나기도 한다. 클래스마다 무조건 인터페이스를 생성하라고 요구하는 구현 표준이 좋은 예다. 자료 클래스와 동작 클래스는 무조건 분리해야 한다고 주장하는 개발자도 좋은 예다. 가능한 독단적인 견해는 멀리하고 실용적인 방식을 택해야 한다.

 

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

 

---

Reference

• https://nesoy.github.io/articles/2018-03/CleanCode-Emergence
• https://github.com/Yooii-Studios/Clean-Code/blob/master/Chapter%2012%20-%20%EC%B0%BD%EB%B0%9C%EC%84%B1.md