[도메인 주도 개발 시작하기] 1장 도메인 모델 시작하기

xyzw·2024년 3월 10일
0

DDD

목록 보기
1/10
post-thumbnail

1.1 도메인이란?

온라인 서점은 개발자가 구현해야 하는 소프트웨어의 대상이다.
온라인 서점 소프트웨어는 온라인으로 책을 판매하는 데 필요한 상품 조회, 구매, 결제, 배송 추적 등의 기능을 제공해야 한다.
➡️ 온라인 서점은 도메인에 해당한다.

도메인: 소프트웨어로 해결하고자 하는 문제 영역, 도메인 전문가가 전문가로 있는 영역

한 도메인은 다시 하위 도메인으로 나눌 수 있다.

한 하위 도메인은 다른 하위 도메인과 연동하여 완전한 기능을 제공한다. 예를 들어 고객이 물건을 구매하면 주문, 결제, 배송, 혜택 하위 도메인의 기능이 엮이게 된다.

특정 도메인을 위한 소프트웨어라고 해서 도메인이 제공해야 할 모든 기능을 직접 구현하는 것은 아니다. 자체적으로 배송 시스템을 구축하기보다는 외부 배송 업체의 시스템을 사용하고 배송 추적 정보를 제공하는 데 필요한 기능만 일부 연동할 수 있다. 마찬가지로 결제 시스템도 결제 대행 업체를 이용해서 처리할 수 있다.

도메인마다 고정된 하위 도메인이 존재하는 것은 아니다. 그리고 하위 도메인을 어떻게 구성할지 여부는 상황에 따라 달라진다.

1.2 도메인 전문가와 개발자 간 지식 공유

온라인 홍보, 정산, 배송 등 각 영역에는 전문가가 있다. 이들 전문가는 해당 도메인에 대한 지식과 경험을 바탕으로 본인들이 원하는 기능 개발을 요구한다. 예를 들어 회계 담당자는 엑셀로 맞추던 정산 금액 계산을 자동화해주는 기능을 요구할 수 있다. AS 기사는 고객에게 보내는 문자 메세지를 빠르게 입력할 수 있는 템플릿 추천 기능을 요구할 수 있다.
개발자는 이런 요구사항을 분석하고 설계하여 코드를 작성하며 테스트하고 배포한다. 이 과정에서 요구사항은 첫 단추와 같다. 요구사항을 올바르게 이해하지 못하면 요구하지 않은 엉뚱한 기능을 만들게 된다. 잘못 개발한 코드를 수정해서 올바르게 고치려 하면 많은 노력이 들기 때문에 코딩에 앞서 요구사항을 올바르게 이해하는 것이 중요하다.

요구사항을 올바르게 이해하려면 개발자와 전문가가 직접 대화해야 한다. 개발자와 전문가 사이에 내용을 전파하는 전달자가 많으면 많을수록 정보가 왜곡되고 손실이 발생하게 되며, 개발자는 최초에 전문가가 요구한 것과는 다른 무언가를 만들게 된다.
도메인 전문가만큼은 아니겠지만 이해관계자와 개발자도 도메인 지식을 갖춰야 한다. 제품 개발과 관련된 도메인 전문가, 관계자, 개발자가 같은 지식을 공유하고 직접 소통할수록 도메인 전문가가 원하는 제품을 만들 가능성이 높아진다.

💡 Garbage in, Garbage out
소프트웨어 분야에서 유명한 문장으로, '잘못된 값이 들어가면 잘못된 결과가 나온다'는 의미를 갖는다.
이 말은 요구사항에도 적용된다. 잘못된 요구사항이 들어가면 잘못된 제품이 나온다.

1.3 도메인 모델

도메인 모델: 특정 도메인을 개념적으로 표현한 것

주문 도메인을 생각해보자. 온라인 쇼핑몰에서 주문을 하려면 상품을 몇 개 살지 선택하고 배송지를 입력한다. 선택한 상품 가격을 이용해서 총 지불 금액을 계산하고, 금액 지불을 위한 결제 수단을 선택한다. 주문한 뒤에도 배송 전이면 배송지 주소를 변경하거나 주문을 취소할 수 있다.

이를 위한 주문 모델을 객체 모델로 구성하면 다음과 같다.

