Clean Code .Part12

이번 주제는 창발성으로 시작한다. 창발성은 단순한 법칙과 반복적인 행위만으로 랜덤 현상에서 벗어나 규칙을 만들어낸다는 현상이다. 

 

창발적 설계를 통해 클린 코드에 다가갈 수 있다고 한다. 켄트 백이 제시한 단순한 설계 규칙 4가지가 소프트웨어 설계 품질을 크게 높여줄 수 있다고 한다. 

 

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

 

모든 테스트를 실행하는 규칙에 대해 알아보자.

 

테스트가 가능한 시스템을 만들려고 애쓰면 설계 품질이 더불어 놓아진다. 테스트를 하기 위해서 결합도를 낮추기 위해 SRP를 준수하는 클래스를 만들기 시작하고 DIP 같은 원칙을 적용하고, DI, 인터페이스, 추상화 등과 같은 도구를 사용한다. 따라서 슬슬 설계 품질은 더욱 높아진다. 

 테스트 케이스를 만들고 계속 실행하는 단순한 규칙을 따르면 결국 시스템은 낮은 결합도와 높은 응집력이라는, 객체 지향 방법론이 지향하는 목표를 저절로 달성한다.

 

테스트 케이스를 모두 작성했다면 이제 코드와 클래스를 정리해도 된다. 구체적으로 코드를 점진적으로 리팩터링 해난간다. 새로 추가하는 코드에 대한 불안감은 테스트 케이스가 지탱해줄 것이다. 리팩터링 단계에서는 중복을 제거하고, 프로그래머 의도를 표현하고, 클래스와 메서드 수를 최소로 줄이는 단계이기도 하다.

 

중복은 추가 작업, 추가 위험, 불필요한 복잡도를 뜻하기 때문이다. 중복은 여러 가지 형태로 표출된다. 

 

중복에 대한 저자의 예시 중 하나는 기존 메서드를 활용해 코드의 중복을 줄이는 예시를 든다.

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

//구현시

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

 

단 몇줄이라도 중복을 제거하겠다는 마인드로 깔끔한 시스템을 점진적으로 만들어 갈 수 있다. 

 

또한 한 책임을 처리하는 클래스를 작성하다 보면 메서드들끼리 중복된 코드가 발생하는 경우가 있다.

 

public class VacationPolicy{

 public void accrueUSDivisionVacation() {
   //휴가 일수 계산
   //..
   //US 최소 법정 일수 만족 확인
   //..
   //휴가 일수를 급여 대장에 적용
 }

 public void accrueEUDivisionVacation() {
   //휴가 일수 계산
   //..
   //유렵연합 최소 법정 일수 만족 확인
   //..
   //휴가 일수를 급여 대장에 적용
 }

}

해당 메서드의 차이는 최소 법정 일수를 계산하는 코드와, 직원 별 휴가 일수 계산하는 알고리즘이다. 

 

이 경우 템플릿 메소드 패턴을 적용한다. 템플릿 메서드 패턴 같은 경우는 고차원의 중복을 제거할 목적으로 자주 사용한다고 한다. 

abstract public class VacationPolicy {

 public void accrueVacation() {
   calculateBaseVacactionHours();
   alterForLegalMinimums();
   applyToPayroll();
 }

 private void calculateBaseVacationHours() {/*...*/};
 abstract protected void alterForLegalMinimums();
 private void applyToPayroll() {/* ... */};
}

 

이제 alterForLegalMinimums메서드는 각 국가의 최소 법정일 수를 사용하도록 각 자식 클래스를 만들어 오버라이드 하여 사용하면 된다. 즉 하위 클래스는 중복되지 않는 정보만 제공해 accrueVacation 알고리즘에서 빠진 구멍만을 메운다.

 

아주 적은 양이지만 공통적인 코드를 새 메서드로 뽑아 사용하려니 SRP를 위반하는 경우 새로 생성된 메서드를 다른 클래스로 옮기면 좋다.

이 경우에 새 메서드의 가시성이 높아지고, 이를 좀 더 추상화해 다른 맥락에서 재사용할 기회를 포착할 수 있다. 

