CS Clean Code - 시스템

도시를 세운다면?

도시가 잘 돌아가는 이유. 수도 관리 팀, 전려 관리 팀, 교통 관리 팀 등 각 분야를 관리하는 팀이 있기 때문이다. 도시가 돌아가는 이유는 적절한 추상화와 모듈화 때문이다. 큰 그림을 이해하지 못할지라도 개인과 개인이 관리하는 구성요소는 효율적으로 돌아간다.

소프트웨어 팀도 도시처럼 구성한다. 깨끗한 코드를 구현하면 낮은 추상화 수준에서 관심사를 분리하기 쉬워진다. 이 장에서는 높은 추상화 수준, 즉 시스템 수준에서도 깨끗함을 유지하는 방법을 살펴본다.

 

 

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

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

 

시작 단계는 모든 애플리케이션이 풀어야 할 관심사다. 관심사 분리는 우리 분야에서 가장 오래되고 중요한 설계 기법이다. 불행히도 대다수 애플리케이션은 시작 단계라는 관심사를 분리하지 않는다.

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

 

• 필요할 때까지 객체를 생성하지 않기 때문에 불필요한 부하가 걸리지 않는다.
• 어떤 경우에도 null을 반환하지 않는다.
• MyServiceImpl 생성자 인수에 의존한다.
• 런타임에서 MyServiceImpl를 전혀 사용하지 않더라도 의존성을 해결하지 않으면 컴파일이 안 된다.
• 테스트를 진행할 때 MyServiceImpl가 무거운 객체라면 적절한 테스트 전용 객체를 만들기 힘들어진다.
• 일반 런타임 로직에 객체 생성 로직을 섞어놓은 탓에 모든 실행 경로(null일 때 실행한 경우, null이 아닐 때 실행하는 경우)를 테스트해야 한다.
• MyServiceImpl가 모든 상황에 적합한 객체인지 알 수 없다.

 

체계적이고 탄탄한 시스템을 만들고 싶다면 모듈성을 깨서는 절대로 안 된다. 객체를 생성하거나 의존성을 연결할 때도 마찬가지다. 또한 의존성을 해소하기 위한 전반적이며 일반적인 방식도 필요하다.

 

Main 분리

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

모든 화살표가 main에서 애플리케이션으로 향한다. 즉, 애플리케이션은 main이나 객체가 생성되는 과정을 모른다.

 

팩토리

때로는 객체가 생성되는 시점을 애플리케이션이 결정할 필요도 생긴다. 예를 들어, 주문처리 시스템에서 애플리케이션은 LineItem 인스턴스를 생성해 Order에 추가한다. 이때는 Abstract Factory 패턴을 사용한다.

여기서도 마찬가지로 모든 화살표가 main에서 OrderProcessing으로 향하고, OrderProcessing은 LineItem을 생성하는 방법을 모른다. 그럼에도 애플리케이션에서 인스턴스 생성을 완벽하게 통제하며, 애플리케이션에서만 사용하는 생성자 인수를 넘길 수 있다.

 

의존성 주입

사용과 제작을 분리하는 강력한 메커니즘 하나가 의존성 주입이다.

• 의존성 주입은 제어 역전 기법을 의존성 관리에 적용한 메커니즘이다. 제어 역전에서는 한 객체가 맡은 보조 책임을 새로운 객체에게 전적으로 떠넘긴다. 새로운 객체는 넘겨받은 책임만 맡으므로 SRP를 지키게 된다.
• 진정한 의존성 주입은 여기서 한 걸음 더 나간다. 클래스가 의존성을 해결하려 시도하지 않는다. 클래스는 완전히 수동적이다. 대신에 의존성을 주입하는 방법으로 생성자 인수를 제공한다. DI 컨테이너는 필요한 객체의 인스턴스를 만들고 의존성을 설정한다.

 

확장

'처음부터 올바르게' 시스템을 만들 수 있다는 믿음은 미신이다. 대신에 우리는 오늘 주어진 사용자 스토리에 맞춰 시스템을 구현해야 한다. 내일은 새로운 스토리에 맞춰 시스템을 조정하고 확장하면 된다. 이것이 반복적이고 점진적인 애자일 방식의 핵심이다.

성장할지 모른다는 기대로 자그만 마을에 6차선을 뚫는데 비용을 정당화할 수 있을까? 아니, 어느 조그만 마을이 6차선을 반길까?

 

