[DDD] 도메인 모델 (1)

DDD 의 첫번째 시간이다.

도메인

도메인이란 무엇인가? 온라인 서점을 예를 들어보자. 어떤 책이 나왔는지 검색을하고 평가로 하고 장바구니에 담고 구매도 한다. 구매를 할 때는 카드를 사용하기도 하고 가상계좌을 사용하기도 한다. 개발자 입장에서 온라인 서점은 구현해야 할 소프트웨어이다. 책을 판매하는데 조회, 구매, 결제, 배송등의 기능을 제공해야 하는데 이때 온라인서점은 소프트웨어로 해결하고자 하는 문제영역, 즉 도메인에 해당된다. 특정 도메인을 위한 소프트웨어라고 해서 도메인이 제공해야 할 모든 것을 구현해야 하는 것은 아니다. 배송시스템을 구축하기보다는 외부 배송업체의 시스템을 사용하고 필요한 기능만 일부 연동한다.

도메인 모델

도메인 모델에는 다양한 정의가 존재하는데 기본적으로 도메인 모델은 특정 도메인을 개념적으로 표현한 것이다. 예를 들어 주문도메인을 생각해보자. 예를 들어 쇼핑몰에서 주문을 하려면 상품을 몇개 살지 선택하고 배송지를 입력한다. 선택한 상품의 총 지불 금액을 계산하고 결제 수단을 선탥한다. 주문한 뒤에도 배송 전이면 배송지 주소를 변경하거나 주문을 취소할 수도 있다. 도메인을 이해하려면 도메인이 제공하는 기능과 도메인의 주요 데이터 구성을 파악해야 하는데 이런면에서 기능과 데이터를 함께 보여주는 객체 모델은 도메인을 모델링하기 적합하다. 도메인 모델을 객체로만 모델링할 수 있는 것은 아니다. 상태다이어그램을 이용해도 상관없다. 도메인 모델은 기본적으로 도메인 자체를 이해하기 위한 개념 모델이다. 개념 모델을 이용해서 바로 코드를 작성할 수 있는 것은 아니기에 구현 기술에 맞는 구현 모델이 따로 필요 하다. 개념 모델과 구현 모델은 서로 다른 것이지만 구현 모델이 개념 모델을 최대한 따르도록 할 수는 있다. 예를 들어 객체 기반 모델을 이용해서 도메인을 표현했다면 객체 지향 언어를 이용해서 개념 모델에 가깝게 구현할 수 있다.

도메인 모델 패턴

일반적으로 어플리케이션의 아키텍처는 네개의 계층으로 구성된다. 1. 사용자 인터페이스 : 사용자의 요청을 처리하고 사용자에게 정보를 보여준다. 여기서 사용자는 소프트웨어를 사용하는 사람뿐만 아니라 외부 시스템도 사용자가 될 수 있다. 2. 응용 : 사용자가 요청한 기능을 실행한다. 업무 로직을 직접구현하지 않으며 도메인 계층을 조합해서 기능을 실행한다. 3. 도메인 : 시스템이 제공할 도메인 규칙을 구현한다. 4. 인프라스트럭처 : 데이터 베이스나 메시징 시스템과 같은 외부 시스템과의 연동을 처리한다. 도메인 계층은 도메인의 핵심 규칙을 구현한다. 주문 도메인의 경우 출고 전에 배송지를 변경할 수 있다. 는 규칙과 주문 취소는 배송 전에만 할 수 있다.는 규칙을 구현한 코드가 도메인 계층에 위치하게 된다.

public class Order {

  private OrderState state;
  private ShippingInfo shippingInfo;

  public void changeSippingInfo(ShippingInfo newShippingInfo){
    if(state.isShippingChangeable()){
      throw new IllegalStateException("cant change shipping in " + state);
    }
    this.shippingInfo = newShippingInfo;
  }

  public void changeShipped(){
    this.state = OrderState.SHIPPED;
  }
}

public enum OrderState {

