시스템

Hant·2021년 11월 23일
0

Clean Code

목록 보기
10/13
post-thumbnail
post-custom-banner

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

우선 제작사용과 아주 다르다는 사실을 명심합니다. 소프트웨어 시스템은 애플리케이션 객체를 제작하고 의존성을 서로 연결하는 준비 과정과 이후에 이어지는 런타임 로직을 분리해야 합니다. 시작 단계는 모든 애플리케이션이 풀어야 할 관심사입니다. 다음은 초기화 지연(Lazy Initialization)혹은 계산 지연(Lazy Evaluation)이라는 기법입니다.

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

장점

  • 실제로 필요할 때까지 객체를 생성하지 않으므로 불필요한 부하가 걸리지 않습니다. 따라서 애플리케이션을 시작하는 시간이 그만큼 빨라집니다.
  • 어느 경우에도 null 포인터를 반환하지 않습니다.

단점

  • getService 메서드가 MyServiceImpl과 생성자 인수에 명시적으로 의존합니다.
  • MyServiceImpl이 무거운 객체라면 단위 테스트에서 getService 메서드를 호출하기 전에 적절한 테스트 전용 객체(TEST DOUBLE이나 MOCK OBJECT)를 service 필드에 할당해야 합니다.
  • 작게나마 단일 책임 원칙(Single Responsibility Principle, SRP)을 깹니다(servicenull인 경로와 null이 아닌 경로 등).
  • MyServiceImpl이 모든 상황에 적합한 객체인지 모릅니다. 현실적으로 한 객체 유형이 모든 문맥에 적합할 가능성이 있을까?

체계적이고 탄탄한 시스템을 만들고 싶다면 흔히 쓰는 좀스럽고 손쉬운 기법으로 모듈성을 깨서는 절대로 안 됩니다. 객체를 생성하거나 의존성을 연결할 때도 마찬가지입니다. 설정 논리는 일반 실행 논리와 분리해야 모듈성이 높아집니다. 또한 주요 의존성을 해소하기 위한 방식, 즉 전반적이며 일관적인 방식도 필요합니다.

1.1. Main 분리

시스템 생성과 시스템 사용을 분리하는 한 가지 방법으로, 생성과 관련한 코드는 모두 main이나 main이 호출하는 모듈로 옮기고, 나머지 시스템은 모든 객체가 생성되었고 모든 의존성이 연결되었다고 가정합니다. 제어 흐름은 따라가기 쉽습니다. main 함수에서 시스템에 필요한 객체를 생성한 후 이를 애플리케이션에 넘깁니다. 애플리케이션은 그저 객체를 사용할 뿐입니다.

1.2. 팩토리

물론 때로는 객체가 생성되는 시점을 애플리케이션이 결정할 필요도 생깁니다. 예를 들어, 주문처리 시스템에서 애플리케이션은 LineItem 인스턴스를 생성해 Order에 추가합니다. 이때는 ABSTRACT FACTORY 패턴을 사용합니다. 그러면 LineItem을 생성하는 시점은 애플리케이션이 결정하지만 LineItem을 생성하는 코드는 애플리케이션이 모릅니다.

1.3. 의존성 주입

사용과 제작을 분리하는 강력한 메커니즘 하나가 의존성 주입(Dependency Injection, DI)입니다. 의존성 주입은 제어 역전(Inversion of Control, IoC) 기법을 의존성 관리에 적용한 메커니즘입니다. 제어 역전에서는 한 객체가 맡은 보조 책임을 새로운 객체에게 전적으로 떠넘깁니다. 새로운 객체는 넘겨받은 책임만 맡으므로 단일 책임 원칙(Single Responsibility Principle, SRP)을 지키게 됩니다. 책임을 다른 전담 메커니즘에 넘김으로써 제어를 역전합니다. 초기 설정은 시스템 전체에서 필요하므로 대개 책임질 메커니즘으로 main 루틴이나 특수 컨테이너를 사용합니다.

this.myService = jndiContext.lookup("NameOfMyService") as MyService;

위 코드에서 호출하는 객체 (반환되는 객체가 적절한 인터페이스를 구현하는 한) 실제로 반환되는 객체의 유형을 제어하지 않습니다. 대신 호출하는 객체는 의존성을 능동적으로 해결합니다.