소프트웨어 시스템은 물리적인 시스템과 다르다. 관심사를 적절히 분리해 관리한다면 소프트웨어 아키텍처는 점진적으로 발전할 수 있다. 또한 TDD, 리팩터링, 깨끗한 코드는 코드 수준에서 시스템을 조정하고 확장하기 쉽게 만든다.

 

 

횡단(cross-cutting) 관심사

원론적으로 모듈화되고 캡슐화된 방식으로 영속성 방식을 구상할 수 있다. 하지만 현실적으로는 영속성 방식을 구현한 코드가 온갖 객체로 흩어진다. 여기서 횡단 관심사라는 용어가 나온다.

 

* 횡단 관심사 : 여러 핵심 관심사에 중복으로 삽입된 코드들

 

횡단 관심사

 

이러한 횡단 관심사를 해결하기 위해 AOP라는 패러다임이 있습니다.

 

Aspect Oriented Programming, 관점 지향 프로그래밍. 횡단 관심사의 분리를 허용함으로써 모듈성을 증가시키는 것이 목적인 패러다임

 

AOP - 자바 프록시

자바 프록시는 단순한 상황에 적합하다. 개별 객체나 클래스에서 메서드 호출을 감싸는 경우가 좋은 예다. 하지만 JDK에서 제공하는 동적 프록시는 인터페이스만 지원한다.

public interface Bank { 
    Collection<Account> getAccounts();
    void setAccounts(Collection<Account> accounts); 
} 

// 추상화를 위한 POJO("Plain Old Java Object") 구현 
public class BankImpl implements Bank {
    private List<Account> accounts; 
    public Collection<Account> getAccounts() { 
        return accounts;
    } 

    public void setAccounts(Collection<Account> accounts) { 
        this.accounts = new ArrayList<Account>(); 
        for (Account account: accounts) { 
            this.accounts.add(account); 
        }
    } 
} 

// 프록시 API가 필요한 InvocationHandler 
public class BankProxyHandler implements InvocationHandler {
    private Bank bank; 
    
    public BankHandler (Bank bank) { 
        this.bank = bank; 
    }

    // InvocationHandler에 정의된 메서드 
    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]); 
            setAccountsToDatabase(bank.getAccounts()); 
            return null; 
        } else { 
            ... 
        } 
    } 

    // 세부사항은 여기에 이어진다. 
    protected Collection<Account> getAccountsFromDatabase() { ... }
    protected void setAccountsToDatabase(Collection<Account> accounts) { ... }
} 
// 다른 곳에 위치하는 코드 
Bank bank = (Bank) Proxy.newProxyInstance( 
    Bank.class.getClassLoader(),
    new Class[] { Bank.class }, 
    new BankProxyHandler(new BankImpl())
);

• 단순한 예제지만 코드가 상당히 많으면 복잡하다.
• 프록시를 사용하여 깨끗한 코드를 만들기 어렵다.

 

AOP - 순수 자바 AOP 프레임워크

다행스럽게도 대부분의 프록시 코드는 판박이라 도구로 자동화할 수 있다. Spring, JBoss 등과 같은 여러 자바 프레임워크는 내부적으로 프록시를 사용한다.

 

프로그래머는 설정 파일이나 API를 통해서 애플리케이션에 필요한 기반 구조를 구현한다.

 <beans>
    ...
    <bean id="appDataSource"
        class="org.apache.commons.dbcp.BasicDataSource"
        destroy-method="close"
        p:driverClassName="com.mysql.jdbc.Driver"
        p:url="jdbc:mysql://localhost:3306/mydb"
        p:username="me"/>
    
    <bean id="bankDataAccessObject"
        class="com.example.banking.persistence.BankDataAccessObject"
        p:dataSource-ref="appDataSource"/>
    
    <bean id="bank"
        class="com.example.banking.model.Bank"
        p:dataAccessObject-ref="bankDataAccessObject"/>
    ...
</beans>

클라이언트는 Bank 객체에서 getAccount()를 호출한다고 믿지만 실제로는 Bank POJO의 기본 동작을 외곽과 통신한다. 애플리케이션에서 DI 컨테이너에게 객체를 요청하려면 다음과 같은 코드가 필요하다.

XmlBeanFactory bf = new XmlBeanFactory(new ClassPathResource("app.xml", getClass()));
Bank bank = (Bank) bf.getBean("bank");