주문(Order)은 주문번호(orderNumber)와 지불할 총금액(totalAmounts)이 있고, 배송정보(ShippingInfo)를 변경(changeShipping)할 수 있음을 알 수 있다. 또한 주문을 취소(cancel)할 수 있다는 것도 알 수 있다.

이는 객체를 이용한 도메인 모델이다.
도메인 모델을 사용하면 여러 관계자들이 동일한 모습으로 도메인을 이해하고 도메인 지식을 공유하는 데 도움이 된다. 도메인을 이해하려면 도메인이 제공하는 기능과 도메인의 주요 데이터 구성을 파악해야 하는데, 이런 면에서 기능과 데이터를 함께 보여주는 객체 모델은 도메인을 모델링하기에 적합하다.

도메인 모델을 객체로만 모델링할 수 있는 것은 아니다. 아래는 상태 다이어그램을 이용해서 주문의 상태 전이를 모델링하고 있다. 이 다이어그램을 보면 상품 준비 중 상태에서 주문을 취소하면 결제 취소가 함께 이루어진다는 것을 알 수 있다.

도메인 모델을 표현할 때 클래스 다이어그램이나 상태 다이어그램과 같은 UML 표기법만 사용해야 하는 것은 아니다. 관계가 중요한 도메인이라면 그래프를 이용해서 도메인을 모델링할 수 있다. 계산 규칙이 중요하다면 수학 공식을 활용해서 도메인 모델을 만들 수도 있다. 도메인을 이해하는 데 도움이 된다면 표현 방식이 무엇인지는 중요하지 않다.

도메인 모델은 기본적으로 도메인 자체를 이해하기 위한 개념 모델이다.
개념 모델을 이용해서 바로 코드를 작성할 수 있는 것은 아니기에 구현 기술에 맞는 구현 모델이 따로 필요하다. 개념 모델과 구현 모델은 서로 다른 것이지만 구현 모델이 개념 모델을 최대한 따르도록 할 수는 잇다.
예를 들어 객체 기반 모델을 기반으로 도메인을 표현했다면 객체 지향 언어를 이용해 개념 모델에 가깝게 구현할 수 있다. 비슷하게 수학적인 모델을 사용한다면 함수를 이용해서 도메인 모델과 유사한 구현 모델을 만들 수 있다.

1.4 도메인 모델 패턴

일반적인 애플리케이션의 아키텍처 영역: 표현, 응용, 도메인, 인프라스트럭처-DB

각 영역의 역할

영역설명
사용자 인터페이스 또는 표현사용자의 요청을 처리하고 사용자에게 정보를 보여준다. 여기서 사용자는 소프트웨어를 사용하는 사람뿐만 아니라 외부 시스템일 수도 있다.
응용사용자가 요청한 기능을 실행한다. 업무 로직을 직접 구현하지 않으며 도메인 계층을 조합해서 기능을 실행한다.
도메인시스템이 제공할 도메인 규칙을 구현한다.
인프라스트럭처데이터베이스나 메시징 시스템과 같은 외부 시스템과의 연동을 처리한다.

앞서 살펴본 도메인 모델이 도메인 자체를 이해하는 데 필요한 개념 모델을 의미한다면,
지금 살펴볼 도메인 모델은 마틴 파울러가 쓴 『엔터프라이즈 애플리케이션 아키텍처 패턴』(위키북스, 2015) 책의 도메인 모델 패턴을 의미한다. 도메인 모델은 아키텍처 상의 도메인 계층을 객체 지향 기법으로 구현하는 패턴을 말한다.

도메인 계층은 도메인의 핵심 규칙을 구현한다.
주문 도메인의 경우 '출고 전에 배송지를 변경할 수 있다'라는 규칙과 '주문 취소는 배송 전에만 할 수 있다'라는 규칙을 구현한 코드가 도메인 계층에 위치하게 된다.
이런 도메인 규칙을 객체 지향 기법으로 구현하는 패턴이 도메인 모델 패턴이다. 

public class Order {
	private OrderState state;
    private ShippingInfo shippingInfo;
    
    public void changeShippingInfo(ShippingInfo newShippingInfo) {
    	if (!state.isShippingChangeable()) {
        	throw new IllegalStateException("can't change shipping in " + state);
        }
        this.shippingInfo = newShippingInfo;
    }
	...
}

