[클린코드] 11장 시스템

이 글은 로버트 마틴의 '클린 코드'를 읽고 TIL(Today I Learned)로써 정리한 내용을 기록하는 글입니다.
자세한 내용은 책을 통해 확인하실 수 있습니다.

알라딘: 클린 코드 Clean Code (aladin.co.kr)

클린 코드 Clean Code

시스템

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

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

• 제작과 사용은 아주 다르다.
• 소프트웨어 시스템은 애플리케이션 객체를 제작하고 의존성을 서로 연결하는 준비과정과 이후 이어지는 런타임 로직을 분리해야한다.
• 시작 단계는 모든 애플리케이션이 풀어야 할 관심사이다.
• 관심사 분리는 가장 오래되고 가장 중요한 설계 기법 중 하나이다.
• 설정 논리는 일반 실행 논리와 분리해야 모듈성이 높아진다.

//초기화 지연(Lazy Initialization), 계산 지연 기법(Lazy Evaluation)
//필요할 때까지 객체를 생성하지 않으므로 애플리케이션 시작이 빨라짐, 어떠한 경우에도 null포인터를 반환하지 않음.
public Service getService() {
  if(service == null) {
    service = new MyServiceImpl(...); 
  }
  return service;
}
//나쁜 코드인 이유
//1. 준비 과정 코드를 런타임 로직과 분리하지 않음.
//2. getService 메서드가 MyServiceImpl에 의존성을 갖는다.
//3. getService 메서드가 MyServiceImpl을 생성하는 행위와 service 객체를 리턴하는 행위를 동시에 수행 (SRP 위반)
//4. MyServiceImpl을 생성하는 것이 모든 상황에 적합한 객체인지 알 수 없다.

Main 분리

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

팩토리

• 때로는 객체가 생성되는 시점을 애플리케이션이 결정할 필요도 생긴다.
• 팩토리 패턴은 객체를 생성하는 인터페이스는 슈퍼 클래스에서 정의하되, 인수에 따라 리턴할 클래스의 인스턴스를 서브 클래스에서 결정하게 만드는 방법.
• 추상 팩토리 패턴은 연관되는 객체들로 구성된 팩토리 클래스들을 만들고 인수에 따라 리턴된 팩토리에서 객체들을 생성하게 하는 방법.
• 모든 의존성이 main에서 애플리케이션으로 향하고 애플리케이션은 인스턴스가 생성되는 시점을 완벽하게 통제한다.

의존성 주입(Dependency Injection, DI)

• 의존성 주입은 제어 역전(Inversion of Control, IoC)기법을 의존성 관리에 적용한 매커니즘.
• 제어 역전(IoC)에서는 한 객체가 맡은 보조 책임을 새로운 객체에게 전적으로 떠넘긴다.
• 새로운 객체는 넘겨받은 책임만 맡으므로 단일 책임 원칙(SRP)을 지키게 된다.
• 객체는 의존성 자체를 인스턴스로 만드는 책임을 지지 않고 이러한 책임을 전담하는 매커니즘에 넘김으로써 제어를 역전한다.
• 진정한 의존성 주입은 더 나아가 클래스가 의존성을 해결하려 시도하지 않는다. (의존성을 주입하는 방법으로 setter 메서드나 생성자 인수를 제공한다.)
• 초기화 지연으로 얻는 장점은 DI를 사용하더라도 때론 여전히 유용하다. (대다수 DI 컨테이너는 필요할 때까지는 객체를 생성하지 않고, 대부분 계산 지연이나 비슷한 최적화에 쓸 수 있도록 팩토리를 호출하거나 프록시를 생성하는 방법을 제공한다.)

확장

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

• 처음부터 올바르게 시스템을 만들 수 있다는 믿음은 미신이다.
• 우리는 오늘 주어진 사용자 스토리에 맞춰 시스템은 구현하고 내일은 새로운 스토리에 맞춰 시스템을 조정하고 확장하면 된다. (테스트 주도 개발과 리팩터링으로 얻어지는 깨끗한 코드는 코드 수준에서 시스템을 조정하고 확장하기 쉽게 만든다.)
• 소프트웨어 시스템은 수명이 짧다는 본질로 인해 아키텍처의 점진적인 발전이 가능하다.

//Enterprise Java Bean (EJB) 아키텍처 - 비즈니스 논리를 갖는 Enterprise Bean, 클라이언트 애플리케이션 그리고 이 둘 사이에서 연결을 수행하는 Container를 정의하여 비즈니스 로직을 처리한다.
public interface BankLocal extends java.ejb.EJBLocalObject { //클라이언트가 사용할 지역 인터페이스 BankLocal (애플리케이션)
  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;
}

