[도메인 주도 개발] Ch4 : 리포지터리와 모델 구현

 4.1 JPA를 이용한 리포지터리 구현

애그리거트를 어떤 저장소에 저장하느냐에 따라 리포지터리를 구현하는 방법이 다르다. 이 절에서는 자바의 ORM 표준인 JPA를 이용해서 리포지터리와 애그리거트를 구현하는 방법에 대해 알아본다.

 

 

4.1.1 모듈 위치

 리포지터리 인터페이스는 애그리거트와 같이 도메인 영역에 속하고, 리포지터리를 구현한 클래스는 인프라스트럭처 영역에 속한다. 가능하면 리포지터리 구현 클래스를 인프라스트럭처 영역에 위치시켜서 인프라스트럭처에 대한 의존을 낮춰야 한다.

 

 

4.1.2 리포지터리 기본 기능 구현

 리포지터리가 제공하는 기본 기능은 다음 두가지가 있다.
     1. ID로 애그리거트 조회
     2. 애그리거트 저장

 삭제 기능의 경우, 삭제 요구사항이 있더라도 실제로 삭제하는 경우는 많지 않다. 관리자 기능에서 삭제한 데이터까지 조회해야 하는 경우도 있고, 데이터 원복을 위해 보관해야 하는 경우도 있다. 따라서 데이터를 바로 삭제하기보다는 삭제 플래그를 사용해서 데이터를 화면에 보여줄지 여부를 결정하는 방식으로 구현한다.

 

 기본 기능 구현을 위한 리포지터리 인터페이스는 다음과 같은 형태를 가진다.

public interface OrderRepository{
	Order findById(OrderNo no);
    void save(Order order);
 }

 인터페이스는 애그리거트 루트를 기준으로 작성한다.

 애그리거트를 조회하는 기능의 이름을 지을 때 널리 사용되는 규칙은 "findBy프로퍼티이름" 형식이다. 

 위 코드에서 findById()는 ID에 해당하는 애그리거트가 존재하면 Order을 반환하고, 존재하지 않으면 null을 반환한다. 만약 null을 사용하고 싶지 않다면 Optional을 사용한다.

Optional<Order> findById(Order order);

 위의 리포지터리 인터페이스를 이용하여 기능을 구현해야 한다. 하지만 대부분의 개발자는 스프링 데이터 JPA를 사용한다. 이 경우 리포지터리 인터페이스만 정의하면 나머지 리포지터리 구현 객체는 스프링 데이터 JPA가 만들어주기 때문에 개발자가 리포지터리 인터페이스를 구현한 클래스를 직접 작성할 일은 거의 없다.

 

 JPA를 사용하면 트랜잭션 범위에서 변경한 데이터를 자동으로 DBDP 반영하기 때문에 애그리거트를 수정한 결과를 저장소에 반영하는 메서드를 추가할 필요는 없다.

public class ChangeOrderService{
	@Transactional
    public void changeShippingInfo(OrderNo no, ShippingInfo newShippingInfo){
    	Optional<Order> orderOpt = orderRepository.findById(no);
        Order order = orderOpt.orElseThrow(()->new OrderNotFoundException));
        order.changeShippingInfo(newShippingInfo);
    }
    ...​

changeShippingInfo() 메서드는 트랜잭션 범위에서 실행된다. 메서드 실행이 끝나면 트랜잭션을 커밋하는데, 이때 JPA는 트랜잭션 범위에서 변경된 객체의 데이터를 DB에 반영하기 위해 UPDATE 쿼리를 실행한다.

 

 ID가 아닌 다른 조건으로 애그리거트를 조회할 때는 findBy 뒤에 조건 대상이 되는 프로퍼티 이름을 붙일 수 있다. 또 ID 외에 다른 조건으로 애그리거트를 조회할 때는 JPA의 Criteria나 JPQL을 사용할 수 있다.

 

 