public enum OrderState {
	PAYMENT_WAITING {
    	public boolean isShippingChangeable() {
        	return true;
        }
    },
    PREPARING {
    	public boolean isShippingChangeable() {
        	return true;
        }
    },
    SHIPPED, DELIVERING, DELIVERY_COMPLETED;
    
    public boolean isShippingChangeable() {
    	return false;
    }
}

이 코드는 주문 도메인의 일부 기능을 도메인 모델 패턴으로 구현한 것이다.

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

다음은 Order 클래스에서 판단하도록 수정한 코드를 보여주고 있다. 

public class Order {
	private OrderState state;
    private ShippingInfo shippingInfo;
    
    public void changeShippingInfo(ShippingInfo newShippingInfo) {
    	if (!isShippingChangeable()) {
        	throw new IllegalStateException("can't change shipping in " + state);
        }
        this.shippingInfo = newShippingInfo;
    }
    
    private boolean isShippingChangeable() {
    	return state == OrderState.PAYMENT_WAITING ||
        	state == OrderState.PREPARING;
    }
	...
}


public enum OrderState {
	PAYMENT_WAITING, PREPARING, SHIPPED, DELIVERING, DELIVERY_COMPLETED;
}

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

배송지 변경 가능 여부를 판단하는 기능이 Order에 있든 OrderState에 있든 중요한 점은 주문과 관련된 중요 업무 규칙을 주문 도메인 모델인 Order나 OrderState에서 구현한다는 점이다.
핵심 규칙을 구현한 코드는 도메인 모델에만 위치하기 때문에 규칙이 바뀌거나 규칙을 확장해야 할 때 다른 코드에 영향을 덜 주고 변경 내역을 모델에 반영할 수 있게 된다.

💡 개념 모델과 구현 모델
개념 모델은 순수하게 문제를 분석한 결과물이다. 개념 모델은 데이터베이스, 트랜잭션 처리, 성능, 구현 기술과 같은 것을 고려하고 있지 않기 때문에 실제 코드를 작성할 때 개념 모델을 있는 그대로 사용할 수 없다. 그래서 개념 모델을 구현 가능한 형태의 모델로 전환하는 과정을 거치게 된다.
개념 모델을 만들 때 처음부터 완벽하게 도메인을 표현하는 모델을 만드는 것은 불가능하다. 소프트웨어를 개발하는 동안 개발자와 관계자들은 해당 도메인을 더 잘 이해하게 된다. 프로젝트 초기에 완벽한 도메인 모델을 만들더라도 결국 도메인에 대한 새로운 지식이 쌓이면서 모델을 보완하거나 변경하는 일이 발생한다.
따라서 처음부터 완벽한 개념 모델을 만들기보다는 전반적인 개요를 알 수 있는 수준으로 개념 모델을 작성해야 한다. 프로젝트 초기에는 개요 수준의 개념 모델로 도메인에 대한 전체 윤곽을 이해하는 데 집중하고, 구현하는 과정에서 개념 모델을 구현 모델로 점진적으로 발전시켜 나가야 한다.

1.5 도메인 모델 도출

도메인을 모델링할 때 기본이 되는 작업은 모델을 구성하는 핵심 구성요소, 규칙, 기능을 찾는 것이다. 이 과정은 요구사항에서 출발한다.

주문 도메인과 관련된 몇 가지 요구사항을 보자.

  • 최소 한 종류 이상의 상품을 주문해야 한다.
  • 한 상품을 한 개 이상 주문할 수 있다.
  • 총 주문 금액은 각 상품의 구매 가격 합을 모두 더한 금액이다.
  • 주문할 때 배송지 정보를 반드시 지정해야 한다.
  • 배송지 정보는 받는 사람 이름, 전화번호, 주소로 구성된다.
  • 출고를 하면 배송지를 변경할 수 없다.
  • 출고 전에 주문을 취소할 수 있다.
  • 고객이 결제를 완료하기 전에는 상품을 준비하지 않는다.

이 요구사항에서 알 수 있는 것은 주문은 '출고 상태로 변경하기', '배송지 정보 변경하기', '주문 취소하기', '결제 완료하기' 기능을 제공한다는 것이다.
아직 상세 구현까지 할 수 있는 수준은 아니지만 Order에 관련 기능을 메서드로 추가할 수 있다.

