Skip to content

12 창발성.md

Latest commit

 

History

History
322 lines (253 loc) · 15.5 KB

12 창발성.md

File metadata and controls

322 lines (253 loc) · 15.5 KB
Raw

들어가면서

창발성 : 생각의 떠오름
창발적 설계로 깔끔한 코드를 구현하자

  • 착실하게 따르기만 하면 우수한 설계가 나오는 간단한 규칙 4가지가 있다면?
  • 4가지 규칙을 따르면 코드 그조와 설계를 파악하기 쉬워진다면?
  • 그래서 SRP나 DIP 같은 원칙을 적용하기 쉬워진다면?
  • 4가지 규칙이 우수한 설계의 창발성을 촉진한다면?

켄트 백이 제시한 단순한 설계 규칙 4가지가 소프트웨어의 설계 품질을 크게 높여준다.
켄트 백은 다음 규칙을 따르면 설계는 단순하다고 말한다.

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

모든 테스트를 실행하라

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

모든 테스트 케이스를 통과하지 못하는 시스템은 절대 출시하면 안된다.
다행스럽게도 모든 테스트 케이스를 통과하는 시스템을 만들려고 애쓰면
크기가 작고 목적 하나만 수행하는 클래스가 나오듯, 설계 품질이 더불어 좋아진다.

SRP를 준수하는 클래스는 다른 클래스에 비해 테스트가 훨씬 쉽다.
SRP를 준수하도록 클래스를 작성하면 작은 단위마다 테스트 케이스가 생성되고
테스트 케이스가 많을수록 개발자는 쉬운 테스트 코드를 작성할 수 있다.
따라서 철저한 테스트가 가능한 시스템을 만들면 더 나은 설계가 얻어진다.

결합도가 높으면 정밀한 테스트 케이스를 작성하기 어렵다.
그러므로 테스트 케이스를 많이 작성한다면, DIP와 같은 원칙을 적용하고
의존성 주입(DI), 인터페이스, 추상화와 같은 도구를 사용해 결합도를 낮춰야한다.
그리고 결합도가 낮아졌기에 설계 품질은 더욱 높아진다.

리팩터링

테스트 케이스를 모두 작성했다면, 코드와 클래스를 정리하자
구체적으로는 코드를 점진적으로 리팩터링 해나간다.

코드 몇 줄을 추가할 때마다 잠시 멈추고 현재 설계를 바라본다.

  • 새로 추가하는 코드가 품질을 낮추었는가?

새로 추가하는 코드가 품질을 낮추었다면, 깔끔히 정리한 후
테스트 케이스를 돌려 기존 기능을 깨뜨리지 않았다는 사실을 확인하면 된다.

그러므로
코드를 리팩토링하면서 시스템이 깨질까 걱정할 필요가 없다.
우리는 테스트 케이스를 통해 지속적으로 설계를 확인하면 된다.

여기서 아주 중요한 내용이 있는 것 같아서 기술해본다.!      

리팩토링을 하면서도 테스트 케이스로 지속적으로 설계를 피드백한다고 했다.      
그렇기에, 리팩토링 과정에서도 기존 테스트 케이스가 완벽히 호환되도록 해야한다.      
      
테스트 코드는 작은 모듈들을 테스트하도록 여러 테스트 케이스로 나뉘었다.       
그렇기에 우리는 테스트 코드에 맞게, 작고 결합도를 낮게 만들려고 할 것이다.     
결과적으로 테스트 케이스 덕분에? 우리는 좋은 코드를 짤 수 있게 되는 것이다.   
  
이것이 앞서 말한 테스트 코드를 통해 품질이 좋아지는 것을 의미하며,       
TDD(Test-Driven-Develop)를 사용하는 이유이다.
  • 응집도를 높인다
  • 결합도를 낮춘다
  • 관심사를 분리한다
  • 시스템 관심사를 모듈로 나눈다
  • 함수와 클래스의 크기를 줄인다
  • 더 나은 이름을 선택한다.

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

  • 중복을 제거
  • 프로그래머의 의도를 표현
  • 클래스와 메서드 수를 최소로 줄인다.

또한, 리팩터링 단계는 단순한 설계 규칙에서 테스트를 제외한 3가지를 적용하는 단계이다.

중복을 없애라