4.2 스프링 데이터 JPA를 사용한 리포지터리 구현

 스프링 데이터 JPA는 지정한 규칙에 맞게 리포지터리 인터페이스를 정의하면 리포지터리를 구현한 객체를 알아서 만들어 스프링 빈으로 등록해준다. 스프링 데이터 JPA는 다음 규칙에 따라 작성한 이너페이스를 찾아서 인터페이스를 구현한 스프링 빈 객체를 자동으로 등록한다.
     - org.springframework.data.repository.Repository<T,ID> 인터페이스 상속
     - T : 엔티티 타입 지정 , ID : 식별자 타입 지정

 

예를 들어, Order 엔티티 타입의 식별자가 OrderNo 타입일 경우 OrderRepository는 다음과 같이 작성 가능하다.

public interface OrderRepository extends Repository<Order, OrderNo>{
	Optional<Order> findById(OrderNo id);
    void save(Order order);
}

 

OrderRepository를 기준으로 엔티티를 저장하는 메서드는 다음 중 하나를 사용한다.

• Order save(Order entity)
• void save(Order entity)

식별자를 이용해 엔티티를 조회하는 메서드는 다음과 같다.

• Order findById(OrderNo Id) : null 리턴 O.
• Optional<Order> findById(OrderNo id) : 값이 없는 경우 Optional을 리턴.

특정 프로퍼티를 이용해 엔티티를 조회하는 메서드의 예는 다음과 같다.

• List<Order> findByOrderer(Orderer orderer) : 특정 Orderer 값을 갖는 Order 목록을 조회하는 메서드.

프로퍼티 중첩도 가능한데, 예는 다음과 같다.

• List<Order> findByOrdererMemberId(MemberId memberId) : Orderer 객체의 memberId 프로퍼티가 파라미터와 같은 Order 목록을 조회하는 메서드.

엔티티를 삭제하는 메서드는 다음 두 형태를 갖는다.

• void delete(Order order) : 삭제할 엔티티를 전달.
• void delete(OrderNo id) : 식별자를 이용해서 해당하는 엔티티를 삭제.

 

 

4.3 매핑 구현

4.3.1 엔티티와 밸류 기본 매핑 구현

애그리거트와 JPA 매핑을 위한 기본 규칙
1. 애그리거트 루트는 엔티티이므로 @Entity로 매핑 설정한다.
2. 밸류는 @Embeddable로 매핑 설정한다.
3. 밸류 타입 프로퍼티는 @Embedded로 매핑 설정한다.

 주문 애그리거트에서 Order은 JPA의 @Entity로 매핑한다. 그리고 @Embedded를 이용해서 밸류 타입 프로퍼티를 설정한다.

@Entity
@Table(name = "purchase_order")
public class Order{
	...
    @Embedded
    private Orderer orderer;
    ...
}​

 

Order에 속하는 Orderer은 밸류이므로 @Embeddable로 매핑한다.

@Embeddable
public class Orderer{
	...
}​

 

4.3.2 기본 생성자

 엔티티 또는 밸류가 불변 타입인 경우 생성 시점에 필요한 값을 모두 전달받기 때문에 기본 생성자가 필요하지 않다. 하지만 JPA에서 @Entity와 @Embeddable로 클래스를 매핑하기 위해서는 불변 타입의 클래스에도 기본 생성자를 추가해주어야 한다. 이는 기술적인 제약에 의한다.

 

 기본 생성자는 JPA 프로바이더가 객체를 생성할 때만 사용한다. 기본 생성자를 다른 코드에서 사용하면 값이 없는 온전하지 못한 객체를 만들게 되기 때문에 다른 코드에서 기본 생성자를 사용하지 못하도록 protected로 생성자를 선언한다.

예를 들어 Receiver 밸류 타입을 앞서 언급한 애너테이션으로 매핑하고 싶은 경우, 다음과 같이 생성자를 선언한다.

@Embeddable
public class Receiver{
	@Collumn(name = "receiver_name")
    private String name;
    
    @Collumn(name "receiver_phone")
    private String phone;
    
    protected Receiver() {} // JPA를 적용하기 위해 protected로 생성자 선언
    
    public Receiver(String name, String phone){
    	this.name = name;
        this.phone = phone;
    }
    ...
}​

 