public class Order {
	public void changeShipped() {}
    public void changeShippingInfo(ShippingInfo newShipping) {}
    public void cancel() {}
    public void completePayment() {}
}

다음 요구사항은 주문 항목이 어떤 데이터로 구성되는지 알려준다.

  • 한 상품을 한 개 이상 주문할 수 있다.
  • 각 상품의 구매 가격 합은 상품 가격에 구매 개수를 곱한 값이다.

두 요구사항에 따르면 주문 항목을 표현하는 OrderLine은 적어도 주문할 상품, 상품의 가격, 구매 개수를 포함해야 한다. 추가로 각 구매 항목의 구매 가격도 제공해야 한다.
이를 구현한 OrderLine은 다음과 같다.

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 = amounts;
    }
    
    private int calculateAmounts() {
    	return price * quantity;
    }
    
    public int getAmounts() {}

}

OrderLine은 한 상품(product 필드)을 얼마에(price 필드) 몇 개 살지(quantity 필드)를 담고 있고 calculateAmounts() 메서드로 구매 가격을 구하는 로직을 구현하고 있다.

다음 요구사항은 Order와 OrderLine과의 관계를 알려준다.

  • 최소 한 종류 이상의 상품을 주문해야 한다.
  • 총 주문 금액은 각 상품의 구매 가격 합을 모두 더한 금액이다.

한 종류 이상의 상품을 주문할 수 있으므로 Order는 최소 한 개 이상의 OrderLine을 포함해야 한다. 또한 총 주문 금액은 OrderLine에서 구할 수 있다.
두 요구사항은 Order에 다음과 같이 반영할 수 있다.

public class Order {
	private List<OrderLine> orderLines;
    private Money totalAmounts;
    
    public Order(List<OrderLine> orderLines) {
    	setOrderLines(orderLines);
    }
    
    private void setOrderLines(List<OrderLine> orderLines) {
		verifyAtLeastOneOrMoreOrderLines(orderLines);
        this.orderLines = orderLines;
        calculateTotalAmounts();
    }
    
    private void verifyAtLeastOneOrMoreOrderLines(List<OrderLine> orderLines) {
    	if(orderLines == null || orderLines.isEmpty()) {
        	throw new IllegalArgumentException("no OrderLine");
        }
    }
    
    private void calculateTotalAmounts() {
    	int sum = orderLines.stream()
        					.mapToint(x -> x.getAmounts())
                            .sum();
        this.totalAmounts = new Money(sum);
    }
    ...
}

Order는 한 개 이상의 OrderLine을 가질 수 있으므로 Order를 생성할 때 OrderLine 목록을 List로 전달한다.
생성자에서 호출하는 setOrderLines() 메서드는 요구사항에 정의한 제약 조건을 검사한다.
요구사항에 따르면 최소 한 종류 이상의 상품을 주문해야 하므로 verifyAtLeastOneOrMoreOrderLines() 메서드를 이용해서 OrderLine이 한 개 이상 존재하는지 검사한다.
또한 calculateTotalAmounts() 메서드를 이용해서 총 주문 금액을 계산한다.
배송지 정보는 이름, 전화번호, 주소 데이터를 가지므로 ShippingInfo 클래스를 다음과 같이 정의할 수 있다.

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

앞서 요구사항 중에 '주문할 때 배송지 정보를 반드시 지정해야 한다'라는 내용이 있다. 이는 Order를 생성할 때 OrderLine의 목록뿐만 아니라 ShippingInfo도 함께 전달해야 함을 의미한다. 이를 생성자에 반영한다.

public class Order {
	private List<OrderLine> orderLines;
    private ShippingInfo shippingInfo;
    ...
    
    public Order(List<OrderLine> orderLines, ShippingInfo shippingInfo) {
    	setOrderLines(orderLines);
        setShippingInfo(shippingInfo);
    }
    
    private void setShippingInfo(ShippingInfo shippingInfo) {
    	if(shippingInfo == null) {
        	throw new IllegalArgumentException("no OrderLine");
        }
        this.shippingInfo = shippingInfo;
    }
    ...

생성자에서 호출하는 setShippingInfo() 메서드는 ShippingInfo가 null이면 exception이 발생하는데, 이렇게 함으로써 '배송지 정보 필수'라는 도메인 규칙을 구현한다.

도메인을 구현하다 보면 특정 조건이나 상태에 따라 제약이나 규칙이 달리 적용되는 경우가 많다. 주문 요구사항에서는 다음 내용이 제약과 규칙에 해당된다.

