리포지터리와 모델구현(JPA 중심)

리포지터리와 모델구현(JPA 중심)

애그리거트를 어떤 저장소에 저장하느냐에 따라 리포지터리를 구현하는 방법이 다르기 때문에 모든 구현 기술을 대해 알아볼 수는 없다.

도메인 모델과 리포지터리를 구현할 때 선호하는 기술을 꼽자면 JPA를 들 수 있다.

데이터 보관소로 RDBMS를 사용할 때 객체 기반의 도메인 모델과 관계형 데이터 모델 간의 매핑을 처리하는 기술로 ORM 만한 것이 없다.

다양한 ORM기술이 존재하지만, 자바의 ORM 표준인 JPA를 이용해서 리포지터리와 애그리거트를 구현하는 방법을 살펴보자

모듈위치

리포지터리 인터페이스는 애그리거트와 같이 도메인 영역에 속하고, 리포지터리를 구현한 클래스는 인프라스트럭처 영역에 속한다.

domain                                   Infra

Model ------> ModelRepository <---------- JpaModelRepository

팀 표준에 따라 리포지터리 구현 클래스를 domain.impl과 같은 패키지에 위치시키는 경우도 있다.

리포지터리 인터페이스와 구현체를 분리하기 위한 타협안 같은 것이지 좋은 설계 원칙을 따르는 것은 아니다.

가능하면 리포지터리 구현 클래스를 인프라스트럭처 영역에 위치시켜서 인프라스트럭처에 대한 의존을 낮춰야 한다.

리포지터리 기능 구현

1) 아이디로 애그리거트 조회하기

2) 애그리거트 저장하기

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

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

주문 애그리거트는 Order 루트 엔티티를 비롯해 OrderLine, Orderer, ShippingInfo 등 다양한 객체를 포함하는데, 이 구성요소 중에서 Order 루트 엔티티를 기준으로 리포지터리 인터페이스를 작성한다.

애그리거트를 조회하는 기능의 이름을 지을 때 특별한 규칙은 없지만 널리 사용되는 규칙은 findBy프로퍼티(프로퍼티 값)의 형식을 사용하는 것이다.

해당하는 애그리거트가 존재하면 Order를 리턴하고 존재하지 않으면 null를 리턴한다.

null를 사용하고 싶지 않다면 자바 8의 Optional를 이용해서 값을 리턴해도 된다.

save()메서드는 전달받는 애그리거트를 저장한다.

이 인터페이스를 구현한 JPA의 EntityManger를 이용해서 기능을 구현한다.

public class JpaOrderRepository implements OrderRepository {   @PersistenceContext   private EntityManager entityManger;   public Order findById(OrderNo id) {     return entityManger.find(Order.class, id);   }   public void save(Order order) {     entityManger.persist(order);   } }

애그리거트를 수정한 결과를 저장소에 반영하는 메서드를 추가할 필요는 없다.

JPA를 사용하면 트랜잭션 범위에서 변경한 데이터를 자동으로 DB에 반영하기 때문이다.

public class ChangeOrderService {   @Transactional   public void changeShippingInfo(OrderNo no, ShippingInfo newShippingInfo) {     Order order = orderRepository.findById(no);     if(order == null) throw new OrderNotFoundException();     order.changeShippingInfo(newShippingInfo);   } }

changeShippingInfo() 메서드는 스프링 프레임워크의 트랜잭션 관리 기능을 통해 트랜잭션 범위에서 실행된다.

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

order.changeShippingInfo() 메서드의 실행 결과로 애그리거트 내부의 객체가 변경되면 JPA는 변경 데이터를 DB에 반영하기 위해서 UPDATE 쿼리를 실행한다.

아이디가 아닌 다른 조건으로 애그리거트를 조회해야 하는 경우 findBy 뒤에 조건 대상이 되는 프로퍼티 이름을 붙인다.

public List<Order> findByOrdererId(String ordererId, int startRow, int size);

findByOrdererID 메서드는 한 개 이상의 Order 객체를 리턴할 수 있으므로 컬렉션 타입 중 하나인 List를 리턴 타입으로 사용했다.

아이디 외에 다른 조건으로 애그리거트를 조회 할때에는 JPA의 Criteria나 JPQL을 사용한다.

@Override public List<Order> findByOrdererId(String ordererId, int startRow, int fetchSize) {   TypedQuery<Order> query = entityManger.createQuery(     "select o from Order o " +     "where o.orderer.memberId.id = :ordererId " +     "order by o.number.number desc",     Order.class);     query.setParameter("ordererId", ordererId);     query.setFirstResults(startRow);     query.setMaxResults(fetchSize);     return query.getResultList(); }

애그리거트를 삭제하는 기능

public interface OrderRepository {   public void delete(Order order); }

구현 클래스

public class JpaOrderRepository implements OrderRepository {   @PersistenceContext   private EntityManager entityManger;   public void remove(Order order) {     entityManger.remove(order);   } }

삭제 요구사항이 있더라도 여러 이유로 데이터를 실제로 삭제하는 경우는 많지 않다.

관리자 기능에서 삭제한 데이터까지 조회해야하는 경우도 있고 데이터 원복을 위해 일정 기간 동안 보관해야 할 때도 있기 때문이다.

이런 이유로 사용자가 삭제 기능을 실행할 때 데이터를 바로 삭제하기보다는 삭제 플래그를 사용해서 데이터를 화면에 보여줄지 여부를 결정하는 방식으로 구현한다.

매핑구현

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

애그리거트와 JPA 매핑을 위한 기본 규칙

- 애그리거트 루트는 엔티티이므로 @Entity로 매핑설정한다.