4.3.3 필드 접근 방식 사용

 JPA는 필드와 메서드 두 가지 방식으로 매핑을 처리할 수 있는데, 메서드 방식을 사용하려면 프로퍼티를 위한 get/set 메서드를 구현해야 한다. 하지만 도메인의 의도를 더 잘 표현하고 객체가 제공할 기능 중심으로 엔티티를 구현하도록 유도하려면 JPA 매핑 처리를 프로퍼티 방식이 아닌 필드 방식으로 선택해서 불필요한 get/set 메서드를 구현하지 말아야 한다.

 

 엔티티에 프로퍼티를 위한 공개 get/set 메서드를 추가할 경우,

• 도메인의 의도가 사라지고 객체가 아닌 데이터 기반으로 엔티티를 구현할 가능성이 높아진다.
• set 메서드는 내부 데이터를 외부에서 변경할 수 있는 수단이 되기 때문에 캡슐화를 깨는 원인이 될 수 있다.

 상태 변경을 위한 setState() 메서드보다 주문 취소를 위한 cancel() 메서드가 도메인을 더 잘 표현한다. 그리고 setShipping() 메서드보다 changeShipping() 가 도메인을 더 잘 표현한다.

 

밸류 타입을 불변으로 구현하려면 set 메서드 자체가 필요없다. 따라서 JPA의 구현 방식 때문에 공개 set 메서드를 추가하는 것도 좋지 않다.

 

4.3.4 AttributeConverter를 이용한 밸류 매핑 처리

 두 개 이상의 프로퍼티를 가진 밸류 타입을 한 개 칼럼에 매핑할 때는 AttributeConverter 인터페이스를 구현하여 처리한다. 이때 인터페이스를 구현한 클래스에는 @Converter 애너테이션을 적용한다.

 

AttributeConverter은 밸류 타입과 칼럼 데이터 간의 변환을 처리하기 위한 기능을 정의한다. 여기서 X는 밸류 타입, Y는 DB 타입이다.

public interface AttributeConverter<X, Y>{

	public Y convertToDatabase(X attribute); // 밸류 타입을 DB 칼럼 값으로 변환하는 기능 구현
    
    public X convertToEntityAttribute(Y data); // DB 칼럼 값을 밸류로 변환하는 기능 구현
}

 

  예를 들어 Length가 길이값과 단위의 두 프로퍼티를 갖고 있는데, DB 테이블에는 1000mm 처럼 두 프로퍼티가 함께 붙어있는 형식으로 저장할 수 있다. 이 경우 AttributeConverter을 이용한다.

 

 이 부분 실습 코드 더 찾아보기!

 

4.3.5 밸류 컬렉션 : 별도 테이블 매핑

 벨류 컬렉션을 별도 테이블로 매핑할 때는 @ElementCollection과 @CollectionTable을 함께 사용한다.

 이 부분 실습 코드 더 찾아보기!

 

4.3.6 밸류 컬렉션 : 한 개 컬럼 매핑

이 부분 실습 코드 더 찾아보기!

 

4.3.7 밸류를 이용한 ID 매핑

밸류 타입을 식별잘 매핑하면 @Id 대신 @EmbeddedId 애너테이션을 사용한다. 또 JPA에서 식별자 타입은 Serialized 타입이어야 하므로 식별자를 사용할 밸류 타입은 Serializable 인터페이스를 상속받아야 한다.

@Entity
@Table(name = "purchase_order")
public class Order{
	@EmbeddedId
    private OrderNo number;
    ..
}

@Embeddable
public class OrderNo inplements Serializable{
	@Coloumn(name = "order_number")
    private String number;
    ...
}

 

