[Clean Code] 11장 시스템

 

깨끗한 코드를 작성하기 위한 열한번째 기록

깨끗한 코드를 구현하면 낮은 추상화 수준에서 관심사를 분리하기 쉬워집니다.
이 장에서는 높은 추상화 수준, 즉 시스템 수준에서도 개끗함을 유지하는 방법을 살펴보겠습니다.

 

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

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

관심사 분리는 가장 중요한 설계 기법 중 하나로, 많은 사람들은 이 부분을 놓치고 있습니다.

public Service getService(){
    if(service == null)
    	service = new MyServiceImpl();
    return service;
}

다음 코드는 초기화 지연, 또는 계산 지연이라는 기법입니다. 이 코드의 장점은 1) 실제 필요할 때 객체를 생성한다는 점과 2) null 포인터를 반환하지 않는다는 점입니다. 하지만 getService는 생성자의 인수(service)에 명시적으로 의존하고 있습니다. 또한 null일 때와 그렇지 않을 때 두 가지 상황에 대해 처리하기 때문에 단일 책임 원칙을 작게나마 깨고 있습니다.

 

Main 분리

main 함수에서 시스템에 필요한 객체를 생성한 후 이를 애플리케이션에 넘깁니다. 애플리케이션은 그저 객체를 사용할 뿐이고, 애플리케이션은 main이 나 객체가 생성되는 과정을 전혀 모른다는 의미입니다.

 

팩토리

애플리케이션에서 객체가 생성되는 시점을 결정할 상황도 물론 생깁니다. 그 때는 Abstract Factory 패턴을 사용해서 객체가 생성되는 시점은 애플리케이션이 정하지만 생성되는 코드는 애플리케이션이 모르도록 할 수 있습니다.

 

의존성 주입

의존성 주입은 한 객체가 맡은 보조 책임을 새로운 객체에게 전적으로 떠넘깁니다. 새로운 객체는 넘겨받은 챔임만 맡으므로 단일 책임 원칙을 지키게 됩니다. 스프링 프레임 워크는 가장 널리 알려진 자바 DI 컨테이너(의존성 주입을 책임질 메터니즘)를 제공합니다. 객체 사이 의존성은 XML 파일에 정의하고 자바 코드에서는 이름으로 특정한 객체를 요청합니다.

DI컨테이너는 필요할 때까지는 객체를 생성하지 않고, 대부분은 계산 지연이나 비슷한 최적화에 쓸수 있는 팩토리를 호출하거나, 프록시를 생성하는 방법을 제공합니다.

 

EJB를 통해 배우는 관심사 분리의 중요성

EJB는 관심사를 적절히 분리하지 못해서 유기적인 성장이 어려웠습니다. EJB의 엔티티 빈은 관계형 자료, 즉 테이블 행을 표현하는 객체로, 메모리에 상주합니다. 비즈니스 논리는 EJB 애플리케이션 '컨테이너'에 강하게 결합되어 클래스를 생성할 때 컨테이너를 거쳐야 하고, 컨테이너가 요구하는 다양한 메서드를 제공해야 합니다. 그렇기 때문에 독자적인 단위테스트가 어렵고, 프레임워크 밖에서 재사용하기는 쉽지 않은 구조가 되었습니다.

 

횡단 관심사

영속성과 같은 관심사는 애플리케이션의 자연스러운 객체 경계를 넘나드는 경향이 있습니다. 모든 객체가 전반적으로 동일한 방식을 이용하게 만들어야 합니다. 원론적으로는 모듈화되고 캡슐화된 방식으로 영속성 방식을 구상할 수 있습니다. 하지만 현실적으로는 영속성 방식을 구현한 코드가 온갖 객체로 흩어지기 때문에 영속성 프레임워크와 도메인 논리도 모듈화 할 수 있지만 두 영영이 세밀한 단위로 겹친다는 점입니다. 이를 '횡단 관심사' 라고 합니다.

 

자바 프록시

자바 프록시는 개별 객체나 클래스에서 메서드 호출을 감싸는 경우가 좋은 예입니다. 하지만 JDK에서 제공하는 동적 프록시는 인터페이스만 지원합니다. 그래서 클래스 프록시를 사용하기 위해서는 CGLIB이나 ASM, Javassist 등과 같은 바이트 코드 처리 라이브러리가 필요합니다.

public class BankProxyHandler implements InvocationHandler {
    
    private Bank bank;

    public BankProxyHandler(Bank bank) {
        this.bank = bank;
    }