중복은 우수한 설계에게 있어 커다란 적이다.
중복은 추가 작업, 추가 위험, 불필요한 복잡도를 뜻하기 때문이다.

똑같은 코드, 비슷한 코드, 구현 중복도 중복의 한 형태이다.

int size() {}
boolean isEmpty{}

위와 같은 메서드가 존재한다고 가정한다.

int size() {
   // 사이즈의 갯수를 얻어서 이를 리턴하는 로직
}
boolean isEmpty{
    // 사이즈의 갯수가 0인지 확인 후 boolean 타입을 리턴하는 로직
}

각 메서드마다 반환 값이 다르므로 고유의 로직을 갖도록 처리해줘도 된다.

int size() {
   // 사이즈의 갯수를 얻어서 이를 리턴하는 로직
}
boolean isEmpty{
    return 0 == size();   
}

하지만, isEmpty() 메서드에서 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 * 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;
}

replaceImage()를 새롭게 정의하면서 리팩토링했다.
아주 적은 양이지만 공통적인 코드를 새 메서드로 뽑고 보니 클래스가 SRP를 위반한다.
그러므로 새로 만든 replaceImage()를 다른 클래스로 옮겨도 좋겠다.
그러면 기존 클래스의 SRP를 지키는 것은 물론,
새 메서드도 알맞는 클래스에 들어가 있으므로 가시성이 높아진다.

또한, 다른 팀원이 새 메서드를 좀 더 추상화해
다른 맥락에서 재사용할 기회를 포착할지도 모른다.

여기서 우리가 생각할 수 있는 중요한 점은             
중복을 제거하면 클래스를 분리할 수 있는지가 눈에 보이게 된다.        
즉, 관점이 명확히 드러나게 되어 더 좋은 코드를 작성하도록 유도한다.

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

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

중복이 존재하는 코드

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

최소 법정 일수를 계산하는 코드만 제외하면 두 메서드는 거의 동일하다.
최소 법정 일수르 계산하는 알고리즘은 직원 유형에 따라 살짝 바뀐다.

여기에 TEMPLATE METHOD 패턴을 적용해 눈에 들어온 중복을 제거한다.

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

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

즉, 전체적인 프로세스에 맞춰 코드가 실행되지만,
각 구현 클래스마다의 특성에 맞게 alterForLegalMinimums() 오버라이딩해서,
해당 부분의 내용만 클래스마다 다르게 표현할 수 있다.

표현하라

개발자인 우리들 대다수는 엉망인 코드를 접하고 내놓은 경험이 있을 것이다.
자신만 이해하는 코드는 작성하기 쉽다.
하지만, 유지보수할 사람이 코드를 작성한 사람만큼 코드를 이해하기는 힘들다.

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

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

코드에 의도를 표현하는 방법

  1. 좋은 이름을 선택한다. :
    이름과 기능이 완전히 딴판인 클래스나 함수로
    유지보수 담당자를 당황하게 해서는 안 된다.

  2. 함수와 클래스 크기를 가능한 줄인다. :
    작은 클래스와 작은 함수는 이름 짓기도 쉽고,
    구현하기도 쉽고, 이해하기도 쉽다.

  3. 표준 명칭을 사용한다. : 예를 들어, 디자인 패턴은 의사소통고 표현력 강화가 주요 목적이다.
    클래스가 COMMAND나 VISITOR와 같은 표준 패턴을 사용해 구현된다면
    클래스 이름에 패턴 이름을 넣어준다.
    그러면, 다른 개발자가 클래스 설계 의도를 이해하기 쉬워진다.

  4. 단위 테스트를 꼼꼼히 작성한다 :
    테스트 케이스는 소위 '예제로 보여주는 문서'다.
    다시 말해, 잘 만든 테스트 케이스를 읽어보면 클래스 기능이 한눈에 들어온다.

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

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

주의는 대다한 재능이다.

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

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

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

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

그러므로, 3가지 규칙을 먼저 지키면서 크기를 최소로 줄이는 규칙을 실행하자.

결론

경험을 대신할 단순한 개발 기법은 없다.
하지만, 클린 코드의 내용은 여러 개발자들이 수 십년 동안 쌓은 경험의 정수다.
켄트 백의 단순한 설계 기법을 따른다면 우수한 기법과 원칙을 단번에 활용할 수 있다.