스프링 관련 자바 코드가 거의 필요 없으므로 애플리케이션은 사실상 스프링과 독립적이다.

 

package com.example.banking.model;

import javax.persistence.*;
import java.util.ArrayList;
import java.util.Collection;

@Entity
@Table(name = "BANKS")
public class Bank implements java.io.Serializable {
    @Id @GeneratedValue(strategy=GenerationType.AUTO)
    private int id;
    
    @Embeddable // Bank의 데이터베이스 행에 '인라인으로 포함된' 객체
    public class Address {
        protected String streetAddr1;
        protected String streetAddr2;
        protected String city;
        protected String state;
        protected String zipCode;
    }
    
    @Embedded
    private Address address;

    @OneToMany(cascade = CascadeType.ALL, fetch = FetchType.EAGER, mappedBy="bank")
    private Collection<Account> accounts = new ArrayList<Account>();
    public int getId() {
        return id;
    }
    
    public void setId(int id) {
        this.id = id;
    }
    
    public void addAccount(Account account) {
        account.setBank(this);
        accounts.add(account);
    }
    
    public Collection<Account> getAccounts() {
        return accounts;
    }
    
    public void setAccounts(Collection<Account> accounts) {
        this.accounts = accounts;
    }
}

상세한 코드를 어노테이션에 옮기면서 엄청 깔끔해졌다. 어노테이션에 있는 정보를 XML로 옮기면 코드가 깔끔해진다.

 

AOP - AspectJ 관점

관심사를 관점으로 분리하는 가장 강력한 도구는 AspectJ 언어다. 언어 차원에서 관점을 모듈화 구성으로 지원하는 자바 언어 확장이다. AspectJ는 관점을 분리하는 강력한 도구 집합을 제공하지만, 학습 비용이 든다는 단점이 있다.

 

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

관점으로 관심사를 분리하는 방식은 그 위력이 막강하다. 애플리케이션 도메인 논리를 POJO로 작성할 수 있다면, 즉 코드 수준에서 관심사를 분리할 수 있다면, 진정한 테스트 주도 아키텍처 구성이 가능해진다.

 

BDUF를 추구할 필요가 없다. 오히려 해롭다. (BDUF : 구현을 시작하기 전에 모든 사항을 설계하는 기법)

• 처음에 쏟아 부은 노력을 버리지 않으려는 심리적 저항
• 처음 선택한 아키텍처가 향수 사고방식에 미치는 영향
• 결국 변경을 쉽게 수용하지 못한다.

 

아주 단순하면서도 멋지게 분리된 아키텍처로 소프트웨어 프로젝트를 진행해 결과물을 재빨리 출시한 후, 조금씩 확장해 나가도 괜찮다는 말이다.

 

의사 결정을 최적화하라

우리는 때때로 가능한 마지막 순간까지 결정을 미루는 방법을 최선이라는 사실을 까먹곤 한다. 최대한 정보를 모아 결정을 내리기 위해서다. 너무 일찍 결정하면 고객 피드백을 더 모으고, 프로젝트를 더 고민하고, 구현 방안을 더 탐험할 기회가 사라진다.

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

 

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

• 적절한 경험을 가진 사람을 구하기 쉽다.
• 좋은 아이디어를 캡슐화하기 쉽고, 컴포넌트를 엮기 쉽다.
• 표준을 만드는 시간이 너무 오래 걸린다.
• 어떤 표준은 원래 표준을 제정한 목적을 잊어버리기도 한다.

 

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

에자일 기법이 팀과 프로젝트 이해관계자 사이에 의사소통 간극을 줄여주듯, DSL은 도메인 개념과 코드 사이에 존재하는 간극을 줄여준다. DSL을 사용하면 고차원 정책에서 저차원 세부사항에 이르기까지 모든 추상화 수준과 모든 도메인을 POJO로 표현할 수 있다.

스프링 예제 코드와, Room이 생각났습니다. 어노테이션으로 관계를 정의하는 방식이 DSL 같다고 느껴졌습니다.

결론

• 코드, 클래스와 마찬가지로 시스템 역시 깨끗해야 한다. 깨끗하지 못한 시스템은 도메인 논리를 흐리며, 기민성을 떨어뜨린다.
• 모든 추상화 단계에서 의도를 명확히 표현해야 한다. 그러려면 POJO를 작성하고 관점 혹은 관점과 유사한 메커니즘을 사용해 각 구현 관심사를 분리해야 한다.