public abstract class Bank implements javax.ejb.EntityBean { //데이터 Bank를 관리하는 EntityBean (EJB Bean의 한 종류)
  //비즈니스 논리
  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 setState(String state);
  public abstract void setZipCode(String zip);
  public abstract Collection getAccounts();
  public abstract void setAccounts(Collection accounts);
  public void addAccount(AccountDTO accountDTO){
    InitialContext 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() {}
}

//EJB의 문제점
//1. 비즈니스 논리(애플리케이션)가 컨테이너에 강하게 결합된다.
//(애플리케이션은 컨테이너를 통해 EntityBean에 접근하므로 클래스는 컨테이너가 요구하는 생명주기 메서드도 제공해야 한다.)
//2. 독자적인 단위 테스트가 어렵다
//(비즈니스 논리가 덩치 큰 컨테이너와 밀접하게 결합되어 있어 컨테이너를 흉내내거나 EJB와 테스트를 실제 서버에 배치해야 한다.)
//3. 객체지향적이지 않다.
//(EJB 빈은 다른 빈을 상속받지 못하며 쓸데없는 DTO를 작성하게 만든다.)

횡단 관심사

• 영속석과 같은 관심사는 애플리케이션의 자연스러운 객체 경계를 넘나드는 경향이 있고 원론적으로는 모듈화, 캡슐화가 가능하지만 현실적으로는 그렇지 않다.
• 관점 지향 프로그래밍(Aspect-Oriented Programming, AOP)는 횡단 관심사에 대처에 모듈성을 확보하는 일반적인 방법론이다.
• AOP에서는 특정 관심사를 지원하려면 시스템에서 특정 지점들이 동작하는 방식을 일관성 있게 바꿔야 한다.라고 명시한다.
• 자바에서는 관점과 유사한 매커니즘 세 가지 방법을 제시한다.

자바 프록시

• 자바 프록시는 단순한 상황에 적합하다. (개별 객체나 클래스에서 메서드 호출을 감싸는 경우)
• JDK에서 제공하는 동적 프록시는 인터페이스만 지원한다. (클래스 프록시를 사용하려면 CGLIB, ASM, Javassist와 같은 바이트 코드 처리 라이브러리가 필요하다.)
• 프록시를 사용하면 깨끗한 코드를 작성하기 어렵다.
• 프록시는 시스템 단위로 실행 지점을 명시하는 메커니즘도 제공하지 않는다.

//Bank.java - 추상화된 Bank 인터페이스
public interface Bank {
  Collection<Account> getAccounts();
  void setAccounts(Collection<Account> accounts);
}

//BankImpl.java - 비즈니스 논리를 구현하는 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 - 프록시에 호출되는 Bank 메서드를 구현. 자바 Reflection API를 사용해 Generics 메서드를 상응하는 Bank의 메서드로 매핑한다.
public class BankProxyHandler implements InvocationHandler {
  private Bank bank;
  
  public BankProxyHandler(Bank bank) {
    this.bank = bank;
  }
  
  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) { ... }
}

//BankImpl을 인수로 BankProxyHandler를 생성, 이를 Proxy 인스턴스로 생성함으로써 프록시 객체를 얻을 수 있음.
Bank bank = (Bank) Proxy.newProxyInstance(Bank.class.getClassLoader(), new Class[] {Bank.class}, new BankProxyHandler(new BankImpl()) );

순수 자바 AOP 프레임워크

• 스프링 AOP, JBoss AOP와 같은 여러 자바 프레임워크는 내부적으로 프록시를 사용한다.
• 상대적으로 단순하기 때문에 사용자 스토리를 올바로 구현하기 쉬우며 미래 스토리에 맞춰 코드를 보수하고 개선하기 편하다.
• 프로그래머는 설정 파일이나 API를 사용해 필수적인 애플리케이션 기반 구조를 구현한다.  프레임워크는 사용자가 모르게 프록시나 바이트코드 라이브러리를 사용해 이를 구현한다.
• XML은 장황하고 읽기 어렵다는 문제가 있음에도 불구하고 설정 파일에 명시된 정책이 겉으로 보이지 않지만 자동으로 생성되는 프록시나 관점 논리보다는 단순하다.
• 애너테이션에 들어있는 영속성 정보는 필요하다면 XML 배치 기술자로 옮겨도 괜찮다. 

//AOP 프레임워크를 사용하는 Bank EJB
@Entity
@Table(name = "BANKS")
public class Bank implements java.io.Serializable {
  @Id
  @GeneratedValue(strategy = GenerationType.AUTO)
  private int id;
  