  • 출고를 하면 배송지 정보를 변경할 수 없다.
  • 출고 전에 주문을 취소할 수 있다.

이 요구사항은 출고 상태가 되기 전과 후의 제약사항을 기술하고 있다. 출고 상태에 따라 배송지 정보 변경 기능과 주문 취소 기능은 다른 제약을 갖는다. 이 요구사항을 충족하려면 주문은 최소한 출고 상태를 표현할 수 있어야 한다.

다음 요구사항도 상태와 관련이 있다.

  • 고객이 결제를 완료하기 전에는 상품을 준비하지 않는다.

이 요구사항은 결제 완료 전을 의미하는 상태와 결제 완료 내지 상품 준비 중이라는 상태가 필요함을 알려준다. 다른 요구사항을 확인해서 추가로 존재할 수 있는 상태를 분석한 뒤, 다음과 같이 열거 타입을 이용해서 상태 정보를 표현할 수 있다.

public enum OrderState {
	PAYMENT_WAITING, PREPARING, SHIPPED, DELIVERING, DELIVERY_COMPLETED, 
    CANCELED;
}

배송지 변경이나 주문 취소 기능은 출고 전에만 가능하다는 제약 규칙이 있으므로 이 규칙을 적용하기 위해 changeShippingInfo()와 cancel()은 verifyNotYetShipped() 메서드를 먼저 실행한다.

public class Order {
	private OrderState state;
    
    public void changeShippingInfo(ShippingInfo newShippingInfo) {
    	verifyNotYetShipped();
        setShippingInfo(newShippingInfo);
    }
    
    public void cancel() {
    	verifyNotYetShipped();
        this.state = OrderState.CANCELED;
    }
    
    private void verifyNotYetShipped() {
    	if(state != OrderState.PAYMENT_WAITING && state != OrderState.PREPARING)
        	throw new IllegalStateException("already shipped");
    }
}

지금까지 주문과 관련된 요구사항에서 도메인 모델을 점진적으로 만들어 나갔다.
이렇게 만든 모델은 요구사항 정련을 위해 도메인 전문가나 다른 개발자와 논의하는 과정에서 공유하기도 한다.
모델을 공유할 때는 화이트보드나 위키와 같은 도구를 사용해서 누구나 쉽게 접근할 수 있도록 하면 좋다.

코드를 보면서 도메인을 깊게 이해하게 되므로 코드 자체도 문서화의 대상이 된다.
도메인 지식이 잘 묻어나도록 코드를 작성하지 않으면 코드의 동작 과정은 해석할 수 있어도 도메인 관점에서 왜 코드를 그렇게 작성했는지 이해하는 데는 도움이 되지 않는다.
단순히 코드를 보기 좋게 작성하는 것뿐만 아니라 도메인 관점에서 코드가 도메인을 잘 표현해야 비로소 코드의 가독성이 높아지고 문서로서 코드가 의미를 갖는다.

1.6 엔티티와 밸류

도출한 모델은 크게 엔티티와 밸류로 구분할 수 있다.

앞서 요구사항 분석 과정에서 만든 모델은 아래와 같은데, 이 그림에는 엔티티도 존재하고 밸류도 존재한다.

엔티티와 밸류를 제대로 구분해야 도메인을 올바르게 설계하고 구현할 수 있다.

엔티티

엔티티의 가장 큰 특징은 식별자를 가진다는 것이다.
식별자는 엔티티 객체마다 고유해서 각 엔티티는 서로 다른 식별자를 갖는다.
예를 들어 Order가 엔티티가 되며 orderNumber가 식별자이자 속성이다.

엔티티의 식별자는 바뀌지 않고 고유하기 때문에 엔티티를 생성하고 속성을 바꾸고 삭제할 때까지 식별자는 유지되고, 두 엔티티 객체의 식별자가 같으면 두 엔티티는 같다고 판단할 수 있다.

엔티티를 구현한 클래스는 다음과 같이 식별자를 이용해서 equals() 메서드와 hashCode() 메서드를 구현할 수 있다.

public class Order {
	private String orderNumber;
    
