[클린코드(CleanCode)] 11장 시스템

개요

“복잡성은 죽음이다. 개발에게서 생기를 앗아가며, 제품을 계획하고 기획하고
제작하고 테스트하기 어렵게 만든다.” - 레이오지, 마이크로소프트 최고 기술 책임자

---

도시를 세운다면?

도시를 혼자서 건설하고 관리하는 건 불가능할 것이다.

도시가 잘 돌아가는 이유는 수도 관리팀, 전력 관리팀 등 각 분야를 관리하는 팀이 있기 때문이다.

 

도시가 잘 돌아가는 또 다른 이유는 적절한 추상화와 모듈화 때문이다.

그래서 큰 그림을 이해하지 못할지라도 개인과 개인이 관리하는 '구성요소'는 효율적으로 돌아간다.

 

소프트웨어 또한 이와 비슷한데 도시만큼이나 추상화를 이루어내지 못하는 경우가 많다.

이번 장에서는 높은 추상화 수준, 즉 시스템 수준에서도 깨끗함을 유지하는 방법을 살펴본다.

---

시스템 제작과 시스템 사용을 분리하라

우선 제작과 사용은 아주 다르다는 사실을 명심하라.

소프트웨어 시스템은 (애플리케이션 객체를 제작하고 의존성을 서로 연결하는) 준비과정과 (준비 과정 이후에 이어지는) 런타임 로직을 분리해야 한다.

 

시작 단계는 모든 어플리케이션이 풀어야 할 관심사다.

관심사 분리는 우리 분야에서 가장 오래되고 가장 중요한 설계 기법 중 하나다.

 

아래 코드는 준비 과정 코드를 주먹구구식으로 구현할 뿐만 아니라 런타임 로직과 마구 뒤섞여 놓은 전형적인 예이다.

public Service getService() {
  if (service == null)
      service = new MyServiceImpl(...); // 모든 상황에 적합한 기본값일까?
  return service;
}

이것이 초기화 지연(Lazy Initialization) 혹은 계산 지연(Lazy Rvaluation)이라는 기법이다.

• 장점
  • 필요할 때까지 객체 생성을 미루므로 불필요한 부하가 걸리지 않는다. (앱 시작 시간이 빨라짐)
  • 어떤 경우에도 null 포인트를 반환하지 않는다.
• 단점
  • getService 메서드가 MyServiceImpl과 생성자 인수(위에서 생략함)에 명시적으로 의존한다.
  • 만약 MyServiceImpl이 무거운 객체라면 테스트를 위한 Test Double / Mock Object를 service 필드에 할당해야한다.
  • 일반 런타임 로직에다 객체 생성 로직을 섞어놓은 탓에 모든 실행 경로도 테스트해야 한다.

초기화 지연 기법을 한 번 정도 사용한다면 별로 심각한 문제가 아니다.

하지만 많은 애플리케이션이 수시로 사용한다.

모듈성은 저조하며 대게 중복이 심하다.

 

체계적이고 탄탄한 시스템을 만들고 싶다면 이런 기법으로 모듈성을 깨서는 절대로 안 된다.

객체를 생성하거나 의존성을 연결할 때도 마찬가지다.

설정 논리는 일반 실행 논리와 분리해야 모듈성이 높아진다.

또한 주요 의존성을 해소하기 위한 방식, 즉 전반적이며 일관적인 방식도 필요하다.

 

사용과 제작을 분리하는 3가지 방법

• main 분리
• 팩토리
• 의존성 주입

Main 분리

생성과 관련된 모든 코드는 main이나 main이 호출하는 모듈로 옮기고 나머지 시스템은 모든 객체가 생성되었고 모든 의존성이 연결되었다고 가정한다.

어플리케이션에서는 사용할 모든 객체들이 main에서 잘 생성되었을 것이라 여기고 나머지 디자인에 집중할 수 있다.

팩토리 기법

객체의 생성 시기를 어플리케이션이 결정하려면 main에서 완성된 객체를 던져주기 보다 factory 객체를 만들어서 던져주자.
Abstract Factory 패턴을 사용하면 생성 코드를 감출 수 있다.

Abstract Factory:
구체적인 클래스에 의존하지 않고 서로 연관되거나 의존적인 객체들의 조합을 만드는 인터페이스를 제공하는 패턴
다양한 구성 요소 별로 '객체의 집합'을 생성해야 할 때 유용하다.
이 패턴을 사용하여 상황에 알맞은 객체를 생성할 수 있다.

의존성 주입

사용과 제작을 분리하는 강력한 메커니즘이다.

의존성 주입은 제어 역전(Inversion of Control, IoC) 기법을 의존성 관리에 적용한 메커니즘이다.