  @Embedded //Bank의 데이터베이스 행에 inline으로 포함된 객체
  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;
  }
}

AspectJ 관점

• 관심사를 관점으로 분리하는 가장 강력한 도구는 AspectJ 언어다.
• AspectJ는 언어 차원에서 관점을 모듈화 구성으로 지원하는 자바 언어 확장이다.
• AspectJ는 관점을 분리하는 강력하고 풍부한 도구 집합을 제공하긴 하지만 새 도구를 사용하고, 새 언어 문법과 사용법을 익혀야 한다는 단점이 있다.
• 애너테이션 폼은 순순한 자바 코드에 자바 5 애너테이션을 사용해 관점을 정의함으로써 새로운 언어라는 부담을 어느정도 완화한다.
• 스프링 프레임워크는 AspectJ에 미숙한 팀들이 애너테이션 기반 관점을 쉽게 사용하도록 다양한 기능을 제공한다.

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

• 관점으로 관심사를 분리하는 방식은 그 위력이 막강하다.
• 코드 수준에서 아키텍처 관심사를 분리할 수 있다면(애플리케이션 도메인 논리를  POJO로 작성할 수 있다면) 진정한 테스트 주도 아키텍처 구축이 가능해진다.
• 아주 단순하면서도 멋지게 분리된 아키텍처로 소프트웨어 프로젝트를 진행해 결과물을 재빨리 출시한 후, 기반 구조를 추가하며 조금씩 확장해나갈 수 있다.
• 프로젝트를 시작할 때는 일반적인 범위, 목표, 일정은 물론이고 결과로 내놓을 시스템의 일반적인 구조도 생각해야 한다. 하지만 변하는 환경에 대해 대처에 진로를 변경할 능력도 반드시 유지해야 한다.
• 최선의 시스템 구조는 각기 POJO 객체로 구현되는 모듈화된 관심사 영역으로 구성된다. 이렇게 서로 다른 영역은 해당 영역 코드에 최소한의 영향을 미치는 관점이나 유사한 도구를 사용해 통합한다. 이런 구조 역시 코드와 마찬가지로 테스트 주도 기법을 적용할 수 있다.

의사 결정을 최적화하라

• 모듈을 나누고 관심사를 분리하면 지엽적인 관리와 결정이 가능해진다.
• 아주 큰 시스템에서는 한 사람이 모든 결정을 내리기 어렵다.
• 가장 적합한 사람에게 책임을 맡기자. 너무 일찍 결정하면 고객 피드백을 더 모으고, 프로젝트를 더 고민하고, 구현방안을 더 탐험할 기회가 사라진다.
• 관심사를 모듈로 분리한 POJO 시스템은 기민함을 제공한다. 이런 기민함 덕택에 최신 정보에 기반해 최선의 시점에 최적의 결정을 내리기가 쉬워진다. 또한 결정의 복잡성도 줄어든다.

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

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

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

• 도메인 특화 언어(Domain-Specific Language, DSL)는 간단한 스크립트 언어나 표준 언어로 구현한 API를 가리킨다. (ex. Maven, SQL, Regular Expression)
• 좋은 DSL은 도메인 개념과 그 개념을 구현한 코드 사이에 존재하는 의사소통 간극을 줄여준다.
• 효과적으로 사용한다면 DSL은 추상화 수준을 코드 관용구나 디자인 패턴 이상으로 끌어올린다. 그래서 개발자가 적절한 추상화 수준에서 코드 의도를 표현할 수 있다.

정리

• 시스템 역시 깨끗해야 한다.
• 모든 추상화 단계에서 의도는 명확이 표현해야 한다. POJO를 작성하고 관점 혹은 관점과 유사한 매커니즘을 사용해 각 구현 관심사를 분리해야 한다.
• 관점 지향 프로그래밍(Aspect-Oriented Programming, AOP)는 횡단 관심사에 대처에 모듈성을 확보하는 일반적인 방법론이다.
• 자바에서는 자바 프록시, 순수 자바 AOP 프레임워크, AspectJ 언어를 통해 AOP를 지원한다.
• 관점으로 관심사를 분리하면 테스트 주도 아키텍처 구축이 가능해지고 좋은 API를 만들 수 있다. (지엽적인 관리와 결정이 가능해진다.)
• 너무 표준에 집착하기보다는 도메인 특화 언어를 사용하는 등 개발자가 적절한 추상화 수준에서 코드 의도를 표현할 수 있는 것이 좋다.
• 시스템을 설계하든 모듈을 설계하든 실제로 돌아가는 가장 단순한 수단을 사용해야 한다.