떼닝로그

[11장] 시스템 본문

개발로그/Clean Code

[11장] 시스템

떼닝 2023. 2. 11. 16:47

" 복잡성은 죽음이다. 개발자에게서 생기를 앗아가며, 제품을 계획하고 제작하고 테스트하기 어렵게 만든다. "

도시를 세운다면?

- 도시가 돌아가는 이유는 적절한 추상화와 모듈화 때문이다. 큰 그림을 이해하지 못할지라도 개인과 개인이 관리하는 '구성요소'는 효율적으로 돌아간다.

- 깨끗한 코드를 구현하면 낮은 추상화 수준에서 관심사를 분리하기 쉬워진다.

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

 

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

- 제작(construction)은 사용(use)과 아주 다르다.

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

- 시작 단계는 모든 애플리케이션이 풀어야 할 관심사(concern)다. 관심사 분리는 우리 분야에서 가장 오래되고 가장 중요한 설계 기법 중 하나다.

- 아래 코드는 준비 과정 코드를 주먹구구식으로 구현할 뿐만 아니라 런타임 로직과 마구 뒤섞는, 관심사가 분리되지 않은 코드이다.

def getService():
	if(service == NULL):
    	service = MyServiceImpl(...) # 모든 상황에 적합한 기본값일까?
    return service

- 위와 같은 것이 초기화 지연(Lazy Initialization) 혹은 계산 지연(Lazy Ecaluation)이라는 기법이다.

- 실제로 필요할 때까지 객체를 생성하지 않으므로 불필요한 부하가 걸리지 않고, 어떤 경우에도 NULL 포인터를 반환하지 않는다는 장점이 있다.

- 책임이 둘이라는 말은 메서드가 작업을 두 가지 이상 수행한다는 의미로, 작게나마 단일 책임 원칙(SRP)을 깬다는 것을 의미한다.

- 체계적이고 탄탄한 시스템을 만들고 싶다면 모듈성을 깨서는 절대로 안된다. 설정 논리는 일반 실행 논리와 분리해야 모듈성이 높아진다.

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

Main 분리

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

main()에서 생성 분리

- 애플리케이션은 main이나 객체가 생성되는 과정을 전혀 모른다. 단지 모든 객체가 적절히 생성되었다고 가정할 뿐이다.

팩토리

- 때로는 객체가 생성되는 시점애플리케이션이 결정할 필요도 생긴다.

- 아래 그림에서의 LineItem을 생성하는 시점은 애플리케이션이 결정하지만, LineItem을 생성하는 코드는 애플리케이션이 모른다.

팩토리로 생성 분리

- 모든 의존성이 main에서 OrderProcessing 애플리케이션으로 향한다. 즉, 애플리케이션은 LineItem이 생성되는 구체적인 방법을 모른다.

- 그럼에도 OrderProcessing 애플리케이션은 LineItem 인스턴스가 생성되는 시점을 완벽하게 통제하며, OrderProcessing 애플리케이션에서만 사용하는 생성자 인수도 넘길 수 있다.

의존성 주입

- 사용과 제작을 분리하는 강력한 메커니즘 하나가 의존성 주입(Dependency Injection, DI)이다.

- 의존성 주입은 제어 역전(Inversion of Control, IoC) 기법을 의존성 관리에 적용한 메커니즘으로, 한 객체가 맡은 보조 책임을 새로운 객체에게 전적으로 떠넘기는 역할을 한다.

- 새로운 객체는 넘겨받은 책임만 맡으므로 단일 책임 원칙(Single Responsibility Principle, SRP)을 지키게 된다.

- 초기 설정은 시스템 전체에서 필요하므로 대개 '책임질' 메커니즘으로 'main' 루틴이나 특수 컨테이너를 사용한다.