제어 역전에서는 한 객체가 맡은 보조 책임을 새로운 객체에게 전적으로 떠넘긴다.

새로운 객체는 넘겨받은 책임만 맡으러 단일 책임 원칙을 지키게 된다.

 

진정한 의존성 주입은 한 단계 더 나아가 완전히 수동적인 형태를 지닌다.

대신 의존성을 주입하는 방법으로 설정자 메서드나 생성자 인수를 제공한다.

생성자 인수나 설정자 메서드를 통해 DI 컨테이너가 해당 의존성을 해결하도록 도와준다.

---

확장

촌락은 마을로, 마을은 도시로 성장한다. 

하지만 누가 마을의 성장을 고려해 6차선을 미리 뚫는 게 가능할까?

처음부터 올바르게 시스템을 만들 수 있다는 믿음은 미신일 뿐이다. 

대신에 우리는 오늘 주어진 사용자 스토리에 맞춰 시스템을 구현해야 한다.

이것이 점진적인 애자일 방식의 핵심이다.

테스트 기반 개발, 리펙토링, 깨끗한 코드는 코드 수준에서 시스템을 조정하고 확장하기 휩게 만든다.

 

시스템 수준에서는 어떨까?

소프트웨어 시스템은 물리적인 시스템과 다르다.
관심사를 적절히 분리해 관리한다면 S/W 아키텍처는 점진적으로 발전할수 있다.

소프트웨어 시스템은 '수명이 짧다'는 본질로 인해 아키텍처의 점진적인 발전이 가능하다.

횡단(cross-cutting) 관심사

횡단 관심사:
애플리케이션의 핵심 로직과는 별개로 여러 모듈에서 공통적으로 발생하는 기능. 여러 메서드에서 로깅을 수행해야 한다면 각 메서드마다 로깅 코드를 중복해서 작성해야한다. 이런 경우, 횡단 관심사를 분리하여 모듈화할 수 있으면 코드 중복을 줄이고 유지보수성을 향상시킬 수 있다.

AOP(aspect-oriented programming)는 횡단 관심사에 대처해 모듈성을 확보하는 일반적인 방법론이다.

AOP에서 관점이라는 모듈 구성 개념은 "특정 관심사를 지원하려면 시스템에서 특정 지점들이 동작하는 방식을 일관성 있게 바꿔야 한다"라고 명시한다.

명시는 간결한 선언이나 프로그래밍 메커니즘으로 수행한다.

 

자바에서 사용하는 관점 or 관점과 유사한 메커니즘 3가지

1. 자바 프록시
2. 순수 자바 AOP 프레임워크
3. AspectJ 관점

---

자바 프록시

자바 프록시는 단순한 상황에 적합하다.

개별 객체나 클래스에서 메서드 호출을 감싸는 경우가 좋은 예다.

 

그러나 프록시는 코드 양과 크기가 많다는 단점이 있다.

다시 말해서, 프록시를 사용하면 깨끗한 코드를 작성하기 어렵다.

또한 프록시는 (진정한 AOP 해법에 필요한) 시스템 단위로 실행 '지점을 명시하는 메커니즘도 제공하지 않는다.

---

순수 자바 AOP 프레임워크

대부분의 프록시 코드는 비슷해서 도구로 자동화할 수 있다.

순수 자바 관점을 구현하는 스프링 AOP, JBoss AOP와 등과 같은 여러 자바 프레임워크는 내부적으로 프록시를 사용한다.

스프링은 비즈니스 논리를 POJO로 구현한다.

따라서 테스트가 개념적으로 더 쉽고 간단하다.

 

프로그래머는 설정 파일이나 API를 사용해 필수적인 애플리케이션 기반 구조를 구현한다.

여기에 영속성, 트랜잭션, 보안, 캐시, 장애 조치 등과 같은 횡단 관심사 포함된다.

---

AspectJ 관점

관심사를 관점으로 분리하는 가장 강력한 도구는 AspectJ 언어다.

AspectJ는 언어 차원에서 관점을 모듈화 구성으로 지원하는 자바 언어 확장이다.

 

그러나 새 도구를 사용하고 새 언어 문법과 사용법을 익혀야 한다는 단점이 있다.

---

테스트 주도 시스템 아키텍처 구축

코드 수준에서 아키텍처 관심사를 분리할 수 있다면, 진정한 테스트 주도 아키텍처 구축이 가능해진다.

 

'아주 단순하면서'도 멋지게 분리된 아키텍처로 소프트웨어 프로젝트를 진행해 결과물을 재빨리 출시한 후,

기반 구조를 추가하며 조금씩 확장해나가도 괜찮다.

 

그렇다고 '아무 방향 없이' 프로젝트에 뛰어들어도 좋다는 뜻은 아니다.