4.3.8 별도 테이블에 저장하는 밸류 매핑

  애그리거트에서 루트 엔티티를 뺀 나머지 구성요소는 대부분 밸류이다. 루트 엔티티 외에 또다른 엔티티가 있다면 진짜 엔티티인지 의심해봐야 한다. 밸류가 아니라 엔티티가 확실하다면 해당 엔티티가 다른 애그리거트는 아닌지 확인해봐야 하는데, 자신만의 독자적인 라이프 사이클을 갖는다면 애그리거트일 가능성이 높다.

 상품 상세 화면에서 상품 자체에 대한 정보와 고객의 리뷰를 함께 보여준다. 하지만 그렇다고 해서 상품 애그리거트에 고객 리뷰가 포함되지는 않는다. 상품과 리뷰는 함께 생성되지 않고, 생성 주체도 다르다. 또한 서로의 변경이 서로에게 영향을 주지도 않는다. 리뷰는 엔티티이지만 상품 애그리거트에 속한 엔티티는 아니다.

 

 

 애그리거트에 속한 객체가 밸류인지 엔티티인지 확인하는 방법은 고유 식별자를 갖는지를 확인하는 것이다. 다만 식별자를 찾을 때 매핑되는 테이블의 식별자를 애그리거트 구성요소의 식별자와 동일한 것으로 착각하면 안되는데, 별도 테이블로 저장하고 테이블에 PK가 있다고 해서 테이블과 매핑되는 애그리거트 구성요소가 항상 고유 식별자를 갖는 것은 아니다.

 게시글 데이터를 ARTICLE 테이블과 ARTICLE_CONTENT 테이블로 나누어 저장할 수 있다. 여기서 AlticleContent는 Article의 내용을 담는 밸류로 생각하는 것이 맞다. ARTICLE_CONTENT의 식별자는 존재하지만, 이 식별자는 ARTICLE 테이블과 연결할 때 필요한 것이고 별도의 식별자가 필요해서가 아니다. 따라서 이 경우 게시글의 특정 프로퍼티를 별도 테이블에 보관한 것으로 접근해야 한다. 이때 밸류를 매핑한 테이블을 지정하기 위해 @SecondaryTable과 @AttributeOverride를 사용한다.

 

4.3.9 밸류 컬렉션을 @Entity로 매핑하기

 

수정 예정

 

4.3.10 ID 참조와 조인 테이블을 이용한 단방향 M-N 매핑

 애그리거트간 집합 연관은 성능 상의 이유로 지양해야 하지만 그럼에서 집합 연관을 사용하는 것이 유리한 경우 ID 참조를 이용한 단방향 집합 연관을 적용해볼 수 있다. 이 경우 집합의 값에 밸류 대신 연관을 맺는 식별자가 온다. 만약 애그리거트를 직접 참조했다면 영속성 전파나 로딩 전략을 고민해야 하지만 ID 참조 방식은 이런 고민을 없애준다.

	@Entity
    @Table(name = "product")
    public class Product{
    	@EmbeddedId
        private ProductId id;
        
        @ElementCollection
        @CollectionTable(name = "product_category",
        	joinColumns = @JoinColumn(name = "product_id"))
        private Set<CategoryId> categoryIds;
    }

 

 

4.4 애그리거트 로딩 전략

  JPA 매핑을 설정할 때 기억해야 할 점은 애그리거트에 속한 객체가 모두 모여야 완전한 하나가 된다는 것이다. 조회 시점에서 애그리거트를 완전한 상태가 되도록 하려면 애그리거트 루트에서 연관 매핑의 조회 방식을 즉시 로딩(FetchType.EAGER)로 설정한다. 하지만 루트 엔티티를 로딩하는 시점에 애그리거트에 속한 객체를 모두 로딩해야 하는 것은 아니다. 예를 들어 상태 변경 기능을 실행하기 위해서는 해당 시점에 필요한 구성요소만 로딩해도 된다. 따라서 무조건 즉시 로딩이나 지연 로딩으로 설정하기보다는 애그리거트에 맞게 즉시 로딩과 지연 로딩을 선택해야 한다.

 

 조회 시점에서 즉시 로딩을 사용하는 예는 다음이 있다. 다음처럼 @Entity에 대한 fetch 속성을 즉시 로딩으로 설정하면 애그리거트 루트를 구할 때 연관된 구성요소를 DB에서 함께  읽어온다.