    @Override
    public boolean equals(Object obj) {
    	if(this == obj) return true;
        if(obj == null) return false;
        if(obj.getClass() != Order.class) return false;
        Order other = (Order)obj;
        if(this.orderNumber == null) return false;
        return this.orderNumber.equals(other.orderNumber);
    }
    
    @Override
    public int hashCode() { // 객체의 주소값을 변환하여 생성한 객체의 고유한 정수값
    	final int prime = 31;
        int result = 1;
        result = prime * result + ((orderNumber == null) ? 0 : orderNumber.hashCode());
        return result;
    }
}

엔티티의 식별자 생성

엔티티의 식별자를 생성하는 시점은 도메인의 특징과 사용하는 기술에 따라 달라진다. 흔히 식별자는 다음 중 한 가지 방식으로 생성한다.

  • 특정 규칙에 따라 생성
  • UUID나 Nano ID와 같은 고유 식별자 생성기 사용
  • 값을 직접 입력
  • 일련번호 사용(시퀀스나 DB의 자동 증가 칼럼 사용)

주문번호, 운송장번호, 카드 번호와 같은 식별자는 특정 규칙에 따라 생성한다. 이 규칙은 도메인에 따라 다르고, 같은 주문번호라도 회사마다 다르다.

흔히 사용하는 규칙은 현재 시간과 다른 값을 함께 조합하는 것이다.

UUID를 사용해서 식별자를 생성할 수도 있는데, 다수의 개발 언어가 UUID 생성기를 제공하고 있으므로 마땅한 규칙이 없다면 UUID를 식별자로 사용해도 된다. 자바는 java.util.UUID 클래스를 사용해서 UUID를 생성할 수 있다.

UUID uuid = UUID.randomUUID();
String strUuid = uuid.toString();

회원의 아이디나 이메일과 같은 식별자는 값을 직접 입력한다. 사용자가 직접 입력하는 값이기 때문에 식별자를 중복해서 입력하지 않도록 사전에 방지하는 것이 중요하다.

일련번호를 식별자로 사용하기도 한다. 일련번호 방식은 주로 데이터베이스가 제공하는 자동 증가 기능을 사용한다. 예를 들어 오라클은 시퀀스를 이용하고, MySQL은 자동 증가 칼럼을 이용한다.

자동 증가 칼럼을 제외한 다른 방식은 식별자를 먼저 만들고 엔티티 객체를 생성할 때 식별자를 전달한다. 반면 자동 증가 칼럼은 DB 테이블에 데이터를 삽입해야 비로소 값을 알 수 있기 때문에 테이블에 데이터를 추가하기 전에는 식별자를 알 수 없다. 이것은 엔티티 객체를 생성할 때 식별자를 전달할 수 없음을 의미한다.

밸류 타입

ShippingInfo 클래스는 받는 사람과 주소에 대한 데이터를 갖고 있다.

public class ShippingInfo {
	// 받는 사람
	private String receiverName;
    private String receiverPhoneNumber;
    
    // 주소
    private String shippingAddress1;
    private String shippingAddress2;
    private String shippingZipcode;
    
    ...
}

receiverName과 receiverPhoneNumber 필드는 개념적으로 받는 사람을 의미하고, shippingAddress1, shippingAddress2, shippingZipcode 필드는 주소라는 하나의 개념을 표현한다.

밸류 타입은 개념적으로 완전한 하나를 표현할 때 사용한다.
예를 들어 받는 사람을 위한 밸류 타입인 Receiver를 다음과 같이 작성할 수 있다.

public class Receiver {
	private String name;
	private String phoneNumber;
    
    public Receiver(String name, String phoneNumber) {
    	this.name = name;
        this.phoneNumber = phoneNumber;
    }
    
    public String getName() {
    	return name;
    }
    
    public String getPhoneNumber() {
    	return phoneNumber;
    }
}

Receiver는 '받는 사람'이라는 도메인 개념을 표현한다. 밸류 타입을 사용함으로써 개념적으로 완전한 하나를 잘 표현할 수 있는 것이다.

public class Address {
    private String address1;
    private String address2;
    private String zipcode;
    