프로젝트를 시작할 때는 일반적인 범위, 목표, 일정은 물론이고 결과로 내놓을 시스템의 일반적인 구조도 생각해야 한다.

하지만 변하는 환경에 대처해 진로를 변경할 능력도 반드시 유지해야 한다.

 

지금까지 한 이야기를 요약하면 다음과 같다.

최선의 시스템 구조는 각기 POJO(또는 다른) 객체로 구현되는 모듈화된 관심사 영역(도메인)으로 구성된다.
이렇게 서로 다른 영역은 해당 영역 코드에 최소한의 영향을 미치는 관점이나 유사한 도구를 사용해 통합한다.
이런 구조 역시 코드와 마찬가지로 테스트 주고 기법을 적용할 수 있다.

---

의사 결정을 최적화 하라

우리는 때때로 가능한 마지막 순간까지 결정을 미루는 방법이 최선이라는 사실을 까먹곤 한다.

게으르거나 무책임해서가 아니다

최대한 정보를 모아 최선의 결정을 내리기 위해서이다.

성급한 결정은 불충분한 지식으로 내린 결정이다.

고객 피드백을 모으고 더 고민하고, 구현 방안을 더 탐험한 후에 결정해도 된다.

관심사를 모듈로 분리한 POJO 시스템은 기민함을 제공한다. 이런 기민함 덕택에 최신 정보에 기반해
최선의 시점에 최적의 결정을 내리기가 쉬워진다. 또한 결정의 복잡성도 줄어든다.

---

명백한 가치가 있을 때 표준을 현명하게 사용하라

아주 과장되게 포장된 표준에 집착하는 바람에 고객 가치가 뒷전으로 밀려난 사례도 많이 있다.

표준을 사용하면 아이디어와 컴포넌트를 재사용하기 쉽고 적절한 경험을 가진 사람을 구하기 쉬우며,
좋은 아이디어를 캡슐화하기 쉽고, 컴포넌트를 엮기 쉽다. 하지만 때로는 표준을 만드는 시간이 너무 오래 걸려 업계가 기다리지 못한다.
어떤 표준은 원래 표준을 재정한 목적을 잊어버리기도 한다.

---

시스템은 도메인 특화 언어가 필요하다

대다수 도메인과 마찬가지로, 건축 분야 역시 필수적인 정보를 명료하고 정확하게 전달하는 어휘, 관용구, 패턴이 풍부하다. 

소프트웨어 분야에서도 최근 들어 DSL(Domain Specific Language)이 새롭게 조명 받기 시작했다.

DSL은 간단한 스크립트 언어나 표준 언어로 구현한 API를 가리킨다.

DSL로 짠 코드는 도메인 전문가가 작성한 구조적인 산문처럼 읽힌다.

 

좋은 DSL은 도메인 개념과 그 개념을 구현한 코드 사이에 존재하는 "의사소통 간극"을 줄여준다.

 

효과적으로 사용한다면 DSL은 추상화 수준을 코드 관용구나 디자인 패턴 이상으로 끌어올린다.

그래서 개발자가 적절한 추상화 수준에서 코드 의도를 표현할 수 있다.

도메인 특화 언어(Domail-Specific Language)를 사용하면 고차원 정책에서 저차원 세부사항에
이르기까지 모든 추상화 수준과 모든 도메인을 POJO로 표현할 수 있다.

---

결론

시스템 역시 깨끗해야 한다.

깨끗하지 못한 아키텍처는 도메인 논리를 흐리며 기민성을 떨어뜨리고 제품 품질도 떨어진다.

버그가 숨어들기 쉬워지고 스토리를 구현하기 어려워지는 탓이다.

기민성이 떨어지면 생산성이 낮아져 TDD가 제공하는 장점이 사라진다.

 

모든 추상화 단계에서 의도는 명확히 표현해야 한다.

그러려면 POJO를 작성하고 각 구현 관심사를 분리해야 한다.

시스템, 개별 모듈을 설계할 땐 실제로 돌아가는 가장 단순한 수단을 사용해야 한다는 사실을 명심하자.

---

글쓴이의 생각

이전 장인 클래스에서도 언급했다시피 하나의 파일에 코드를 길게 쓰는 버릇이 있다.

클래스는 각 책임에 따라 분류하듯 시스템 또한 위의 규칙에 따라 분류를 할 필요가 있을 것 같다.

깨끗하게 시스템을 짜야 나 외에 읽는 사람도 편하고 확장을 하는 데 있어서 큰 오류 없이 구현할 수 있을 것이다.

물론 한 번에 완벽하게 짜는 건 어렵겠지만 계속 고쳐나가며 좋은 시스템을 구현해야겠다.