  PAYMET_WATTING {
    public boolean isShippingChangeable(){
      return true;
    }
  },
  PREPARING {
    public boolean isShippingChangeable(){
      return true;
    }
  },
  SHIPPED, DELIVERING, DELIVERY_COMPLETED;

  public boolean isShippingChangeable(){
    return false;
  }
}

이 코드는 주문 도메인의 일부 기능을 도메인 모델 패턴으로 구현한 것이다. 주문상태를 표현하는 OrderState는 배송지를 변경할 수 있는지 여부를 검사할 수 있는 isShippingChangeable() 메서드를 제공하고 있다. 주문대기(PAYMET_WATTING) 상태와 상품 준비중(PREPARING) 상태의 isShippingChangeable() 메서드는 true를 리턴한다. 즉 OrderState는 주문대기거나 상품 준비중에는 배송지를 변경할 수 있다는 도메인 규칙을 구현하고 있다. 실제 배송지 정보를 변경하는 Order클래스의 changeSippingInfo() 메서드는 OrderState의 isShippingChangeable() 메서드를 이용해서 변경 가능여부를 확인한 후 변경 가능한 경우에만 배송지를 변경한다. 큰 틀에서 보면 OrderState는 Order에 속한 데이터이므로 배송지 정보 변경 가능 여부를 판단하는 코드는 Order로 이동할 수 도 있다.

public class Order {

  private OrderState state;
  private ShippingInfo shippingInfo;

  public void changeSippingInfo(ShippingInfo newShippingInfo){
    if(state.isShippingChangeable()){
      throw new IllegalStateException("cant change shipping in " + state);
    }
    this.shippingInfo = newShippingInfo;
  }


  private boolean isShippingChangeable(){
    return state == OrderState.PAYMET_WATTING || state == OrderState.PREPARING;
  }
}

public enum OrderState {

  PAYMET_WATTING, PREPARING, SHIPPED, DELIVERING, DELIVERY_COMPLETED;
}

배송지 변경이 가능한지 여부를 판단할 규칙이 주문 상태와 다른 정보를 함께 사용한다면 배송지 변경 가능 여부 판단을 OrderState만으로 할 수 없으므로 로직 구현을 Order에서 해야 할 것이다.

도메인 모델 도출

천재 개발자라 할지라도 도메인에 대한 이해 없이 코딩을 시작할 수는 없다. 요구사항과 관련자와의 대화를 통해 도메인을 이해하고 이를 바탕으로 도메인 모델 초안을 만들어야 비로소 코드를 작성할 수 있다. 모메인을 모델링할 때 기본이 되는 작업은 모델을 구성하는 핵심구성요소, 규칙, 기능을 찾는 것이다. 쇼핑몰 요구사항 중 출고 상태로 변경하기, 배송지 정보 변경하기, 주문 취소하기, 결제 완료로 변경하기 네 기능을 제공한다면 상세 구현까지 할 수 있는 수준은 아니지만 Order에 관련 기능을 메서드를 추가 할 수 있다.

public void changeShipped(){}
public void changeSippingInfo(ShippingInfo newShippingInfo){}
public void cancel(){}
public void completePayment(){}

다음 요구사항은 주문 항목이 어떤 데이터로 구성되는지 알려준다. 1. 한 상품을 한개 이상 주문할 수 있다. 2. 각 상품의 구매 가격 합은 상품가격에 구매 개수를 곱한 값이다.

public class OrderLine {

  private Product product;
  private int price;
  private int quantity;
  private int amounts;

  public OrderLine(Product product, int price, int quantity) {
    this.product = product;
    this.price = price;
    this.quantity = quantity;
    this.amounts = calculateAmounts();
  }

  public int calculateAmounts(){
    return price * quantity;
  }

  public int getAmounts(){

  }
}

Order와 OrderLine의 관계는 이렇다. 1. 최소 한 종류 이상의 상품을 주문해야 한다. 2. 총 주문 금액은 각 상품의 구매 가격 합을 모두 더한 값이다. 우리는 Order에 다음과 같이 반영할 수 있다.

public class Order {