- JNDI(Java Naming and Directory Interface) 검색의존성 주입을 '부분적으로' 구현한 기능이다. 객체는 디렉터리 서버에 이름을 제공하고 그 이름에 일치하는 서비스를 요청한다. (JNDI 참고 : https://go-coding.tistory.com/76)

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

- 호출되는 객체는 (반환되는 객체가 적절한 인터페이스를 구현하는 한) 실제로 반환되는 객체의 유형을 제어하지 않지만, 호출하는 객체의존성을 능동적으로 해결한다.

- 클래스는 완전히 수동적으로, 의존성을 해결하려 시도하지 않지만, 의존성을 주입하는 방법으로 setter 메서드나 생성자 인수를 제공.

- DI 컨테이너는 (대개 요청이 들어올 때마다) 필요한 객체의 인스턴스를 만든 후 생성자 인수나 설정자 메서드를 사용해 의존성을 설정.

- 대다수의 DI 컨테이너필요할 때까지는 객체를 생성하지 않고, 팩토리를 호출하거나 프록시를 생성하는 방법을 제공한다.

 

확장

- 반복적이고 점진적인 애자일 방식의 핵심인 테스트 주도 개발(Test-driven Development, TDD), 리팩터링, (TDD와 리팩터링으로 얻어지는) 깨끗한 코드코드 수준에서 시스템을 조정하고 확장하기 쉽게 만든다.

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

- EJB1과 EJB2 아키텍처는 관심사를 적절히 분리하지 못했기에 불필요한 장벽이 생겼고, 유기적인 성장이 어려워졌다. (EJB 참고 : https://m.blog.naver.com/qhdqhdekd261/221690113143)

- 클라이언트가 사용할 (프로세스 내) 지역 인터페이스나 (다른 JVM에 있는) 원격 인터페이스를 정의해야 한다. 아래는 EJB용 EJB2 지역 인터페이스이다.

package com.example.banking;
import java.util.Collections;
import javax.ejb.*;

public interface BankLocal extends java.ejb.EJBLocalObject {
	String getStreetAddr1() throws EJBException;
    String getStreetAddr2() throws EJBException;
    String getCity() throws EJBException;
    String getState() throws EJBException;
    String getZipCode() throws EJBException;
    void setStreetAddr1(String street1) throws EJBException;
    void setStreetAddr2(String street2) throws EJBException;
    void setCity(String city) throws EJBException;
    void setState(String state) throws EJBException;
    void setZipCode(String zip) throws EJBException;
    Collection getAccounts() throws EJBException;
    void setAccounts(Collection accounts) throws EJBException;
    void addAccount(AccountDTO accountDTO) throws EJBException;
}

- 위 코드에서 열거하는 속성은 Bank주소, 은행이 소유하는 계좌이고, 각 계좌 정보는 Account EJB로 처리한다.

- 아래 코드는 위 인터페이스를 구현한 Bank 빈(bean)에 대한 구현 클래스이다.

package com.example.banking;
import java.util.Collections;
import javax.ejb.*;

public abstract class Bank implements javax.ejb.EntityBean{
	// 비즈니스 논리...
    public abstract String getStreetAddr1();
    public abstract String getStreetAddr2();
    public abstract String getCity();
    public abstract String getState();
    public abstract String getZipCode();
    public abstract void setStreetAddr1(String street1);
    public abstract void setStreetAddr2(String street2);
    public abstract void setCity(String city);
    public abstract void setZipCode(String zip);
    public abstract Collection getAccounts();
    public abstract void setAccounts(Collection accounts);
    public void addAccount(AccountDTO accountDTO){
    	IntialContext context = new InitialContext();
        AccountHomeLocal accountHome = context.lookup("AccountHomeLocal");
        AccountLocal account = accountHome.create(accountDTO);
        Collection accounts = getAccounts();
        accounts.add(account);
    }
    // EJB 컨테이너 논리
    public abstract void setId(Integer id);
    public abstract Integer getId();
    public Integer ejbCreate(Integer id) {...}
    public void ejbPostCreate(Integer id) {...}
    // 나머지도 구현해야 하지만 일반적으로 비어있다.
    public void setEntityContext(EntityContext ctx) {}
    public void unsetEntityContext() {}
    public void ejbActivate() {}
    public void ejbPassivate() {}
    public void ejbLoad() {}
    public void ejbStore() {}
	public void ejbRemove() {}
}

 -  마지막으로, 영구 저장소에서 객체와 관계형 자료가 매핑되는 방식, 원하는 트랜잭션 동작 방식, 보안 제약조건 등이 들어가는 XML 배포 기술자(deployement descriptors)를 작성해야 한다.

- 비즈니스 논리가 덩치 큰 컨테이너와 밀접하게 결합된 탓에 독자적인 단위 테스트가 어렵다. 그래서 EJB2 코드는 프레임워크 밖에서 재사용하기란 사실상 불가능하다.

- EJB2 빈에는 동일한 정보를 저장하는 자료 유형이 두 개이다. 그래서 한 객체에서 다른 객체로 자료를 복사하는 반복적인 규걱 코드가 필요하다.

횡단(cross-cutting) 관심사

- EJB2 아키텍처는 일부 영역에서 관심사를 거의 완벽하게 분리한다. 예를 들어, 원하는 트랜잭션, 보안, 일부 영속적인 동작은 소스 코드가 아니라 배치 기술자에서 정의한다

- 영속성과 같은 관심사는 애플리케이션의 자연스러운 객체 경계를 넘나드는 경향이 있다. 모든 객체가 전반적으로 동일한 방식을 이용하게 만들어야 한다.

- 모듈화되고 캡슐화된 방식으로 영속성 방식을 구상할 수 있지만, 현실적으로는 영속성 방식을 구현한 코드가 온갖 객체로 흩어지고, 이것을 횡단 관심사라고 한다.

- 영속성 프레임워크와 도메인 논리 모두 모듈화할 수 있지만, 이 두 영역이 세밀한 단위로 겹친다는 점이 문제가 된다.

- 관점 지향 프로그래밍(Aspect-Oriented Programming, AOP)는 횡단 관심사에 대처해 모듈성을 확보하는 일반적인 방법론이다.

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

 

자바 프록시

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

- 아래의 코드는 Bank 어플리케이션에서 JDK 프록시를 사용해 영속성을 지원하는 예제이다.

// Bank.java (패키지 이름을 감춘다)
import java.util.*;

// 은행 추상화
public interface Bank{
	Collection<Account> getAccounts();
    void setAccounts(Collection<Account> accounts);
}
// BankImpl.java
import java.util.*;

// 추상화를 위한 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);
        }
    }
}
// BankProxyHandler.java
import java.lang.reflect.*;
import java.util.*;

