상위 수준의 개념을 이용해서 전체 모델을 정리하면 전반적인 관계를 이해하는데 도움이 된다.
상위 모델에 대한 이해 없이 아래 그림만 보고 상위 수준에서 개념을 파악하려면 더 오랜 시간이 걸린다.
도메인 객체 모델이 복잡해지면 개별 구성요소 위주로 모델을 이해하게 되고 전반적인 구조나 큰 수준에서 도메인 간의 관계를 파악하기 어려워진다.
주요 도메인 개념 간이ㅡ 관계를 파악하기 어렵다는 것은 곧 코드를 변경하고 확장하는 것이 어려워진다는 것을 의미한다. 상위 수준에서 모델이 어떻게 엮여 있는지 알아야 전체 모델을 망가뜨리지 않으면서 추가 요구사항을 모델에 반영할 수 있는데 세부적인 모델만 이해한 상태로는 코드를 수정하기 두렵기 때문에 코드 변경을 최대한 회피하는 쪽으로 요구사항을 협의하게 된다.
복잡한 도메인을 이해하고 관리하기 쉬운 단위로 만들려면 상위 수준에서 모델을 조망할 수 있는 방법이 필요한데, 그 방법이 바로 애그리거트이다.
이 사진은 애그리거트로 묶어서 다시 표현한 것이다. 동일한 모델이지만 애그리거트를 사용함으로써 모델간의 관계를 개별 모델 수준뿐만 아니라 상위 수준에서도 이해할 수 있게 된다.
애그리거트는
경계를 설정할 떄 기본이 되는 것은 도메인 규칙과 요구사항이다.
'A가 B를 갖는다' 로 설계할 수 있는 요구사항이 있다면, 이것은 반드시 A와 B가 한 애그리거트에 속한다는 것을 의미하는 것은 아니다.
좋은 예는 상품과 리뷰다. 상품 상세 정보와 함께 리뷰내용을 보여줘야하는 요구사항이 있다고 하자. product 와 review 는 함께 생성 되지 않고 함께 변경되지도 않는다. 그리고 product를 변경하는 주체는 상품 담당자이고, review를 생성하고 변경하는 주체는 고객이다.
변경에 서로 영향을 주지 않기 떄문에 한 애그리거트에 속하는게 아닌 서로 다른 애그리거트에 속한다.
애그리거트에 속한 모든 객체가 일관된 상태를 유지하려면 애그리거트 전체를 관리할 주체가 필요한데 이 책임을 지는 것이 바로 애그리거트 루트 엔티티이다. 애그리거트 루트 엔티티는 애그리거트의 대표 엔티티로 애그리거트에 속한 객체는 애그리거트 루트 엔티티에 직접 또는 간접으로 속한다.
애그리거트 루트의 핵심 역할은 애그리거트의 일관성이 깨지지 않도록 하는 것이다. 이를 위해 애그리거트 루트는 애그리거트가 제공해야 할 도메인 기능을 구현한다. 예를 들어 주문 애그리거트는 배송지 변경, 상품 변경과 같은 기능을 제공하는데 애그리거트 루트인 Order가 이 기능을 구현한 매서드를 제공한다.
애그리거트 루트가 아닌 다른 객체가 애그리거트 속한 객체를 직접 변경하면 안된다. 이는 애그리거트 루트가 강제하는 규칙을 적용할 수 없어 모델의 일관성을 깨는 원인이 된다.
val shippingInfo = order.getShippingInfo()
shippingInfo.address = newAddress
이 코드는 애그리거트 루트인 Order에서 ShippingInfo 를 가져와 직접 정보를 변경하고 있다. 주문 상태에 상관없이 배송지 변경할 수가 있는데, 이는 논리적인 데이터 일관성을 깨뜨리는 행위가 된다.
val shippingInfo = order.getShippingInfo()
if(state != OrderState.PATMENT_WATTING && state != OderState.WATTING) {
throw IllegalArguementException()
}
shippingInfo.address = newAddress
위 코드 처럼 일관성을 지키기 위해 상태 확인 로직을 Application 서비스에 추가 구현할 수도 있지만, 이는 동일한 검사 로직이 여러 Application 서비스에 중복 구현될 가능성이 높아져 상황을 더 악화시킬 수도 있다.
불필요한 중복을 피하고 애그리거트 루트를 통해서만 도메인 로직을 구현하게 만들려면 도메인 모델에 대한 다음의 두가지를 습관적으로 적용해야 한다.
public set 메서드는 중요 도메인의 의미나 의도를 표현하지 못하고 도메인 로직이 도메인 객체가 아닌 Application 영역이나 Presentation 영역으로 분산되게 만드는 원인이 된다.
public set 메서드를 사용하지 않게 되면 cancel, changePassword 와 같은 의미가 드러나는 메서드를 사용해 구현할 빈도, 가능성이 높아진다.
public set 메서드를 만들지 않는 것의 연장으로 벨류는 불변 타입으로 구현한다. 밸류 객체의 값을 변경할 수 없으면 애그리거트 루트에서 밸류 객체를 구해도 값을 변경할 수 없기 떄문에 애그리거트 외부에서 밸류 객체 상태를 변경할 수 없게 된다.
애그리거트 외부에서 내부 상태를 함부로 바꾸지 못하므로 애그리거트의 일관성이 꺠질 가능성이 그만큼 줄어든다. 밸류 객체가 불변이면 밸류 객체의 값을 변경하는 방법은 새로운 밸류 객체를 할당하는 것 뿐이다.
public Order {
private ShippingInfo shippingInfo;
public void changeshippingInfo(ShippingInfo newShippingInfo) {
verifyNotYetShipped();
setShippingInfo(newShippingInfo);
}
// set 메서드의 접근 허용 범위는 private이다.
private void setShippingInfo(ShippingInfo newShippingInfo) {
// 밸류가 불변이면, 새로운 객체를 할당해서 값을 변경해야 한다.
// 불변이므로 this.shippingInfo.setAddress(newShippedInfo.getAddress())와 같은 코드를 사용할 수 없다.
this.shippingInfo = newShippingInfo;
}
}
밸류 타입의 내부 상태를 변경하려면 애그리거트 루트를 통해서만 가능하다.
그러므로 애그리거트 루트가 도메인 규칙을 올바르게만 구현하면 애그리거트 전체의 일관성을 올바르게 유지할 수 있다.
애그리거트 루트는 애그리거트 내부의 다른 객체를 조합해서 기능을 완성한다.
Order는 총 주문 금액을 구하기 위해 OrderLine 목록을 사용한다.
애그리거트 루트가 기능 실행을 위임하기도 한다. 이 경우 Order의 changeOrderLines 메서드는 다음과 같이 내부의 orderLines 필드에 상태 변경을 위임하는 방식으로 기능을 구현한다.
하지만 이 코드는 주문의 OrderLine 목록이 바뀌는데 총합은 계산하지 않는 버그를 만든다.
이런 버그가 생기지 않도록 애초에 애그리거트 외부에서 OrderLine 목록을 가져와 변경할 수 없도록 가져온 OrderLines를 불변으로 만든다. 패키지나 protected 범위를 사용해 애그리거트 외부에서 상태 변경 가능 실행을 방지할 수 있다.
흠.. 이건 좀더 알아보자.
트랜잭션 범위는 작을수록 좋다.
한개의 테이블을 수정할 때에는 트랜잭션 충돌을 막기 위해 잠그는 대상이 한 개 테이블의 한행으로 한정되지만, 세 개의 테이블을 수정하면 잠금 대상이 더 많아진다.
잠금 대상이 많아진다는 것은 그만큼 동시에 처리할 수 있는 트랜잭션 개수가 줄어든다는 것을 뜻하고 이는 전체적인 성능을 떨어뜨린다.
동일하게 한 트랜잭션에서는 한 개의 애그리거트만 수정해야 한다. 즉, 애그리거트에서 다른 애그리거트를 변경하지 않는다는 것을 뜻한다.
한 애그리거트에서 다른 애그리거트까지 변경하게 된다면 자신의 책임 범위를 넘어 다른 애그리거트의 상태까지 관리하게 되는데 이는 최대한 독립적이어야 하는 애그리거트의 결합도가 높아지게 되는 원인이 된다. 결합도가 높아지면 향후 수정 비용이 증가하기 때문에 애그리거트에서 다른 애그리거트를 수정하면 안된다.
부득이하게 한 트랜잭션에 두 개의 이상의 애그리거트를 수정해야 한다면
애그리거트에서 다른 애그리거트를 직접 수정하는 것이 아닌 Application 서비스에서 두 애그리거트를 수정하도록 구현해야한다.
public class ChangeOrderService {
// 두 개이상의 애그리거트를 변경해야 한다.
// Appliaction 서비스에서 각 애그리거트의 상태를 변경한다.
@Transactional
public void changeShippingInfo(OrderId id, ShippingInfo newShippingInfo, boolean useNewShippingAddrAsMemberAddr) {
Order order = orderRepository.findbyId(id);
if (order == null) throw new OrderNotFoundException();
order.shipTo(newShippingInfo);
if (userNewshippingAddrAsMemberAddr) {
order.getOrderer().getCustomer().changeAddress(newShippingInfo.getAddress());
}
}
}
도메인 이벤트를 사용하면 한 트랜젝션에 한개의 애그리거트를 수정하면서도
동기나 비동기로 다른 애그리거트 상태를 변경하는 코드를 작성할 수 있다. (10장 참조)
일반적으로 한 트랜잭션에서 한 개의 애그리거트를 변경하는 것을 권장하지만 다음의 경우에는 한 트랜잭션에서 두 개 이상의 애그리거트를 변경하는 것을 고려할 수 있다.
애그리거트는 개념상 완전한 한 개의 도메인 모델을 표현하므로
객체의 영속성을 처리하는 리포지터리는 애그리거트 단위로 존재한다. 예를들어 Order, OrderLine을 물리적으로 각각의 별도 DB 테이블에 저장하더라도 Order 가 애그리거트 루트이고 OrderLine은 애그리거트에 속하는 구성 요소이므로 Order를 위한 리포지터리만 존재한다.
리포지터리는 애그리거트 전체를 저장소에 영속화하고, 애그리거트를 읽을 수 있게 save, findById 적어도 두개 메서드를 제공해야 한다.
어떤 기술을 이용해 리포지터리를 구현하느냐에 따라 애그리거트의 구현도 영향을 받는다.
ORM 기술 중의 하나인 JPA/하이버네이트를 사용하면 데이터베이스 관계형 모델에 객체 도메인 모델을 맞춰야하는 경우도 있다.
애그리거트는 개념적으로 하나이므로 리포지터리는 애그리거트 전체를 저장소에 영속화해야 한다.
Order 애그리거트와 관련된 테이블이 세 개라면 리포지터리를 통해 Order 애그리거트를 저장할 때 애그리거트 루트와 매핑되는 테이블 뿐만 아니라 애그리거트에 속한 모든 구성요소를 위한 테이블에 데이터를 저장해야 한다.
애그리거트를 구하는 리포지터리 메서드는 완전한 애그리거트를 제공해야 한다. 즉 아래 코드를 실행하면 order애그리거트는 orderLine, Orderer 등 모든 구성요소를 포함하고 있어야 한다.
// 리포지터리는 완전한 order를 제공해야 한다.
Order order = orderRepository.findById(orderId);
// order가 온전한 애그리거트가 아니면
// 기능 실행 도중 NPE같은 문제가 발생한다.
order.cancel();
한 애그리거트에서 다른 애그리거트 참조한다는 것은 애그리거트의 루트를 참조한다는 것과 같다.
필드를 이용해 다른 애그리거트를 직접 참조하는 것은 개발자에게 구현의 편리함을 제공한다.
JPA를 사용하면 @ManyToOne, @OneToOne과 같은 애노테이션을 이용해서 연관된 객체를 로딩하는 기능을 제공하고 있으므로 필드를 이용해서 다른 애그리거트를 쉽게 참조할 수 있다.
ORM 기술 덕에 애그리거트 루트에 대한 참조를 쉽게 구현할 수 있고, 필드(또는 get 메서드)를 이용한 애그리거트 참조를 사용하면 다른 애그리거트의 데이터를 객체 탐색을 통해 조회할 수 있지만, 필드를 이용한 애그리거트 참조는 아래와 같은 문제를 일으킬 수 있다.
이런 세 가지 문제를 완화할 수 있는 방법으론 ID를 이용해서 다른 애그리거트를 간접적으로 참조하는 것이다.
ID를 이용한 참조는 DB 테이블에서 외래키를 사용에 참조하는 것과 비슷하게 다른 애그리거트를 참조할 떄 ID를 사용한다. 단, 애그리거트 내의 엔티티를 참조할 때는 객체 레퍼런스로 참조한다.
ID 참조를 사용하면 모든 객체가 참조 연결되지 않고 한 애그리거트에 속한 객체들만 참조로 연결된다.
참조하는 애그리거트가 필요하면 Application 서비스에서 아이디를 이용해서 로딩하면 된다.
public class ChangeOrderService {
@Transactional
public void changeShippingInfo(OrderId id, ShippingInfo newShippingInfo, boolean useNewShippingAddrAsMemberAddr) {
Order order = orderRepository.findById(id);
if (order == null) throw new OrderNotFoundException();
order.changeShippingInfo(newShippingInfo);
if (useNewshippingAddrAsMemberAddr) {
// ID를 이용해서 참조하는 애그리거트를 구한다.
Customer customer = customerRepository.findById(order.getOrderer().getCustomerId());
customer.changeAddress(newShippingInfo.getAddress());
}
}
}
Application 서비스에서 애그리거트를 로딩하므로 애그리거트 수준에서 지연 로딩을 하는 것과 동일한 결과를 만든다.
ID를 이용한 참조 방식을 사용하면 복잡도를 낮추는 것과 함께 한 애그리거트에서 다른 애그리거트의 상태를 수정하는 문제를 원천적으로 방지할 수 있다.
애그리거트별로 다른 구현 기술을 사용하는 것도 가능해진다.
각 도메인을 별도 프로세스로 서비스하도록 구현 할 수도 있다.
다른 애그리거트를 ID로 참조하면 참조하는 여러 애그리거트를 읽어야 할 때 조회 속도가 문제가 될 수 있다.
예를 들면 한 번에 모든 데이터를 가져올 수 있음에도 불구하고 주문마다 상품 정보를 읽어오는 쿼리를 실행하는 문제가 발생할 수 있다. 이는 더 많은 쿼리를 실행해서 전체 조회 속도가 느려지는 원인이 된다.
Customer customer = customerRepository.findById(ordererId);
List<Order> orders = orderRepository.findByOrderer(ordererId);
List<OrderView> dtos = orders.stream()
.map(order -> {
ProductId prodId = order.getOrderLines().get(0).getProductId();
// 각 주문마다 첫 번째 주문 상품 정보 로딩 위한 쿼리 실행
Product product = productRepository.findById(prodId);
return new OrderView(order, customer, product);
}).collect(toList());
N+1 조회 문제 : 연관 관계에서 발생하는 이슈로 연관 관계가 설정된 엔티티를 조회할 경우에 조회된 데이터 갯수(N) 만큼 연간 관계의 조회 쿼리가 추가로 발생하여 데이터를 읽어오게 된다.
전체 조회 속도가 느려지는 문제를 개선하려면 조인을 사용해야 한다.
조인을 사용하는 가장 쉬운 방법은 ID 참조 방식을 객체 참조 방식으로 바꾸고 즉시로딩을 서용하도록 매핑 설정을 바꾸는 것이다. 하지만, 이 방식은 애그리거트 간 참조를 ID 참조 방시겡서 객체 참조 방식으로 다시 되돌리는 것이다.
ID 참조 방식을 사용하면서 N+1 조회와 같은 문제를 해결하려면 전용 조회 쿼리를 사용하면 된다.
예를들면 데이터 조회를 위한 DAO를 만들고 DAO의 조회 메서드에서 세타 조인을 이용해서 한 번의 쿼리로 필요한 데이터를 로딩하면된다.
@Repository
public class JpaOrderViewDao implements OrderViewDao {
@PersistenceContext
private EntityManager em;
@Override
public List<OrderView> selectByOrder(String ordererId) {
String selectQuery =
"select new com.myshop.order.application.dto.OrderView(o, m, p) " +
"from Order o join o.orderLines ol, Member m, Product p " +
"where o.orderer.memberId.id = :ordererId " +
"and o.orderer.memberId = m.id " +
"and ol.productId = p.id " +
"order by o.number.number desc";
TypedQuery<OrderView> query =
em.createQuery(selectQuery, OrderView.class);
query.setParameter("ordererId", ordererId);
return query.getResultList();
}
}
JPA를 사용하면 각 객체 간 모든 연관을 지연/즉시로딩으로 어떻게든 처리하고 싶은 욕구가 생길텐데 이는 실용적이지 않다. ID를 참조하여 애그리거트를 참조해도 한 번의 쿼리로 필요한 데이터를 로딩하는 것이 가능하다.
하지만, 만약 애그리거트마다 다른 저장소를 사용하는 경우라면 한 번의 쿼리로 관련 애그리거트를 조회할 수 없으므로 성능을 높이기 위해 캐시를 적용하거나 조회 전용 저장소를 구성한다. 코드는 복잡해지지만 시스템의 처리량을 높일 수 있다.
애그리거트 간 1:N, M:N 연관에 대해 살펴본다.
대표적인 예로 카테고리와 상품간의 연관이 대표적이다. 한 카테고리에 여러 상품이 속할 수 있으니 1:N이다
public class Category {
private Set<Product> products; // 다른 애그리거트에 대한 1:N 연관
//...
public List<Product> getProducts(int page, int size) {
List<Product> sortedProducts = sortById(products);
return sortedProducts.subList((page - 1) * size, page * size);
}
}
하지만 위처럼 도메인 객체 내에 연관을 맺게 되면 해당 객체가 불릴때마다 Category에 속한 모든 Product를 조회하게 되면서 성능에 심각한 문제를 야기시킨다. 따라서 개념적으로는 애그리거트 간에 1:N 연관이 있다고 하더라도 성능상 문제로 인해 애그리거트 간의 1:N 연관을 실제 구현에 반영하는 경우는 드물다.
상품 입장에서 자신이 속한 카테고리를 N:1 로 연관지어 구하면 된다.
public class Product {
// ...
private CateogryId category;
//...
}
public class ProductListService {
public Page<Product> getProductOfCategory(Long categoryId, int page, int size) {
Category category = categoryRepository.findById(categoryId);
checkCategory(category);
List<Product> products = productRepository.findByCategoryId(category.getId(), page, size);
int totalCount = productRepository.countByCategoryId(category.getId());
return new Page(page, size, totalCount, products);
}
}
카테고리에 속한 상품 목록을 제공하는 응용 서비스는 다음과 같이 ProductRepository를 이용해 CategoryId가 지정한 카테고리 식별자인 Product 목록을 구한다.
M:N 연관은 개념적으로 양쪽 애그리거트에 컬랙션으로 연관을 만든다.
상품이 여러카테고리에 속할 수 있다고 가정하면 카테고리와 상품은 M:N 연관을 맺는다.
보통 상품 페이지를 보여줄 때 각 상품 별 모든 카테고리 정보를 다 보여주진 않는다. 상품 상세 화면에서 주로 카테고리 정보를 보여주게 된다. 이 요구사항을 고려하면 카테고리->상품의 연관은 필요하지 않다. 상품->카테고리 연관만 구현하면 된다.
즉, 개념적으로 상품과 카테고리의 양방향 M:N 연관이 존재하지만 실제 구현에서는 상품->카테고리의 단방향 M:N 연관만 적용하면 된다.
RDBMS를 이용해 M:N 연관을 구현하려면 조인 테이블을 사용한다.
JPA 를 이용하면 다음과 같은 매핑 설정을 사용해 ID 참조를 이용한 M:N 단방향 연관을 구현할 수 있다.
@Entity
@Table(name = "pd_mall_product")
public class Product {
@EmbeddedId
private ProductId id;
@ElementCollection
@CollectionTable(name = "pd_mall_product_category",
joinColumns = @JoinColumn(name = "product_id))
private Sets<CategoryId> categoryIds;
//...
}
이 매핑은 카테고리 ID목록을 보관하기 위해 밸류 타입에 대한 컬렉션 매핑을 이용했다. 이 매핑을 사용하면 JPQL의 member of 연산자를 이용해서 특정 Category에 속한 Product 목록을 구하는 기능을 구현할 수 있다.
@Repository
public class JpaProductRepository implements ProductRepository {
@PersistenceContext
private EntityManager entityManager;
@Override
public List<Product> findByCategoryId(CategoryId categoryid, int page, int size) {
TypedQuery<Product> query = entityManager.createQuery(
"select p from Product p " +
"where :catId member of p.categoryIds order by p.id.id desc", Product.class);
query.setParameter("catId", categoryId);
query.setFirstResult((page - 1) * size);
query.setMaxResults(size);
return query.getResultList();
}
}
예를 들어, 특정 상점에서 더 이상 상품을 등록을 할 수 없도록 차단한 상태라고 할 때 상품 등록 기능을 아래와 같이 Application 서비스에 구현할 수 있을 것이다.
이 도메인 기능을 넣기 위한 별도의 도메인 서비스나 팩토리 클래스를 만들 수도 있지만 이 기능을 구현하기에 더 좋은 장소는 Store 애그리거트이다. Product를 생성하는 기능을 Store 애그리거트에 다음과 같이 옮길 수 있다.
public class Store extends Member {
public Product createProduct(ProductId newProductId, /*...*/) {
if (isBlocked()) throw new StoreBlockedException();
return new Product(newProductId, getId(), /*...*/);
}
}
Store 애그리거트의 createProduct()는 Product 애그리거트를 생성하는 팩토리 역할을 한다. 이제 Application 서비스에서는 팩토리 기능을 이용하여 Product를 생성하면 된다.
public class RegisterProductService {
public ProductId registerNewProduct(NewProductRequest req) {
Store account = accountRepository.findStoreById(req.getStoreId());
checkNull(account);
ProductId id = productRepository.nextId();
Product product = accout.createProduct(id, /*...*/);
productRepository.save(product);
return id;
}
}
이로써 Product 생성 가능 여부를 확인하는 도메인 로직을 변경해도 도메인 영역의 Store만 변경하면 되고 Application 서비스는 영향을 받지 않는다. 또한 도메인 응집도도 높아졌다.