    @Override
    public Object invoke(Object proxy, Method method, Object[] args) throws Throwable {
        String methodName = method.getName();
        
        if(methodName.equals("getAccounts")){
            bank.setAccounts(getAccountsFromDatabase());
            return bank.getAccounts();
        } else if(methodName.equals("setAccounts")){
            bank.setAccounts((Collection<Account>) args[0]);
            setAccountToDatabase(bank.getAccounts());
            return null;
        } else {
        }
        
        protected Collection<Account> getAccountsFromDatabase(){ ... };
        protected void setAccountsToDatabase(Collection<Account> accounts){ ...};
    }
}

//실제로 프록시 사용할 때
public static void main(String[] args) {
    Bank bank = (Bank) Proxy.newProxyInstance(
        Bank.class.getClassLoader(),
        new Class[] { Bank.class },
        new BankProxyHandler(new BankImpl())
    );
}

 

순수 자바 AOP 프레임워크 (중요)

스프링은 비즈니스 논리를 POJO로 구현합니다. POJO는 순수하게 도메인에 초점을 맞추는데 엔터프라이즈 프레임워크에 의존하지 않습니다. 따라서 테스트가 개념적으로 더 쉽고 간단합니다.

프레임워크는 사용자가 모르게 프록시나 바이트코드 라이브러리를 사용해 필수적인 애플리케이션 기반 구조를 구현합니다. 여기에는 영속성, 트랜잭션, 보안, 캐시, 장애조치 등과 같은 것들을 포함합니다.

이런 선언들이 요청에 따라 주요 객체를 생성하고 서로 연결하는 DI 컨테이너의 구체적인 동작을 제어합니다. 이 때문에 스프링 관련 자바 코드가 거의 없게 되어 애플리케이션은 사실상 스프링과 독립적이게 되어 EJB2 시스템이 가졌던 강한 결합(tight-coupling) 문제가 사라지게 됩니다.

그래서 현재 많은 분들이 사용하는 코드가 나온 것입니다. EJB2보다 훨씬 더 개끗하고, 상세한 엔티티 정보는 애너테이션에 포함되었습니다. 많은 중요한 정보들이 애너테이션 속에 있으므로 코드 자체는 깔끔하고 깨끗해졌습니다.

 

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

애플리케이션 도메인 논리를 POJO로 작성할 수 있다면, 즉 코드 수준에서 아키텍처 관심사를 분리할 수 있다면, 진정한 테스트 주도 아키텍처 구축이 가능해집니다. 그때그때 새로운 기술을 채택해 단순한 아키텍처를 복잡한 아키텍처로 키워나갈 수 있습니다.
BDUF(Big Design Up Front: 구현을 시작하기 전에 앞으로 일어날 모든 사항을 설계하는 기법)를 추구할 필요가 없습니다.

아주 단순하면서도 멋지게 분리된 아키텍처로 소프트웨어 프로젝트를 진행해 결과물을 재빨리 출시한 후, 기반 구조를 추가하며 조금씩 확장해 나가도 괜찮다는 말입니다. 설계가 분리되어 각 추상화 수준과 범위에서 코드가 적당히 단순하기 때문입니다.

 

의사 결정을 최적화하라

모듈을 나누고 관심사를 분리하면 지엽적인 관리와 결정이 가능해집니다. 아주 큰 시스템에서는 한 사람이 모든 결정을 하기 어렵습니다. 가능한 마지막 순간까지 최대한 정보를 모아 최선의 결정을 내려야 합니다.

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

 

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

소프트웨어 분야에서 최근 들어 DSL(Domain-Specific Language)이 새롭게 조명 받기 시작했습니다. DSL은 간단한 스크립트 언어나 표준 언어로 구현한 API를 말하는데 DSL로 작성한 코드는 도메인 전문가가 작성한 구조적인 산문처럼 읽힌다고 합니다.

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

 

마무리

시스템은 깨끗해야하고, 그렇지 못한 아키텍처는 도메인 논리를 흐리며
기민성을 떨어뜨리고, 도메인 논리가 흐려져 제품 품질이 떨어집니다.
또한, 버그가 숨어들기 쉽고, 스토리를 구현하기 어려워집니다.

조금 어려운 내용이어서 100퍼센트 이해를 하진 못했지만 현재 사용하는 코드가
어떻게 만들어졌고 어떤 원리로 동작하는지 이해할 수 있었습니다.

길고 장황한 포스팅 읽어주셔서 감사합니다.

 

[출처]
Clean Code (클린 코드,애자일 소프트웨어 장인 정신), 로버트 C. 마틴 저