이런 소규모 재사용은 시스템 복잡도를 극적으로 줄여준다. 소규모 재사용을 제대로 익혀야 대규모 재사용이 가능하다. 

 

 표현

 

자신이 이해하는 코드를 작성하는 것은 쉽다. 그 순간 만큼은 푹 빠져 코드 구석구석을 기억하고 이해하기 때문이다. 하지만 나중에 코드를 유지보수할 사람이 코드를 짜는 사람만큼이나 문제를 깊이 이해할 가능성은 희박하다.

 

 잘 생각해보자. 소프트웨어의 개발비용 보단 장기적인 유지비용 보수가 더 큰 비중을 차지한다. 사용자의 요청으로 인해 코드를 변경하기 위해선 결국 유지보수 개발자가 시스템을 제대로 이해해야 한다. 

하지만 시스템이 점진적으로 복잡해지면서 시스템을 이해하기 위한 시간은 점점 늘어나고 동시해 코드를 오해할 가능성도 점점 커진다. 그러므로 코드는 개발자의 의도를 분명히 표현해야 한다.

 

회사의 소프트웨어를 신입, 혹은 이직자가 단숨에 알아내는 것은 불가능하다. 가능할 수도 있지만 그는 해당 분야에서 오래 개발을 해보신 분들 일 것이다. 나도 유지보수에 대한 프로그램을 처음 접했을 때 머리가 멍해지는 경험을 겪었다. 회사가 사용하는 프레임워크는 방대했고 그 일부만을 이해하고 비즈니스 로직을 이해하기 위해 애썼지만 비지니스 로직의 숨은 의도를 알지 못해 선배 개발자에게 수많은 질문을 했기 때문이다.

 

 저자는 코드를 작성할 때 개발자의 의도를 분명히 표현하라고 조언한다. 우선 좋은 이름을 선택한다. 이름과 기능이 완전 딴판인 클래스나 함수는 유지보수 개발자에게 재앙과도 같다.

 

 둘째론 함수와 클래스 크기를 가능한 줄인다. 이는 앞 파트에서도 강조했지만 메서드의 크기와 클래스의 규모이다. 내 경험상 클래스 파일이 많다고 충격받지는 않고 클래스가 적지만 스크롤 양이 클수록 매우 힘들어했다. 

 

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

예를 들어 디자인 패턴은 의사소통과 표현력 강화가 주요 목적이다.

협업이라는 개발과정에서 의사소통은 큰 부분을 차지한다고 생각한다. 누구는 알고 누구는 모르는 용어로 난도질되어 있는 코드는 사람마다 가독성이 좋고 나쁨을 결정짓기 매우 힘들 것이다.  표준 용어를 사용하여 클래스 이름에 패턴을 넣으면 다른 개발자가 클래스 설계 의도를 이해하기 쉬워질 것이다.

 

 넷째, 단위 테스트 케이스를 꼼꼼히 작성한다. 전문 개발자들은 테스트 케이스를 매우 중요하게 생각한다. 테스트를 진행하는 것만 봐도 개발자의 능력을 알 수 있다고 한다.(걱정ㅜ..ㅜ)

잘 만든 테스트 케이스를 읽어보면 클래스의 기능이 한눈에 들어온다. 즉 이 말은 테스트 케이스 안에 클래스가 하는 모든 책임을 테스트했다고 말하는 것 같다.

 

하지만 표현력을 높이는 중요한 방법은 노오오오력이라고?

미래의 개발자를 위해 조금이라도 읽기 쉽게 만들려는 충분한 고민은 매우 중요하다고 말한다. 왜냐 나중에 코드를 읽을 사람은 바로 자신일 것이기 때문이다. ㅋㅋ

 

더 나은 이름을 선택하고, 큰 함수를 작은 함수로 나누고, 고차원 중복을 줄이는 등등 좀 더 자신의 작품에 주의를 기울이라 한다.

 

결론은 매우 현실적이다. 경험을 대신한 개발 기법은 없다고 한다. 그 경험을 나열한 이 책은 내게 소중한 자산이다.