- 한 테이블에 엔티티와 밸류 데이터가 같이 있다면

   -- 밸류는 @Embeddable로 매핑 설정한다.

   -- 밸류 타입 프로퍼티는 @Embedded로 매핑 설정한다.

주문 애그리거트의 루트 엔티티는 Order이고 이 애그리거트에 속한 Orderer와 ShippingInfo는 밸류인데, 이 세 객체와 ShippingInfo에 포함된 Address 객체와 Receiver 객체는 한테이블에 매핑할 수 있다.

루트 엔티티와 루트 엔티티에 속한 밸류는 한 테이블에 매핑될 때가 많다.

주문 애그리거트의 루트 엔티티 Order는 JPA의 @Entity로 매핑한다.

@Entity @Table(name = "purchase_order") public class Order { }

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

@Embeddable public class Orderer {     //MemberId에 정의된 칼럼 이름을 변경하기 위해     //@AttributeOverride 애노테이션 사용     @Embedded     @AttributeOverrides(       AttributeOverride(name = "id", column = @Column(name ="orderer_id"))     )     private MemberId memberId;     @Column(name ="orderer_name")     private String name; }

Orderer의 memberId는 Member 애그리거트를 ID로 참조한다.

Member의 아이디 타입을 사용되는 MemberId는 다음과 같이 id 프로퍼티와 매핑되는 테이블 칼럼 이름으로 "member_id"를 지정하고 있다.

@Embeddable public class MemberId implements Serializable {   @Column(name = "member_id")   private String id; }

Orderer의 memberId 프로퍼티와 매핑되는 칼럼 이름은 'orderer_id' 이므로 MemberId에 설정된 'member_id'와 이름이 다르다.

@Embeddable 타입에 설정한 칼럼 이름과 실제 칼럼 이름이 다르므로 Orderer의 memberId 프로퍼티를 매핑 할 때 @AttributeOverrides 애노테이션을 이용해서 매핑할 칼럼 이름을 변경했다.

JPA2부터 @Embeddable은 중첩을 허용하므로 밸류인 Orderer가 또 다른 밸류 MemberId를 포함할 수 있다.

Orderer와 마찬가지로 ShippingInfo 밸류도 또 다른 밸류인 Address와 Receiver를 포함한다.

Address의 매핑 설정과 다른 칼럼 이름을 사용하기 위해 @AttributeOverride 애노테이션을 사용한다.

@Embeddable public class ShippingInfo {   @Embedded   @AttributeOverrides({     @AttributeOverride(name = "zipCode", column = @Column(name ="shipping_zipcode")),     @AttributeOverride(name = "address1", column = @Column(name="shipping_addr1")),     @AttributeOverride(name = "address2", column = @Column(name="shipping_addr2"))   })   private Address address;   @Column(name = "shipping_message")   private String message;   @Embedded   private Receiver receiver; }

Order 애그리거트 루트 엔티티는 @Embedded를 이용해서 밸류 타입 프로퍼티를 설정한다.

@Entity public class Order {   @Embedded   private Orderer orderer;   @Embedded   private ShippingInfo shippingInfo; }

기본생성자

엔티티와 밸류의 생성자는 객체를 생성할 때 필요한 것을 전달받는다.

Receiver 밸류 타입의 경우 생성 시점에 수취인 이름과 연락처를 생성자 파라미터로 전달받는다.

public class Receiver { private String name; private String phone; public Receiver(String name, String phone) { this.name = name; this.phone = phone; } }

Receiver가 불변타입이면 생성 시점에 필요한 값을 모두 전달받으므로 값을 변경하는 set 메서드는 제공하지 않는다.

이는 Receiver 클래스에 기본 생성자를 추가할 필요가 없다는 뜻

하지만 JPA의 @Entity와 @Embeddable로 클래스를 매핑하려면 기본 생성자를 제공해야한다.

하이버네이트와 같은 JPA 프로바이더는 DB에서 데이터를 읽어와 매핑된 객체를 생성할 때 기본 생성자를 사용해서 객체를 생성한다.

이런 기술적 제약으로 Receiver와 같은 불변 타입은 기본 생성자가 필요없음에도 불구하고 기본생성자를 추가해야한다.

@Embeddable public class Receiver {   @Column(name="receiver_name") private String name; @Column(name="receiver_phone") private String phone; protected Receiver() {} //JPA를 적용하기 위해 기본 생성자 추가 public Receiver(String name, String phone) { this.name = name; this.phone = phone; } }

기본생성자는 JPA 프로바이더가 객체를 생성할 때만 사용한다.

기본 생성자를 다른 코드에서 사용하면 값이 없는 객체를 만들게 된다.

이런 이유로 다른 코드에서 기본 생성자를 사용하지 못하도록 protected로 선언한다.

하이버네이트는 글래스를 상속한 프록시 객체를 이용해서 지연로딩을 구현한다.

이 경우 프록시 클래스에서 상위 클래스의 기본 생성자를 호출할 수 있어야 하므로 지연 로딩 대상이 되는 @Entity와  @Embeddable의 기본 생성자는 private가 아닌 protected로 지정해야한다.

필드접근방식 사용

JPA는 필드와 메서드의 두가지 방식으로 매핑을 처리할수 있다.

메서드 방식을 사용하려면 프로퍼티를 위한 get/set 메서드를 구현해야한다.

@Entity @Access(AccessType.PROPETY) public class Order { @Column(name="state") @Eumerated(EnumType.STRING) public OrderState getState() { return state; } public void setState(OrderState state) { this.state = state; } }

엔티티에 프로퍼티를 위한 공개 get/set 메서드를 추가하려면 도메인의 의도가 사라지고 객체가 아닌 데이터 기반으로 엔티티를 구현할 가능성이 높아진다.

특히 set메서드는 내부 데이터를 외부에서 변경할 수 있는 수단이 되기 때문에 캡슐화를 깨는 원인이 된다.

엔티티가 객체로서 제 역할을 하려면 외부에서 set 메서드 대신 의도가 잘 드러나는 기능을 제공해야한다.

상태 변경을 위한 setSate() 메서드보다 주문 취소를 위한 cancel() 메서드가 도메인을 더 잘 표현하고 setShippingInfo() 메서드보다 배송지 변경한다는 의미를 갖는 changeShippingInfo()가 도메인을 더 잘표현한다.

밸류타입을 불변으로 구현하고 싶은 경우 set 메서드 자체가 필요없는데 JPA의 구현 방식떄문에 공개 set 메서드를 추가하는 것도 좋지 않다.

엔티티를 객체가 제공할 기능 중심으로 구현하도록 유도하려면 JPA 매핑 처리를 프로퍼티 방식이 아닌 필드 방식으로 선택해서 get/set  메서드를 구현하지 말이야 한다.

@Entity @Access(AccessType.FIELD) public class Order { @EmbeddedId private OrderNo number; @Column(name="state") @Eumerated(EnumType.STRING) public OrderState getState() { return state; } }

JPA 구현체인 하이버네이트는 @Access를 이용해서 명시적으로 접근방식을 지정하지 않으면 @Id나 @EmbeddedId가 어디에 위치했느냐에 따라 접근 방식을 결정한다.

@Id, @EmbeddedId가 필드에 위치하면 필드 접근방식을 선택하고 get메서드에 위치하면 메서드 접근방식을 선택한다.

AttributeConverter를 이용한 밸류 매핑처리

int, long, String, LocalDate 와 같은 타입은 DB 테이블의 한 개 칼럼과 매핑된다.

이와 비슷하게 밸류 타입의 프로퍼티를 한 개 칼럼에 매핑해야할 때도 있다.

Length가 길이 값과 단위의 두 프로퍼티를 갖고 있는데, DB 테이블에는 한개 칼럼에 1000mm와 같은 형식으로 저장할 수 있다.

public class Length { private int value; private String unit; }

DB칼럼

WIDTH VARCHAR(20)

두개 이상의 프로퍼티를 가진 밸류 타입을 한 개 칼럼에 매핑해야 할 경우 @Embeddable로는 처리할 수 없다. JPA 2.0 버전에서는 이를 처리하기 위해 칼럼과 매핑을 하기 위한 프로퍼티를 따로 추가하고 get/set 메서드에서 실제 밸류 타입과 변환처리를 해야한다.

public class Product { @Column(name-":WIDTH") private String width; public Length getWidth() { return new Width(width); // DB칼럼 값을 실제 프로퍼티 타입으로 변환 } void setWidth(Length width) { this.width = width.toString(); //실제 프로퍼티 타입을 DB 칼럼값으로 변환 } }

JPA 2.1에서는 DB 칼럼과 밸류 사이의 변환 코드를 모델에 구현하지 않아도 된다.

대신 AttributeConverter를 사용해서 변환을 처리할 수 있다.

AttributeConverter는 JPA 2.1에 추가된 인터페이스로 밸류타입과 칼럼 데이터 간의 변환처리를 위한 기능을 정의하고 있다.

package javax.presistence; public interface AttributeConverter<X, Y> { public Y convertToDatabaseColumn(X attrubute); public X convertToEntityAttribute(Y dbData); }

타입 파라미터 X는 밸류타입이고 , Y는 DB타입이다.

convertToDatabaseColumn() 메서드는 밸류 타입을 DB 칼럼 값으로 변환하는 기능

convertToEntityAttribute() 메서드는 DB 칼럼 값을 밸류 로 변환하는 기능

@Converter(autoApply = true) public class MoneyConverter implements AttributeConverter<Money, Integer> { @Override public Interger conveterToDatabaseColumn(Money money) { if(money == null){ return null; }else{ return money.getValue(); } } @Override public Money converterToEntityAttribute(Integer value) { if(value == null) return null; else return new Money(value); } }

AttributeConverter 인터페이스를 구현한 클래스는 @Converter 애노테이션을 적용한다.

autoApply 속성값을 true로 지정했는데, 모델에 출현하는 모든 Money 타입의 프로퍼티에 대해 MoneyConverter를 자동으로 적용한다.

@Entity @Table(name = "purchase_order") public class Order { @Column(name = "total_amounts") public Money totalAmount; // MoneyConverter를 적용해서 값 변환 }

@Converter의  autoApply 속성이 false인경우 프로퍼티값을 변환할때 사용할 컨버터를 직접 지정할 수 있다.

@Column(name = "total_amounts") @Convert(converter = MoneyConverter.class) public Money totalAmount;

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

Order 엔티티는 한 개 이상의  OrderLine을 가질 수 있다. OrderLine의 순서가 있다면 List 타입으로 이용해서 OrderLine 타입의 컬렉션을 프로퍼티로 갖게 된다.

public class Order { private List<OrderLine> orderLines; }

밸류 타입의 컬렉션은 별도 테이블에 보관한다.

Order와 OrderLine을 위한 테이블은 밸류 컬렉션을 저장하는 ORDER_LINE 테이블은 외부키를 이용해서 엔티티에 해당하는 PURCHASE_ORDER 테이블을 참조한다.

이 외부키는 컬렉션이 속할 엔티티를 의미한다.

List 타입의 컬렉션은 인덱스 값이 필요하므로 ORDER_LINE 테이블에 인덱스 값을 저장하기 위한 칼럼(line_index)도 존재한다.

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

@Entity @Table(name="purchase_order") public class Order { @ElementCollection @CollectionTable(name ="order_line", joinColumns = @JoinColumn(name="order_number")) @OrderColumn(name="line_index") private List<OrderLine> orderLines; }

@Embeddable public class OrderLine { @Embedded private ProductId productId; @Column(name="price") private Money price; @Column(name="quantity") private int quantity; @Column(name="amounts") private Money amounts; }

OrderLine 의 매핑을 함께 표시했는데,  OrderLine에는 List의 인덱스 값을 저장하기 위한 프로퍼티가 존재하지 않는다.

그 이유는 List 타입 자체가 인덱스를 갖고 있기 때문이다.

JPA의 @OrderColumn 애노테이션을 이용해서 지정한 칼럼에 리스트의 인덱스 값을 저장한다.

@CollectionTable 밸류를 저장할 테이블을 지정할 때 사용한다.

name 속성으로 테이블 이름을 지정하고  JoinColumn 속성은 외부키로 사용하는 칼럼을 지정한다.

두 개 이상인 경우 @JoinColumn의 배열을 이용해서 외부키 목록을 지정한다.

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

밸류 컬렉션을 별도 테이블이 아니 한개 칼럼에 저장해야할 때가 있다.

예를들어 도메인 모델에는 이메일 주소 목록을 Set으로 보관하고 DB에는 한 개 칼럼에 콤마로 구분해서 저장해야 할 때가 있다.

이때 AttributeConverter를 사용하면 밸류 컬렉션을 한 개 칼럼에 쉽게 매핑할 수 있다.

AttributeConverter 하려면 밸류 컬렉션을표현하는 새로운 밸류 타입을 추가해야한다.

public class EmailSet { private Set<Email> emails = new HashSet<>(); private EmailSet(); private EmailSet(Set<Email> emails){ this.emails.addAll(emails); } public Set<Email> getEmails(){ return Collections.unmodifiableSet(emails); } }

@Converter public class EmailSetConverter implements AttributeConverter<EmailSet, String> { @Override public String convertToDatabaseColumn(EmailSet attribute) { if(attribute == null) return null; return attribute.getEmails().stream().map(Email::toString).collect(Collectors.joining(",")); } public EmailSet converterToEntityAttribute(String dbData) { if(dbData == null) return null; String[] emalis = dbData.splite(","); Set<Email> emailSet = Array.stream(emails).map(value -> new Email(value)).collect(toSet()); return new EmailSet(emailSet); } }

EmailSet 타입의 프로퍼티가  converter로 EmailsSetConverter를 사용하도록 지정

@Column(name = "emails") @Convert(converter = EmailSetConverter.class) private EmailSet emailSet;

밸류를 이용한 아이디 매핑

식별자는 최정적으로 문자열이나 숫자 와 같은 기본타입이기 때문에  String이나 Long 타입을 이용해서 식별자를 매핑한다.

@Entity public class Order { //기본 타입을 이용한 식별자 매핑 @Id private String number }  @Entity  public class Artcle {   @Id   private Long id;  }

기본타입을 사용하는 것이 나쁘진 않지만 식별자라는 의미를 부각시키키위해서 식별자 자체를 별도로 밸류 타입으로 만들수도 있다.

밸류타입을 식별자로 매핑하면 @Id 대신 @EmbeddedId 애노테이션을 사용한다.

@Entity @Table(name = "purchase_order") public class Order { @EmbeddedId private OrderNo number; } @Embeddable public class OrderNo implements Serializable { @Column(name ="order_number") private String number; }

JPA에서 식별자 타입은 Serializalbe 타입이어야 하므로 식별자로 사용될 밸류타입은 Serializable 인터페이스를 상속받아야 한다.

밸류타입으로 식별자를 구현할 때 얻을 수 있는 장점은 식별자에 기능을 추가할 수 있다는 점이다.

예를 들어 1세대 시스템의 주문번호와 2세대 시스템의 주문번호를 구분할 때 주문번호의 첫 글자를 이용한다고 하자

OrderNo 클래스에서 시스템 세대를 구분할 수 있는 기능을 구현할 수 도 있다.

@Embeddable public class OrderNo implements Serializable { @Column(name ="order_number") private String number; public boolean is2ndGeneration() { return number.startWith("N"); } }

시스템 세대 구분을 필요한 코드는 OrderNo가 제공하는 기능을 이용해서 구분하면된다

if(order.getNumber().is2ndGeneration()){ }

JPA는 내부적으로 엔티티를 비교할 목적으로 equals() 메서드와 hashcode() 값을 사용하므로 식별자로 사용할 밸류 타입은 이 두 메서드를 알맞게 구현해야한다.

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

애그리거트에서 루트 엔티티를 뺀 나머지 구성요소는 대부분 밸류이다.

루트 엔티티 외에 또 다른 엔티티가 있다면 진짜 엔티티인지 의심해봐야 한다.

단지 별도 테이블에 데이터를 저장한다고 해서 엔티티인 것은 아니다.

주문 애그리거트도 OrderLine은 별도 테이블에 저장하지만 OrderLine 자제는 엔티티가 아니라 밸류이다.

밸류가 아니라 엔티티가 확실하다면 다른 애그리거트는 아닌지 확인해야한다.

특히, 자신만의 독자적인 라이프사이클을 갖는다면 다른 애그리거트일 가능성이 높다.

예를 들어 상품 상세화면을 보면 상품자체에 대한 정보와 고객의 리뷰를 함께 보여주는데, 이를 보고 상품 애그리거트에 고객 리큐가 포함된다고 생각할 수 있다.

하지만, Product와 Review는 함께 생성되지 않고, 함께 변경되지도 않는다.

게다가 변경 주체도 다르다.

Reivew의 변경이 Product에 영향을 주지 않고 반대로 Product의 변경이 Review에 영향을 주지 않기 때문에 Review는 엔티티는 맞지만 리뷰 애그리거트에 속한 엔티티이지 상품 애그리거트에 속한 엔티티는 아니다.

애그리거트에 속한 객체가 밸류인지 엔티티인지 구분하는 방법은 고유 식별자를 갖는지 여부를 확인하는 것이다.

하지만 식별자를 찾을 때 매핑되는 테이블의 식별자를 애그리거트 구성요소의 식별자와 동일한것으로 착각하면 안된다.

별도 테이블로 저장되고 테이블에 PK가 있다고 해서 테이블과 매핑되는 애그리거트 구성요소가 고유 식별자로 갖는것은 아니다

예를 들어 게시글 데이터를 ARTICLE 테이블과 ARTICLE_CONTENT 테이블로 나눠서 저장한다고 하자

Article과 ArticleContent 클래스와 두 테이블을 매핑할 수 있다.

ARTICLE_CONTENT 테이블의 ID 칼럼이 식별자 이므로 ARTICLE_CONTENT와 매핑되는 ArticleContent를 엔티티로 생각할 수 있는데,

이것  때문에 Article과 ArticleContent를 두 엔티티 간의 일대일 연관으로 매핑하는 실수를 할 수 있다.

ArticleContent를 엔티티로 생각 할 수 있지만, ArticleContent는 Article의 내용을 담고 있는 밸류로 생각하는 것이 맞다

ARTICLE_CONTENT 의 ID는 식별자이기는 하지만 이 식별자를 사용하는 이유는 ARTICLE 테이블의 데이터와 연결하기 위함이지 ARTICLE_CONTENT를 위한 별도 식별자가 필요하기 때문은 아니다.

즉 이는 게시글의 특정 프로퍼티를 별도 테이블에 보관하는 것으로 접근해야 한다.

ArticleContent를 밸류로 보고 접근하면 

<<Entity>> Artcle -id:Long -title: String -content: ArticleContent

->

<<Value>> ArticleContent -content:String -contentType:String

ArticleContent는 밸류이므로 @Embeddable로 매핑한다

ArticleContent와 매핑되는 테이블은 Article과 매핑되는 테이블과 다른데, 이때 밸류를 매핑한 테이블을 지정하기 위해 @SecondaryTable과 @AttributeOverride를 사용한다.

@Entity @Table(name="artcle") @SecondaryTable( name="artcle_content", pkJoinColumns = @PrimaryKeyJoinColumn(name="id") ) public class Article{ @Id private Long id; private String title; @AttributeOverrides({ @AttributeOverride(name="content", column = @Column(table = "article_content")), @AttributeOverride(name="contentType", column = @Column(table="article_content")) }) private ArticleContent content;' }

@SecodaryTable의 name 속성은 밸류를 저장할 테이블을 지정한다

pkJoinColumns속성은 밸류테이블에서 엔티티 테이블로 조인할 때 사용할 칼럼을 지정한다.

content필드의 @AttributeOverride를 적용했는데, 이 애노테이션을 사용해서 해당 밸류 데이터가 저장된 테이블 이름을 지정한다.

@SecondaryTable을 이용하면 실행할 때 두 테이블을 조인해서 데이터를 조회한다.

//@SecodaryTable로 매핑된 artcle_content 테이블 조인

Article article = entityManager.find(Artcile.class, 1L);

게시글 목록을 보여주는 화면은 article 테이블의 데이터만 필요하지, article_content 테이블의 데이터는 필요하지 않다.

그런데 @SecondaryTable을 사용하면 목록화면에 보여줄 Article를 조회할 때 article_content 테이블까지 조인해서 데이터를 읽어온다.

이 문제를 해소하고자 ArticleContent를 엔티티로 매핑하고 Article에서 ArticleContent로 로딩을 지연 로딩방식으로 설정할 수 있다.

하지만 이 방식은 엔티티가 아닌 모델을 엔티티로 만드는 것이므로 좋은 방법은 아니다.

대신 조회 전용 기능을 구현하는 방법을 사용하는 것이 좋다.

JPA에서 조회 전용 쿼리를 실행하는 방법이 있다.

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

개념적으로 밸류인데 규현 기술의 한계나 팀 표준 때문에 @Entity를 사용해야 할 때 도 있다.

예) 제품의 이미지 업로드 방식에 따라 이미지 경로와 썸네일 이미지 제공 여부가 달라진다고 하자

Image를 계층구조로 설계할 수 있다.

JPA는 @Embeddable 타입의 클래스 상속 매핑을 지원하지 않는다.

따라서 상속 구조를 갖는 밸류 타입을 사용하려면 @Embeddable 대신 @Entity를 이용한 상속 매핑으로 처리해야한다.

밸류타입을 @Entity로 매핑하므로 식별자 매핑을 위한 필드도 추가해야한다.

또한 구현 클래스를 구분하기 위한 타입 식별 칼럼을 추가해야한다.

한테이블에 Image 및 하위 클래스를 매핑하므로 Image 클래스에 @Inheritance를 적용하고 strategy값으로 SINGLE_TABLE을 사용하고 @DiscriminatorColumn을 이용해서 타입을 구분하는 용도로 사용할 칼럼을 지정한다.

Image를 @Entity로 매핑했지만 모델에서 Image는 엔티티가 아니라 밸류이므로 상태 변경하는 기능은 추가하지 않는다.

@Entity @Inheritance(strategy=InheritanceType.SINGLE_TABLE) @DiscriminatorColumn(name="image_type") @Table(name="image") public abstract class Image { @Id @GeneratedValue(strategy = GenerationType.IDENTITY) @Column(name="image_id") private Long id; @Column(name="image_path") private String path; @Temporal(TemporalType.TIMESTEMP) @Column(name='upload_time') private Date uploadTime; protected Image() {} public Image(String path){ this.path = path; this.uploadTime = new Date(); } protected String getPath() { return path; } public Date getUploadTime(){ return uploadTime; } public abstract String getURL(); public abstarct boolean hasThumbnail(); public abstract String getThumbnailURL() }

Image를 상속받은 클래스 @Entity와 @Discriminator를 사용해서 매핑을 설정한다

@Entity @DiscriminatorValue("II") public class InternalImage extends Image { }

@Entity @DiscriminatorValue("EI") public class ExternalImage extends Image { }

Image가 @Entity이므로 목록을 담고 있는 Product는 @OneToMany를 이용해서 매핑을 처리한다.

Image는 밸류이므로 독자적인 라이프 사이클을 갖지 않고 Product에 완전히 의존한다.

cascade 속성을 이용해서 Product를 저장할 때 함께 저장하고  Product를 삭제 할 때 함께 삭제되도록 설정한다.

Image 객체를 제거하면 DB에서 함께 삭제되도록 orphanRemoval도 true로 설정한다.

@Entity @Table(name='product') public class product { @EmbeddId private ProudctId id; private String name; @Convert(converter = MoneyConverter.class) private Money price; private String detail; @OneToMany(cascade = {CascadeType.PERSIST, CascadeType.REMOVE}, orphanRemoval  = true) @JoinColumn(name="product_id") @OrderColumn(name="list_idx") private List<Image> images = new ArrayList<>(); public void changeImages(List<Image> newImages){ images.clear(); images.addAll(images); } }

changeImags() 메서드를 보면 이미지 교체를 위해 clear() 메서드를 사용하고 있다.

@Entity에 대한 OneToMany 매핑에서 컬렉션 clear() 메서드를 호출하면 삭제 과정이 효율적이지 않을 수 있다.

예를 들어 하이버네이트의 경우 @Entity를 위한 컬렉션 객체의 clear() 메서드를 호출하면 select 쿼리로 대상 엔티티를 로딩하고, 각 개별 엔티티에 대해서 delete 쿼리를 실행한다.

즉 image에 보관되었던 Image 개수가 4개 이면 changeImages 코드를 실행할 때 Image 목록을 가져오기 위한 한번의 select * from image where product_id = ? 쿼리와 각 Image를 삭제하기 위한 네번의 delete from where proudct_id =? 쿼리를 실행한다.

변경 빈도가 낮으면 괜찮지만 빈도가 높으면 전체 서비스 성능에 문제가 될수 있다.

하이버네이트는 @ Embeddable 타입에 대한 컬렉션의 clear() 메서드를 호출하면 컬렉션에 속한 객체를 로딩하지 않고 한번의 delete 쿼리로 삭제처리를 수행한다.

따라서 애그리거트의 특성을 유지하면서 이문제를 해소하려면 결국 상속을 포기하고 @Embeddable로 매핑된 단일 클래스로 구현해야한다.

물론 이경우 타입에 따라 다른 기능을 구현하려면 if-else를 써야하는 단점이 발생한다.

@Embeddable public class Image { @Column(name="image_type") private String imageType; @Column(name="image_path") private String path; @Temporal(TemporalType.TIMESTEMP) @Column(name="upload_time") private Date uploadTime; public boolean hasThumnail(){ if(imageType.equals("II")) { return true; }else{ return false; } } }

코드 유지보수와 성능 두가지 측면을 고려해서 구현 방식을 선택해야한다.

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

애그리거트 간의 집합 연관은 성능상의 이유로 피해야 한다고 했다.

그럼에도 불구하고 요구사항을 구현하는데 집합 연관을 사용하는 것이 유리하다면 ID 참조를 이용한 단방향 집합 연관을 적용해 볼수 있따.

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

이 코드는 Product에서 Category로 단방향 M:N 연관을 ID 참조 방식으로 구현한것이다.

ID 참조를 이용한 애그리거트 간 단방향 M:N 연관은 밸류 컬렉션 매핑과 동일한 방식으로 설정한 것을 알 수 있다.

차이점 있다면 집합의 값에 밸류 대신 연관을 맺는 식별자가 온다는 점이다.

@ElementCollection을 이용하기 때문에 Product를 삭제할 때 매핑에 사용한 조인 테입르의 데이터도 함께 삭제된다.

애그리거트를 직접 참조하는 방식을 사용했다면 영속성 전파나 로딩 전략을 고민해야 하는데 ID 참조 방식을 사용함으로써 이런 고민을 할 필요가 없다.

애그리거트 로딩 전략

JPA 매핑을 설정할 때 항상 기억 해야할 점은 애그리거트에 속한 객체가 모두 모여야 완전한 하나가 된다는 것이다.

즉 애그리거트 루트를 로딩하면 루트에 속한 모든 객체가 완전한 상태여야 함을 의미한다.

//Product는 완전히 하나여야 한다. Product product = productRepository.findBy(id);

조회 시점에서 애그리거트를 완전한 상태가 되도록 하려면 애그리거트 루트에서 연관 매핑의 조회방식을 즉시 로딩(FetchType.EAGER)으로 설정하면된다.

컬렉션이나 @Entity에대한 매핑의 fetch 속성을 즉시 로딩으로 설정하면 EntityManager#find() 메서드로 애그리거트 루트를 구할 때 연관된 구성요소를 DB에서 함께 읽어온다.

//@Entity 컬렉션에 대한 즉시 로딩 설정 @OneToMany(cascade = {CascadeType.RERSIST, CascadeType.REMOVE}, orphanRemoval = true, fetch=FetchType.EAGER) @JoinColumn(name="product_id") @OrderColumn(name="list_index") private List<Image> images = new ArrayList<Image>();

//@Embeddable컬렉션에 대한 즉시 로딩 설정 @ElementCollection(fetch = FetchType.EAGER) @CollectionTable(name="order_line", joinColumns = @JoinColumn(name="order_number")) @OrderColumn(name="list_index") private List<OrderLIne> orderLines;

즉시 로딩 방식으로 설정을하면 애그리거트 루트를 로딩하는 시점에 애그리거트에 속한 모든 객체를 함께 로딩할 수 있는 장점이 있지만, 

이 장점이 항상 좋은 것은 아니다.

특히 컬렉션에 대한 로딩 전략을 FetchType.EAGER로 설정하면 오히려 즉시 로딩 방식이 문제가 될수 있다.

예) Product 애그리거트 루트가 @Entity로 구현한 Image와 @Embeddable로 구현한 Option 목록을 갖고 있다고 하자

@Entity @Table(name='product') public class Product { @OneToMany( cascade = {CascadeType.RERSIST, CascadeType.REMOVE}, orphanRemoval = true, fetch=FetchType.EAGER) ) @JoinColumn(name="product_id") @OrderColumn(name="list_index") private List<Image> images = new ArrayList<>(); @ElementCollection(fetch= FetchType.EAGER) @CollectionTable(name="product_option", joinColumn=@JoinColumn(name="product_id")) @OrderColumn(name="list_index") private List<Option> options = new ArrayList<>(); }

이 매핑을 사용할 때 EntityManger#find() 메서드로 Product를 조회하면 하이버네이트는 Product를 위한 테이블, Image를 위한 테이블, Option을 위한 테이블을 조인한 쿼리를 실행한다

select  p.prdouct_id, ... img.product_id, img.image_id, img.list_index, img.imgae_id, .... opt.product_id, opt.option_title, opt.option_value, opt.list_index from product p left outer join image img on p.product_id = img.product_id left outer join product_option opt on p.product_id = opt.proudct_id where p.product_id = ?

이 쿼리는 카타시안 조인을 사용하는데, 이는 쿼리 결과에 중복을 발생시킨다.

조회하는 Prdouct의 image가 2개 이고 option이 2개이면 위 쿼리 결과로 구해지는 행 개수는 4개이다.

즉 product 테이블의 정보는 4번 중복되고 image와 product_option 테이블의 정보는 2번 중복된다.

물론, 하이버네이트가 중복된 데이터를 알맞게 제거해서 실제 메모리에는 1개의 Product 객체, 2개의 Image 객체, 2개의 Option  객체로 변환해주지만 애그리거트가 커지면 문제가 될수 있다.

만약 한 개 제품에 대한 이미지가 20개이고  Option이 15개이면 EntityManager#find() 메서드가 실행하는 쿼리는 250행을 리턴한다.

실제 필요한 행 개수가 36(1+20+15)것에 비하면 250개는 과도하게 많다.

보통 조회 성능 문제 때문에 즉시 로딩 방식을 사용하지만 이 경우 오히려 즉시 로딩 방식 때문에 조회 성능이 나빠지기는 문제가 발생한다.

애그리거트는 개념적으로 하나여야 한다.

하지만 루트 엔티티를 로딩하는 시점에 애그리거트에 속한 객체를 모두 로딩해야하는 것은 아니다.

애그리거트가 완전해야 하는 이유는 두가지 정도 생각해 볼수 있다.

첫 번째 이유는 상태를 변경하는 기능을 실행할 때 애그리거트 상태가 완전해야 하고, 두번째 이유는 표현영역에서 애그리거트의 상태 정보를 보여줄 때 필요하기 때문이다.

이 중 두번째는 별도의 조회 전용 기능을 구현하는 방식을 사용하는 것이 유리할 때가 많기 때문에 애그리거트의 완전한 로딩과 관련된 문제는 상태 변경과 더 관련이 있다.

상태변경기능을 실행하기 위해 조회 시점에 즉시 로딩을 이용해서 애그리거트를 완전한 상태로 로딩할 필요는 없다.

JPA는 트랜잭션 범위 내에서 지연로딩을 허용하기  때문에 실제로 상태를 변경하는 시점에 필요한 구성요소만 로딩해도 문제가 되지 않는다.

@Transactional public void remveOptions(ProductId id, int optIdxToBeDeleted){ // Product를 로딩, 컬렉션은 지연 로딩으로 설정했다면  Option은 로딩하지 않음 Product product = productRepository.findById(id); // 트랜잭션 범위므로 지연로딩으로 설정한 연관 로딩 가능 product.removeOption(optIdxToBeDeleted); }

@Entity public class Product { @ElementCollection(fetch= FetchType.LAZY) @CollectionTable(name="product_option", joinColumns = @JoinColumn(name='product_id')) @OrderColumn(name="list_index") private List<Option> options = new ArrayList<>(); public void removeOption(int optIdx){ // 실제 컬렉션에 접근할 때 로딩 this.options.remvoe(optIdx); } }

게다가 일반적인 애플리케이션은 상태를 변경하는 기능을 수행하는 빈도보다 조회가는 기능을 실행하는 빈도가 훨씬높다.

그러므로 상태 변경을 위해 지연 로딩을 사용할 때 발생하는 추가 쿼리로 인한 실행속도 저하는 문제가 되 지 않는다.

이런 이유로 애그리거트 내의 모든 연관을 즉시 로딩으로 설정할 필요는 없다.

지연 로딩은 동작방식이 항상 동일하기 때문에 즉시 로딩처럼 경우의 수를 따질 필요가 없는 장점이 있다.

(즉시 로딩설정은 @Entity나 @Embeddable  에 대해 다르게 동작하고 JPA프로바이더에 따라 구현 방식이 다를 수 있다.)

물론 지연 로딩은 즉시 로딩보다 쿼리 샐행 횟수가 많아질 가능성이 더 높다.

따라서 무조건 로딩이나 지연 로딩으로만 설정하기 보다는 애그리거트에 맞게 즉시 로딩과 지연로딩을 선택해야한다.

애그리거트의 영속성 전파

애그리거트가 완전한 상태여야 한다는 것은 애그리거트 루트를 조회할 때뿐만 아니라 저장하고 삭제할 때도 하나로 처리해야 함을 의미한다.

저장메서드는 애그리거트 루트만 저장하면 안되고 애그리거트에 속한 모든 객체를 저장해야 한다.

삭제 메서드는 애그리거트 루트 뿐만아니라 애그리거트에 속한 모든 객체를 삭제 해야한다.

@Embeddable 매핑 타입의 경우 함께 저장되고 삭제되므로 cascade 속성을 추가로 설정하지 않아도 된다.

반면에 애그리거트에 속한 @Entity 타입에 대한 매핑은 cascade 속성을 사용해서 저장과 삭제시에 함께 처리되도록 설정해야한다.

@OneToOne, @OneToMany는 cascade 속성의 기본값이 없으므로 cascade속성값으로 CascadeType.RERSIST, CascadeType.REMOVE를 설정한다.

@OneToMnay(cascade = {CascadeType.PERSIST, CascadeType.REMOVE}, orphanRemoval=true) @JoinColumn(name="product_id") @OrderColumn(name="list_index") private List<Image> images = new ArrayList<>();

식별자 생성 기능

식별자는 크게 3가지 방식중 하나로 생성한다.

사용자가 직접생성

도메인 로직으로 생성

DB를 이용한 일련번호 사용

이메일 주소처럼 사용자가 직접 식별자를 입력하는 경우는 식별자 생성 주체가 사용자이기 때문에 도메인 영역 식별자 생성 기능을 구현할 필요가 없다.

식별자 생성 규칙이 있는 경우 엔티티를 생성할 때 이미 생성한 식별자를 전달하므로 엔티티가 식별자 생성 기능을 제공하는 것보다 별도 서비스로 식별자 생성 기능을 분리해야한다.

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

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

응용 서비스는 이 도메인 서비를 이용해서 식별자를 구하고 엔티티를 생성할 것이다.

public class CreateProductService { @Autowired private ProductIdService idService; @Autowired private ProductRepository productRepository; @Transactional public ProductId createProduct(ProductCreateCommnad cmd){ //응용 서비스는 도메인 서비를 이용해서 식별자를 생성 ProductId id = productIdService.nextId(); Product product = new Product(id, cmd.getDetail(), cmd.getPrice(), ...); productRepository.save(product); return id; } }

특정 값의 조합으로 식별자가 생성되는 것 역시 규칙이므로 도메인 서비스를 이용해서 식별자를 생성할 수 있다.

예를 들어 주문번호를 고객ID와 타임스템프로 구성한다고 할 경우 도메인 서비스를 구현할 수 있다.

public class OrderIdService { public OrderId createId(UserId userId){ if(userId == null) throw new IllegalArgumentException("invalid userid :" + userId); return new OrderId(userId.toString() + "_" + timestamp()); } private String  timestamp() { return Long.toString(System.currentTimeMillis()); } }

식별자 생성 규칙을 구현하기에 적합한 또 다른 장소는 리포지터리이다.

리포지터리 인터페이스에 식별자를 생성하는 메서드를 추가하고 리포지터리 구현 클래스에서 알맞게 구현하면 된다.

public interface ProductRepository { // save()  등 다른 메서드 //식별자를 생성하는 메서드 ProductId nextId(); }

식별자 생성은 DB의 자동 증가 칼럼을 사용할 경우 JPA의 식별자 매핑에서 @GeneratedValue를 사용한다.

@Entity @Table(name="article") public class Article { @Id @GeneratedValue(Strategy = GenerationType.IDENTITY) private Long id; public Long getId(){ return id; } }

자동 증가 칼럼은 DB의 insert 쿼리를 실행해야 식별자가 생성되므로 도메인 객체를 리포지터리에 저장할 때 식별자가 생성된다.

도메인 객체를 생성하는 시점에는 식별자를 알수 없고 도메인 객체를 저장한 뒤에 식별자를 구할 수 있음을 의미한다.

public class WriterArticleService { private ArticleRepository articleRepository; public Long write(NewArticleRequest req) { Article article = new Article("제목", new ArticleContent("content","type") ); articleRepository.save(article); //실행 시점에 식별자 생성 return article.getId(); //저장 이후 식별자 사용 가능 } }

JPA는 저장 시점에 생성한 식별자를 @Id로 매핑한 프로퍼티/필드에 할당한다.

자동증가 칼럼 외에 JPA의 식별자 생성 기능을 사용하는 경우에도 마찬가지로 저장 시점에 식별자를 생성한다.

DDD START! 도메인주도설꼐구현과 핵심개념 익히기 저자-최범균