    public Address(String address1, String address2, String zipcode) {
    	this.address1 = address1;
        this.address2 = address2;
        this.zipcode = zipcode;
    }
    ...
}

ShippingInfo의 주소 관련 데이터도 Address 밸류 타입을 사용해서 보다 명확하게 표현할 수 있다.

밸류 타입을 이용해서 ShippingInfo 클래스를 다시 구현해보자.

public class ShippingInfo {
	private Receiver receiver;
    private Address address;
    
    ...
}

배송정보가 받는 사람과 주소로 구성된다는 것을 쉽게 알 수 있다.

밸류 타입이 꼭 두 개 이상의 데이터를 가져야 하는 것은 아니다. 의미를 명확하게 표현하기 위해 밸류 타입을 사용하는 경우도 있다.

public class OrderLine {
	private Product product;
    private int price;
    private int quantity;
    private int amounts;
    ...

OrderLine의 price와 amounts는 int 타입의 숫자를 사용하고 있지만 이들은 돈을 의미하는 값이다. 따라서 돈을 의미하는 Money 타입을 만들어 사용하면 코드를 이해하는 데 도움이 된다.

public class Money {
	private int value;
    
    public Money(int value) {
    	this.value = value;
   	}
    
    public int getValue() {
    	return this.value;
    }
}

public class OrderLine {
	private Product product;
    private Money price;
    private int quantity;
    private Money amounts;
    ...

밸류 타입의 또 다른 장점은 밸류 타입을 위한 기능을 추가할 수 있다는 것이다. 예를 들어 Money 타입은 다음과 같이 돈 계산을 위한 기능을 추가할 수 있다.

public class Money {
	private int value;
    
    public Money add(Money money) {
    	return new Money(this.value + money.value);
    }
    
    public Money multiply(int multiplier) {
    	return new Money(value * multiplier);
    }
}

밸류 객체의 데이터를 변경할 때는 기존 데이터를 변경하기보다는 변경한 데이터를 갖는 새로운 밸류 객체를 생성하는 방식을 선호한다. 예를 들어 앞서 Money 클래스의 add() 메서드를 보면 Money를 새로 생성하고 있다.

public class Money {
	private int value;
    
    public Money add(Money money) {
    	return new Money(this.value + money.value);
    }
    
    // value를 변경할 수 있는 메서드 없음
}

Money처럼 데이터 변경 기능을 제공하지 않는 타입을 불변이라고 표현한다. 밸류 타입을 불변으로 구현하는 가장 중요한 이유는 안전한 코드를 작성할 수 있다는 것이다. 예를 들어 OrderLine을 생성하려면 다음 코드처럼 Money 객체를 전달해야 한다.

Money price = ...;
OrderLine line = new OrderLine(product, price, quantity);

그런데 만약 Money가 setValue()와 같은 메서드를 제공해서 값을 변경할 수 있다면 price 값이 잘못 반영되는 상황이 발생할 수 있다.

이런 문제가 발생하는 것을 방지하려면 OrderLine 생성자는 다음과 같이 새로운 Money 객체를 생성하도록 코드를 작성해야 한다.

public class OrderLine {
	...
	private Money price;
    
    public OrderLine(Product product, Money price, int quantity) {
    	this.product = product;
        // 새로운 Money 객체 생성
        this.price = new Money(price.getValue());
        this.quantity = quantity;
        this.amounts = calculateAmounts();
    }
}

Money가 불변 객체가 아니라면, price 파라미터가 변경될 때 발생하는 문제를 방지하기 위해 데이터를 복사한 새로운 객체를 생성해야 한다.

Money가 불변이면 이런 코드를 작성할 필요가 없다. Money의 데이터를 바꿀 수 없기 때문에 파라미터로 전달받은 price를 안전하게 사용할 수 있다.

두 밸류 객체를 비교할 때는 모든 속성이 같은지 비교한다.

public class Receiver {
	private String name;
	private String phoneNumber;
    