// @Entity 컬렉션에 대한 즉시 로딩 설정
@OneToMany(..., fetch = FetchType.EAGER)
private List<Image> images = new ArrayList<>();

 

 하지만 컬렉션에 대한 로딩 전략을 FetchType.EAGER로 설정하면 즉시 로딩 방식이 문제가 될 수 있다. 여러 테이블을 조인한 쿼리를 실행하게 되는데, 이는 쿼리 결과에 중복을 발생시킨다. 보통 조회 성능 문제 때문에 즉시 로딩 방식을 사용하지만 조회되는 데이터 개수가 많아지면 즉시 로딩 방식을 사용할 때 성능(실행 빈도, 트래픽, 지연 로딩 시 실행 속도) 등을 고려해야 한다.

 

 애그리거트는 개념적으로 하나여야 한다. 그 이유는 다음과 같다.

1. 상태를 변경하는 기능을 실행할 때 애그리거트 상태가 완전해야 한다.
2. 표현 영역에서 애그리거트의 상태 정보를 보여줄 때 필요하다.

여기서 상태 변경 기능을 실행하기 위해 조회 시점에 즉시 로딩을 이용해서 애그리거트를 완전한 상태로 로딩할 필요는 없다. JPA 트랜잭션 범위 안에서 지연 로딩을 허용하기 때문에 필요한 구성요소만 로딩해도 된다.

 

 

4.5 애그리거트의 영속성 전파

 애그리거트는 조회 뿐만 아니라 저장하고 삭제할 때도 하나로 처리되어야 한다.

• 저장 메서드는 루트 뿐만 아니라 애그리거트에 속한 모든 객체를 함께 저장한다.
• 삭제 메서드는 루트 뿐만 아니라 애그리거트에 속한 모든 객체를 삭제한다.

@Embeddable 매핑 타입은 함께 저장되고 삭제되기 때문에 cascade 속성을 추가로 설정하지 않아도 된다.

애그리거트에 속한 @Entity 타입에 대한 매핑은 cascade 속성을 사용해서 설정해주어야 한다. 

@OneToOne, @OneToMany는 cascade 기본값이 없으므로 CascadeType.PERSIST, Cascade.REMOVE 를 설정한다.

 

 

4.6 식별자 생성 기능

 식별자는 세 가지 방식 중 하나로 생성한다.
     1. 사용자가 직접 생성
     2. 도메인 로직으로 생성
     3. DBFMF DL를 이용한 일련번호 사용

 

 이메일 주소처럼 사용자가 직접 식별자를 입력하는 경우에는 도메인 영역에 식별자 생성 기능을 구현하지 않아도 된다.

 

 식별자 생성 규칙이 있다면 도메인 영역에 식별자 생성 기능을 위치시켜야 한다. 

public class ProductIdService{
	public ProductId nextId(){
    ... // 정해진 규칙으로 식별자 생성
    }
}

 

 식별자 생성 규칙을 구현하기에 적합한 또 다른 장소는 리포지터리이다. 리포지터리 인터페이스에 식별자를 생성하는 메서드를 추가하고 리포지터리 구현 클래스에서 알맞게 구현한다.

 

 DB 자동 증가 칼럼을 식별자로 사용하면 식별자 매핑에서 @GeneratedValue 를 사용한다. 자동 증가 칼럼은 DB의 insert 쿼리를 실행해야 식별자가 생성되므로 도메인 객체를 리포지터리에 저장할 때 식별자가 생성된다. 따라서 도메인 객체를 생성하는 시점에는 식별자를 알 수 없고 도메인 객체를 저장한 뒤에 식별자를 구할 수 있다. 자동 증가 칼럼 외의 JPA의 식별자 기능을 사용하는 경우에도 저장 시점에 식별자를 생성한다.

@Entity
@Table(name = "Article")
public class Article{
	@Id
    @GenaratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
}

 

 

4.7 도메인 구현과 DIP

 도메인에서 구현 기술에 대한 의존을 없애려면 구현 클래스를 인프라에 위치시켜야 한다. 이렇게 DIP를 적용하는 주된 이유는 저수준 구현이 변경되더라도 고수준이 영향을 받지 않도록 하기 위해서이다. 하지만 리포지터리와 도메인 모델의 구현 기술은 거의 바뀌지 않는다. 따라서 DIP를 완벽히 지키는 것이 좋겠지만 개발 편의성과 실용성을 가져가면서 구조전인 유연성은 유지하는 방향을 선택하는 것이 합리적일 수 있다.