진정한 의존성 주입은 여기서 한 걸음 더 나갑니다. 클래스가 의존성을 해결하려 시도하지 않습니다. 클래스는 완전히 수동적입니다. 대신에 의존성을 주입하는 방법으로 설정자(Setter) 메서드나 생성자 인수를 (혹은 둘 다를) 제공합니다. DI 컨테이너는 (대개 요청이 들어올 때마다) 필요한 객체의 인스턴스를 만든 후 생성자 인수나 설정자 메서드를 사용해 의존성을 설정합니다. 실제로 생성되는 객체 유형은 설정 파일에서 지정하거나 특수 생성 모듈에서 코드로 명시합니다.

그러나 초기화 지연으로 얻는 장점은 포기해야 하는 걸까요? 이 기법은 DI를 사용하더라도 때론 여전히 유용합니다. 먼저 대다수 DI 컨테이너는 필요할 때까지 객체를 생성하지 않고, 대부분은 계산 지연이나 비슷한 최적화에 쓸 수 있도록 팩터리를 호출하거나 프록시를 생성하는 방법을 제공합니다. 즉, 계산 지연 기법이나 이와 유사한 최적화 기법에서 이런 메커니즘을 사용할 수 있습니다.

2. 확장

처음부터 올바르게 시스템을 만들 수 있다는 믿음은 미신입니다. 대신에 우리는 오늘 주어진 사용자 스토리에 맞춰 시스템을 구현해야 합니다. 내일은 새로운 스토리에 맞춰 시스템을 조정하고 확장하면 됩니다. 이것이 반복적이고 점진적인 애자일 방식의 핵심입니다. 테스트 주도 개발(Test-driven Development, TDD), 리펙터링, 깨긋한 코드는 코드 수준에서 시스템을 조정하고 확장하기 쉽게 만듭니다.

비즈니스 논리가 덩치 큰 컨테이너와 밀접하게 결합되면 독자적인 단위 테스트가 어려워집니다. 결국 재사용이 사실상 불가능해지고, 객체 지향 프로그래밍이라는 개념조차 뿌리가 흔들립니다.

2.1. 횡단(Cross-cutting) 관심사

영속성과 같은 관심사는 애플리케이션의 자연스러운 객체 경계를 넘나드는 경향이 있습니다. 모든 객체가 전반적으로 동일한 방식을 이용하게 만들어야 합니다. 예를 들어, 특정 DBMS나 독자적인 파일을 사용하고, 테이블과 열은 같은 명명 관례를 따르며, 트랜잭션 의미가 일관적이면 더욱 바람직합니다.

영속성이란, 한 객체가 자신을 생성한 작업이 종료되었음에도 불구하고 지속적으로 존재하는 상태를 말한다.

원론적으로는 모듈화되고 캡슐화된 방식으로 관심사를 구상할 수 있습니다. 하지만 현실적으로는 구현한 코드가 온갖 객체로 흩어집니다. 영속성 프레임워크 또한 모듈화 할 수 있습니다. 도메인 논리도 (독자적으로) 모듈화 할 수 있습니다. 문제는 이 두 영역이 세밀한 단위로 겹친다는 점입니다.

관심 지향 프로그래밍(Aspect-Oriented Programming, AOP)는 횡단 관심사에 대처해 모듈성을 확보하는 일반적인 방법론입니다. AOP에서 관점이라는 모듈 구성 개념은 특정 관심사를 지원하려면 시스템에서 특정 지점들이 동작하는 방식을 일관성 있게 바꿔야 한다라고 명시합니다. 명시는 간결한 선언이나 프로그래밍 메커니즘으로 수행합니다.

영속성을 예로 들면, 프로그래머는 영속적으로 저장할 객체와 속성을 선언한 후 영속성 책임을 영속성 프레임워크에 위임합니다. 그러면 AOP 프레임워크는 대상 코드에 영향을 미치지 않는 상태로 동작 방식을 변경합니다.

3. 프록시

프록시는 단순한 상황에 적합합니다. 개별 객체나 클래스에서 매서드 호출을 감싸는 경우가 좋은 예입니다.

책 원문에는 Java JDK에서 제공하는 Proxy.newProxyInstance를 사용해 예제를 제공합니다. Typescript의 Proxy 객체를 사용해 최대한 비슷하게 흉내를 내봤지만 상당한 차이가 있을 것으로 생각됩니다.

interface Bank {
  getAccounts(): Account[];
  setAccounts(accounts: Account[]): void;
}

class BankImpl implements Bank {
  private accounts: Account[] = [];

  getAccounts() {
    return this.accounts;
  }