    public boolean equals(Object other) {
        if(other == null) return false;
    	if(this == other) return true;
        if(! (other instanceof Receiver)) return false;
        Receiver that = (Receiver)other;
        return this.phoneNumber.equals(that.phoneNumber);
    }
    ...
}

엔티티 식별자와 밸류 타입

엔티티 식별자의 실제 데이터는 String과 같은 문자열로 구성된 경우가 많다. Money가 단순 숫자가 아닌 도메인의 돈을 의미하는 것처럼 이런 식별자는 단순한 문자열이 아니라 도메인에서 특별한 의미를 지니는 경우가 많기 때문에 식별자를 위한 밸류 타입을 사용해서 의미가 잘 드러나도록 할 수 있다.
예를 들어 주문번호를 표현하기 위해 String 대신 OrderNo 밸류 타입을 사용하면 타입을 통해 해당 필드가 주문번호라는 것을 알 수 있다.

public class Order {
	private OrderNo id;
    ...
    
    public OrderNo getId() {
    	return id;
    }
}

도메인 모델에 set 메서드 넣지 않기

도메인 모델에 get/set 메서드를 무조건 추가하는 것은 좋지 않다. 특히 set 메서드는 도메인의 핵심 개념이나 의도를 코드에서 사라지게 한다. 또, 도메인 객체를 생성할 때 온전하지 않은 상태가 될 수 있다.
도메인 객체가 불완전한 상태로 사용되는 것을 막으려면 생성 시점에 필요한 것을 전달해주어야 한다. 즉 생성자를 통해 필요한 데이터를 모두 받아야 한다.

불변 밸류 타입을 사용하면 자연스럽게 밸류 타입에는 set 메서드를 구현하지 않는다. set 메서드를 구현해야 할 특별한 이유가 없다면 불변 타입의 장점을 살릴 수 있도록 밸류 타입은 불변으로 구현한다.

💡 DTO의 get/set 메서드
DTO는 Data Transfer Object의 약자로 프레젠테이션 계층과 도메인 계층이 데이터를 서로 주고받을 때 사용하는 일종의 구조체이다. 요즘 개발 프레임워크나 개발 도구는 set 메서드가 아닌 private 필드에 직접 값을 할당할 수 있는 기능을 제공하고 있어 set 메서드가 없어도 프레임워크를 이용해서 데이터를 전달받을 수 있다. 이러한 기능을 사용하면 DTO도 불변 객체가 되어 불변의 장점을 DTO까지 확장할 수 있다.

1.7 도메인 용어와 유비쿼터스 언어

코드를 작성할 때 도메인에서 사용하는 용어는 매우 중요하다. 도메인에서 사용하는 용어를 코드에 반영하지 않으면 그 코드는 개발자에게 코드의 의미를 해석해야 하는 부담을 준다.
예를 들어 OrderState를 STEP1, ... , STEP6로 구현했다고 가정하자. 실제 주문 상태는 '결제 대기 중', '상품 준비 중', '출고 완료됨', '배송 중', '배송 완료됨', '주문 취소됨'인데 이 코드는 개발자가 전체 상태를 6단계로 보고 코드로 표현한 것이다. 그런데 이를 이해하려면 STEP1과 STEP2가 각각 '결제 대기 중' 상태와 '상품 준비 중' 상태를 의미한다는 것을 알아야 한다.
다음 코드처럼 도메인 용어를 사용해서 OrderState를 구현하면 불필요한 변화 과정을 거치지 않아도 된다.

public enum OrderState {
	PAYMENT_WAITING, PREPARING, SHIPPED, DELIVERING, DELIVERY_COMPLETED;
}

도메인에서 사용하는 용어를 최대한 코드에 반영하면 코드를 도메인 용어로 해석하거나 도메인 용어를 코드로 해석하는 과정이 줄어든다. 이는 코드의 가독성을 높여서 코드를 분석하고 이해하는 시간을 줄여준다. 최대한 도메인 용어를 사용해서 도메인 규칙을 코드로 작성하게 되므로 버그도 줄어든다.

에릭 에반스는 도메인 주도 설계에서 언어의 중요함을 강조하기 위해 유비쿼터스 언어라는 용어를 사용했다. 전문가, 관계자, 개발자가 도메인과 관련된 공통의 언어를 만들고 대화, 문서, 도메인 모델, 코드, 테스트 등 모든 곳에서 같은 용어를 사용한다. 이렇게 하면 소통 과정에서 발생하는 용어의 모호함을 줄일 수 있고 개발자는 도메인과 코드 사이에서 불필요한 해석 과정을 줄일 수 있다.

profile
xyzw
다음 포스트

[도메인 주도 개발 시작하기] 2장 아키텍처 개요

0개의 댓글