  private List<OrderLine> orderLines;
  private int totalAmounts;

  public Order(List<OrderLine> orderLines) {
    this.orderLines = orderLines;
  }

  private void setOrderLines(List<OrderLine> orderLines){
    verifyAtLeastOneOrMoreOrderLines(orderLines);
    this.orderLines = orderLines;
    calculateTotalAmounts();
  }

  private void calculateTotalAmounts() {
    this.totalAmounts = new Money(orderLines.stream()
    .mapToInt(x -> x.getAmounts()).sum());
  }

  private void verifyAtLeastOneOrMoreOrderLines(List<OrderLine> orderLines) {
    if(orderLines == null || orderLines.isEmpty()){
      throw new IllegalArgumentException("no OrderLine");
    }
  }
}

verifyAtLeastOneOrMoreOrderLines() 메서드는 한개 이상 존재하는지 calculateTotalAmounts() 메서드는 총 주문 금액을 계산한다. 배송지 정보는 이름, 전화번호, 주소 데이터를 가지므로 ShippingInfo 클래스를 다음과 같이 정의 할 수 있다.

public class ShippingInfo {
  private String receiverName;
  private String receiverPhoneNumber;
  private String shippingAddress1;
  private String shippingAddress2;
  private String shippingZipcode;

  //getter setter
}

주문할 때는 배송지 정보를 입력해야 된다. 그래서 Order를 생성할 때 ShippingInfo를 주가 하였다.

public class Order {

  private List<OrderLine> orderLines;
  private int totalAmounts;
  private ShippingInfo shippingInfo;

  public Order(List<OrderLine> orderLines, ShippingInfo shippingInfo) {
    setShippingInfo(shippingInfo);
    setOrderLinse(orderLines);
  }

  private void setShippingInfo(ShippingInfo shippingInfo){
    if(shippingInfo == null){
      throw new IllegalArgumentException("no ShippingInfo");
    }
    this.shippingInfo = shippingInfo;
  }

  private void setOrderLinse(List<OrderLine> orderLinse) {
    //...
  }
}

도메인을 구현하다 보면 특정 조건이나 상태에 따라 제약이나 규칙이 달리 적용되는 경우가 많다. 주문 요구사항의 경우에는 다음과 같다. 1. 출고를 하면 배송지 정보를 변경할 수 없다. 2. 출고 전에 주문을 취소할 수 있다. 출고 상태에 따라 배송지 정보 변경과 취소기능이 제약 받는다. 이 요구사항을 충족하려면 주문은 적어도 출고 상태를 표현할 수 있어야 한다. 다음 요구사항도 상태와 관련이 있다. 1. 고객이 결제를 완료하기 전에는 상품을 준비하지 않는다. 배송지 변경이나 주문 취소 기능은 출고 전에만 가능하다는 제약 규칙이 있으므로 이 규칙을 적용하기 위해 changeShippingInfo()와 cancel()은 veriyNotYetShipped() 메서드를 먼저 호출한다.

public class Order3 {
  private OrderState state;

  public void changeShippingInfo(ShippingInfo newShippingInfo){
    veriyNotYetShipped();
    setShippingInfo(newShippingInfo);
  }

  public void cancel(){
    veriyNotYetShipped();
    this.state = OrderState.CANCELED;
  }

  private void veriyNotYetShipped() {
    if(state != OrderState.PAYMET_WATTING && state != OrderState.PREPARING){
      throw new IllegalStateException("aleady shipped");
    }
  }
}

지금까지 주문과 관련된 요구사항에서 도메인 모델을 점진적으로 만들어 나갔다. 이렇게 아주 조금이지만 도메인에 대해 조금더 잘 알게 된거 같다. 중요한 부분만 서술 할려고 했는데 다 중요해서...ㅠㅠㅠ 다음 편은 좀더 줄여야겠다. 중간중간에 말이 안맞을 수도 있다. 필자가 중요하다고 생각하는 부분만 글로 남기니 만약 더 보고 싶다면 책을 구매하길 바란다. 강추!