// 프록시 API가 필요한 "InvocationHandler"
public class BankProxyHandler implmenets InvocationHandler{
	private Bank bank;
    
    public BankProxyHandler (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 프레임워크

- 대부분의 프록시 코드는 판박이라 도구로 자동화할 수 있다.

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

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

- POJO는 순수하게 도메인에 초점을 맞추고, 엔터프라이즈 프레임워크에 의존하지 않는다.

- 따라서 테스트가 개념적으로 더 쉽고 간단하다. 상대적으로 단순하기 때문에 사용자 스토리를 올바로 구현하기 쉬우며 미래 스토리에 맞춰 코드를 보수하고 개선하기 편하다.

- 프로그래머는 영속성, 트랜잭션, 보안, 캐시, 장애조치 등과 같은 횡단 관심사를 포함하여 설정 파일이나 API를 사용해 필수적인 애플리케이션 기반 구조를 구현한다.

- 아래 코드는 스프링 V2.5 설정 파일 app.xml 일부로, 아주 전형적인 모습이다.

<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 도메인 객체는 자료 접근자 객체로 프록시되었으며, 이는 JDBC 드라이버 자료 소스로 프록시되었다.

DECORATOR의 '러시아 인형'

- 클라이언트는 Bank POJO의 기본 동작을 확장한 중첩 DECORATOR 객체 집합의 가장 외곽과 통신한다. 필요하다면 트랜잭션, 캐싱 등에도 DECORATOR를 추가할 수 있다.

- 애플리케이션에서 DI 컨테이너에게 (XML 파일에 명시된) 시스템 내 최상위 객체를 요청하려면 아래의 코드가 필요하다.

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

- 애플리케이션은 사실상 스프링과 독립적이다. EJB2 시스템이 지녔던 강한 결합이라는 문제가 모두 사라진다.

- XML은 장황하고 읽기 어렵다는 문제가 있음에도 불구하고, 이런 설정 파일에 명시된 '정책'이 겉으로 보이지 않지만 자동으로 생성하는 프록시나 관점 논리보다는 단순하다.

- EJB3은 XML 설정 파일과 자바 5 애너테이션 기능을 사용해 횡단 관심사를 선언적으로 지원하는 스프링 모델을 따른다.

- 아래 코드는 EJB3으로 Bank 객체를 다시 작성한 코드이다. (p.208)

package com.example.banking.model;
import javax.persistence.*;
import java.util.ArrayList;
import java.util.Colleection;

@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;
        protectted 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;
    }
    
}

- 일부 상세한 엔티티 정보는 애너테이션에 포함되어 그대로 남아있지만, 모든 정보가 애너테이션 속에 있으므로 코드 자체는 깔끔하다. 그만큼 코드를 테스트하고 개선하고 보수하기가 쉬워졌다.

 

AspectJ 관점

- 관심사를 관점으로 분리하는 가장 강력한 도구는 AspectJ 언어. 언어 차원에서 관점을 모듈화 구성으로 지원하는 자바 언어 확장.

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

 

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

- 애플리케이션 도메인 논리를 POJO로 작성할 수 있다면, 즉 코드 수준에서 아키텍처 관심사를 분리할 수 있다면, 진정한 테스트 주도 아키텍처 구축이 가능해진다.

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

- 프로젝트를 시작할 때는 일반적인 범위, 목표, 일정은 물론이고 결과로 내놓을 시스템의 일반적인 구조도 생각해야 하고, 변하는 환경에 대처해 진로를 변경할 능력도 반드시 유지해야 한다.

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

 

의사 결정을 최적화하라

- 모듈을 나누고 관심사를 분리하면 지엽적인 관리와 결정이 가능해진다.

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

 

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

- 표준을 사용하면 아이디어와 컴포넌트를 재사용하기 쉽고, 적절한 경험을 가진 사람을 구하기 쉬우며, 좋은 아이디어를 캡슐화하기 쉽고, 컴포넌트를 엮기 쉽다.

- 어떤 표준은 원래 표준을 제정한 목적을 잊어버리기도 한다.

 

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

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

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

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

 

결론

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

- 모든 추상화 단계에서 의도는 명확히 표현해야 한다. 그러려면 POJO를 작성하고 관점 혹은 관점과 유사한 메커니즘을 사용해 각 구현 관심사를 분리해야 한다.

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

'개발로그 > Clean Code' 카테고리의 다른 글

[12장] 창발성  (0) 2023.02.11
[10장] 클래스  (0) 2023.01.09
[9장] 단위 테스트  (1) 2023.01.01
[8장] 경계  (0) 2022.12.26
[7장] 오류 처리  (0) 2022.12.19
Comments