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

착실히 따르면 우수한 설계가 나오는 간단한 규칙 가지.

코드 구조와 설계를 파악하기 쉬워지게 해 준다.

그래서 SRP(Single Responsibility Principle, 단일 책임원칙)나 DIP(Dependency Inversion Principle, 의존관계 역전 원칙)을 적용하기적용하기 쉬워진다.

 

켄트 백이제 시한단순한 설계 규칙 가지 (중요도 )

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

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

모든 테스트 케이스를 항상 통과하는 시스템은 테스트가 가능한 시스템이어야 한다.

테스트가 불가능한 시스템은 검증도 불가능하므로 절대 출시하면 안 된다

 

테스트가 가능한 시스템을 만들려고 애쓰면 설계 품질이 더불어 높아진다.

크기가 작고 목적 하나만 수행하는 클래스가 나온다.

SRP 준수하는 클래스는 테스트가 훨씬 쉽다.

 

결합도가 높으면 테스트 케이스를 작성하기 어렵다.

테스트 케이스를 많이 작성할수록 개발자는 DIP 같은 원칙을 적용하고, DI, 인터페이스, 추상화 등과 같은 도구를 사용해 결합도를 낮춘다.

 

결과적으로 "테스트 케이스를 만들고 계속 돌려라"라는 규칙을 따르면 시스템은 낮은 결합도와 높은 응집력을응집력을 목표로 하는 객체지향 방법론에 가까워진다.가까워진다.

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

단순한 설계 규칙 2~4: 리펙터링

테스트 케이스를 모두 작성했다면 이제 코드와 클래스를 정리한다.

구체적으로는 코드를 점진적으로 리팩터링 해나간다.

코드를 정리하면서 시스템이 깨질까 걱정할 필요가 없다. 테스트 케이스가 있으니까!

 

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

응집도를 높이고, 결합도를 낮추고, 관심사를 분리하고, 시스템 관심사를 모듈로 나누고, 함수와 클래스 크기를 줄이고, 나은 이름을 선택하는 다양한 기법을 동원한다.

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

 

중복을 없애라

중복은 추가 작업, 추가 위험, 불필요한 복잡도를 뜻한다.

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

똑같은 코드는 당연히 중복이고, 구현 중복도 중복의 형태다.

//구현 중복 예시
int size(){구현...}
boolean isEmpty(){구현...}
--------------------------------
//구현 중복 제거 예시
boolean isEmpty(){
	return size() == 0 ;
}

깔끔한 시스템을 만들려면 줄이라도 중복을 제거하겠다는 의지가 필요하다.

작은 중복을 제거하겠다는 것을 무시하면 안 된다.

작은 중복 제거를 할 줄 알아야 큰 중복을 제거할 수 있다.

 

"소규모 재사용" 시스템 복잡도를 극적으로 줄여준다

소규모 재사용을 제대로 익혀야 대규모 재사용이 가능하다.

 

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

표현하라

우리 대다수는 엉망인 코드를 접한 경험이 있으리라.

자신이 이해하는 코드는 짜기 쉽다. 코드를 짜는 동안에는 문제에 빠져 코드를 구석구석 이해하니까

하지만 나중에 코드를 유지 보수할 사람이 코드를 짜는 사람만큼이나 문제를 깊이 이해할 가능성은 희박하다.

 

소프트웨어 프로젝트 비용 대다수는 장기적인 유지보수에 들어간다. 따라서 유지보수 개발자가 시스템을 제대로 파악해야 버그가 스며들지 않는다.

시스템이 점차 복잡해지면 유지보수 개발자가 코드 분석에 보내는 시간은 점점 늘어나 오해할 가능성도 커진다. 그러므로 코드는 개발자의 의도를 분명히 표현해야 한다. 개발자가 코드를 명백하게 수록 다른 사람이 코드를 이해하기 쉽다. 이는 유지보수 비용 절감으로 나타난다.

 

우선, 좋은 이름을 선택하라.

기능과 딴판인 이름을 지으면 안 된다.

 

둘째, 클래스 크기를 가능한 줄여라

이름 짓기도 구현도 이해도 쉬워진다

 

셋째, 표준 명칭을 사용하라.

예를 들어, 패턴을 적용했다면 클래스 이름 뒤에 패턴 이름을 붙인다.

의사소통과 표현력이 강화된다

 

넷째, 단위 테스트 케이스를 꼼꼼히 작성하라

테스트 케이스는 예제로 보여주는 문서와도 같다.

다시 말해 만든 테스트 케이스를 읽어보면 클래스 기능을 이해할 있게 된다

 

마지막으로 가장 중요한 방법은 노력이다.

흔히 코드만 돌린 다음 문제로 직행하는 개발자가 많다.

나중에 읽을 사람을 고려해 조금이라도 노력하지 않는 개발자가 많다.

하지만 나중에 코드를 읽을 사람은 바로 자신일 가능성이 높다는 사실을 명심하자

 

함수와 클래스에 조금 시간을 투자하자.

나은 이름을 선택하고,

함수를 작은 함수 여럿으로 나누고,

자신의 작품에 조금만 주의를 기울이자.

주의는 대단한 재능이다.

 

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

중복 제거, 의도 표현, SRP 준수를 극단적으로극단적으로 지키다 보면 득 보 다실이실이 많아진다.

클래스와 메서드 크기를 줄이자고 조그마한 클래스와 메서드를 수 없이 만드는 사례도 없지 않다.

그래서 규칙은 함수나 클래스 수를 "가능한" 줄이라 것이다.

 

때로는 무의미하고 독단적인 정책 탓에 클래스 수와 메서드 수가 늘어나기도 한다.

클래스마다 무조건 인터페이스를 생성하라고 요구하는 구현 표준이 좋은 예다.

자료 클래스와 동작 클래스는 무조건 분리해야 한다고 주장하는 개발자도 좋은 예다.

가능한 독단적인 견해는 멀리하고 실용적인 방식을 택한다.

 

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

하지만! 규칙은 간단한 설계 규칙 우선순위가 가장 낮다.

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

 

 

결론

경험을 대신할 단순한 개발 기법은 없다. 하지만 책에서 소개한 기법은 저자들의 수십 경험이 녹아있다. 규칙을 따르다 보면 나중에 오랜 경험이 쌓인 기법을 활용할 있을 것이다.

 

 

 

 

 

'IT책, 강의 > 클린코드(Clean Code)' 카테고리의 다른 글

13장 동시성 - 2  (1) 2022.11.12
13장 동시성 - 1  (0) 2022.11.08
11장 시스템  (0) 2022.11.01
10장 클래스  (0) 2022.10.26
9장 단위 테스트  (0) 2022.10.21

+ Recent posts