  setAccounts(accounts: Account[]) {
    this.accounts = [...accounts];
  }
}

class BankProxyHandler implements ProxyHandler<Bank> {
  get(target: Bank, key: string, receiver: BankProxyHandler) {
    if (key === "getAccounts") {
      return () => {
        Reflect.set(target, key, getAccountsFromDatabase(), receiver);
        return Reflect.get(target, key, receiver);
      };
    } else if (key === "setAccounts") {
      return (...args: Account[]) => {
        Reflect.set(target, key, args, receiver);
        setAccountsToDatabase(args);
      };
    }

    return Reflect.get(target, key, receiver);
  }
}

const bank: Bank = new Proxy<Bank>(new BankImpl(), new BankProxyHandler());

단순한 예제지만 코드가 상당히 많으며 제법 복잡합니다. 코드 과 크기는 프록시의 두 가지 단점입니다. 다시 말해서, 프록시를 사용하면 깨끗한 코드를 작성하기 어렵습니다.

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

관점으로 (혹은 유사한 개념으로) 관심사를 분리하는 방식은 그 위력이 막강합니다. 코드 수준에서 아키텍처 관심사를 분리할 수 있다면, 진정한 테스트 주도 아키텍처 구축이 가능해집니다. 그때그때 새로운 기술을 채택해 단순한 아키텍처를 복잡한 아키텍처로 키워갈 수도 있습니다. BDUF(Big Design Up Front)를 추구할 필요가 없습니다. 실제로 BDUF는 해롭기까지 합니다. 처음에 쏟아 부은 노력을 버리지 않으려는 심리적 저항으로 인해, 그리고 처음 선택한 아키텍처가 향후 사고 방식에 미치는 영향으로 인해, 변경을 쉽사리 수용하지 못하는 탓입니다.

그렇다고 아무런 방향 없이 프로젝트에 뛰어들어도 좋다는 소리는 아닙니다. 프로젝트르 시작할 때는 일반적인 범위, 목표 일정은 물론이고 결과를 내놓을 시스템의 일반적인 구조도 생각해야 합니다. 아주 단순하면서도 멋지게 분리된 아키텍처로 소프트웨어 프로젝트를 진행해 결과물을 재빨리 출시한 후, 기반 구조를 추가하며 조금씩 확장해 나가도 괜찮다는 말입니다.

5. 의사 결정을 최적화하라

모듈을 나누고 관심사를 분리하면 지엽적인 관리와 결정이 가능해집니다. 우리는 때때로 가능한 마지막 순간까지 결정을 미루는 방법이 최선이라는 사실을 까먹곤 합니다. 최대한 정보를 모아 최선의 결정을 내리기 위해서입니다. 관심사 모듈로 분리한 시스템은 기민함을 제공합니다. 이런 기민한 덕택에 최신 정보에 기반해 최선의 시점에 최적의 결정을 내리기가 쉬워집니다. 또한 결정의 복잡성도 줄어듭니다.

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

가볍고 간단한 설계로 충분했을 프로젝트에서도 프레임워크를 채택하는 경우가 있습니다. 아주 과장되게 포장된 표준에 집착하는 바람에 고객 가치가 뒷전으로 밀려난 사례입니다.

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

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

소프트웨어 분야세서 최근 들어 DSL(Domain-Specific Language)이 새롭게 조명 받기 시작했스니다. DSL은 간단한 스크립트 언어나 표준 언어로 구현한 API를 가리킵니다. 좋은 DSL은 도메인 개념과 그 개념을 구현한 코드 사이에 존재하는 의사소통 간극을 줄여줍니다. 애자일 기법이 팀과프로젝트 사이에 의사소통 간극을 줄여주듯 말입니다. 도메인 전문가가 사용하는 언어로 도메인 논리를 구현하면 도메인을 잘못 구현한 가능성이 줄어듭니다.

효과적으로 사용한다면 DSL은 추상화 수준을 코드 관용구나 디자인 패턴 이상으로 끌어올립니다. 그래서 개발자가 적절한 추상화 수준에서 코드 의도를 표현할 수 있습니다.

8. 출처

  • 제목: 클린 코드 - 애자일 소프트웨어 장인 정신
  • 저자: 로버트 C.마틴
  • 옮긴이: 박재호, 이해영
  • 출판사: 인사이트
profile
끊임없이 도전하는 프론트 개발자가 되고자 노력합니다.
post-custom-banner

0개의 댓글