06. JPA Value Object

기본값 타입

---

JPA 의 데이터 타입 분류

• 엔티티 타입
  • @Entity 로 정의하는 객체
  • 데이터가 변해도 식별자로 지속해서 추적 가능
  • 예) 회원 엔티티의 키나 나이 값을 변경해도 식별자로 인식 가능
• 값 타입
  • int, Integer, String 처럼 단순히 값으로 사용하는 자바 기본 타입이나 객체
  • 식별자가 없고 값만 있으므로 변경 시 추적 불가
  • 예) 숫자 100을 200으로 변경하면 완전히 다른 값으로 대체

값 타입 분류

• 기본값 타입
  • 자바 기본 타입
  • 래퍼 클래스
  • String
• 임베디드 타입
• 컬렉션 값 타입

기본값 타입

• 예) String name, int age
• 생명주기를 엔티티에 의존
  • 예) 회원을 삭제하면 이름, 나이 필드도 함께 삭제
• 값 타입은 공유하면 X
  • 예) 회원 이름 변경 시 다른 회원의 이름도 함께 변경되면 안됨

임베디드 타입 (중요)

---

자바에서 우리는 새로운 값 타입을 직접 정의할 수 있다. JPA 는 이를 임베디드 타입이라고 한다. 주로 기본 값 타입을 모아서 만들어서 복합 값 타입이라고도 한다. 이렇게 만들어진 임베디드 타입은 int String 과 같은 값 타입으로 취급된다.

예시

회원 엔티티는 이름, 근무 시작일, 근무 종료일, 주소 도시, 주소 번지, 주소 우편 번호를 가진다. 이를 추상화 하면 → 회원 엔티티는 이름, 근무 기간, 집 주소를 가진다.

임베디드 타입 사용법

@Entity
public class Member {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    @Column(name = "name")
    private String name;
    @Embedded
    private Period workPeriod;
    @Embedded
    private Address homeAddress;
}

• @Embeddable 값 타입을 정의하는 곳에 표시
• @Embedded 값 타입을 사용하는 곳에 표시
• 기본 생성자 필수

임베디드 타입의 장점

• 재사용
• 높은 응집도
• Period.isWork() 처럼 해당 값 타입만 사용하는 의미 있는 메서드를 만들 수 있음
• 임베디드 타입을 포함한 모든 값 타입은, 값 타입을 소유한 엔티티에 생명주기를 의존함

임베디드 타입과 테이블 매핑

임베디드 타입은 엔티티의 값일 뿐이다. 즉, 임베디드 타입을 사용하기 전과 후에 매핑하는 테이블은 같다. 임베디드 타입을 통해 객체와 테이블을 아주 세밀하게(fine-grained) 매핑하는 것이 가능하다. 때문에, 잘 설계한 ORM 애플리케이션은 매핑한 테이블의 수보다 클래스의 수가 더 많다.

임베디드 타입과 연관관계

@AttributeOverride: 속성 재정의

@Entity
public class Member {
    @Id
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    @Column(name = "name")
    private String name;
    @Embedded
    private Period workPeriod;
    @Embedded
    private Address homeAddress;
    @Embedded
    @AttributeOverrides({
            @AttributeOverride(name = "city", column = @Column(name = "WORK_CITY")),
            @AttributeOverride(name = "street", column = @Column(name = "WORK_STREET")),
            @AttributeOverride(name = "zipcode", column = @Column(name = "WORK_ZIPCODE"))
    })
    private Address workAddress;
}

한 엔티티에서 같은 값 타입을 사용한다면? 컬럼 명이 중복되기 때문에 에러가 발생한다. @AttributeOverrides @AttributeOverride 를 사용해서 컬럼 명 속성을 재정의하여 사용하자.

임베디드 타입과 null

임베디드 타입의 값이 null 이면 매핑한 컬럼 값은 모두 null 이 들어간다.

값 타입과 불변 객체

---

값 타입 공유 참조

임베디드 타입 같은 값 타입을 여러 엔티티에서 공유하면 같은 인스턴스를 사용하고 있기 때문에 변경에 모두 영향을 받을 수 있는 부작용이 발생할 수 있어 위험하다.

값 타입 복사

값 타입의 실제 인스턴스인 값을 공유하는 것은 위험함하기 때문에 인스턴스를 복사해서 사용한다.

객체 타입의 한계

int a = 10;
int b = a;
b = 4;
// a = 10, b = 4
Address a = new Address("Old");
Address b = a;
b.setCity("New");
// a = New, b = New

항상 값을 복사해서 사용하면 공유 참조로 인해 발생하는 부작용을 피할 수 있다. 문제는 임베디드 타입처럼 직접 정의한 값 타입은 자바의 기본 타입이 아니라 객체 타입이다. 자바 기본 타입에 값을 대입하면 값을 복사한다. 객체 타입은 참조 값을 직접 대입하는 것을 막을 방법이 없다. 즉, 객체의 공유 참조는 피할 수 없다.

불변 객체

객체 타입을 수정할 수 없게 만들면 부작용을 원천 차단할 수 있다. 때문에 값 타입은 불변 객체로 설계해야한다. 여기서 불변 객체는 생성 이후 절대 값을 변경할 수 없는 객체를 의미한다.

값 타입의 비교

---

// a 와 b 는 같아야 한다
int a = 10;
int b = 10;
Address a = new Address("서울시");
Address b = new Address("서울시");

값 타입은 인스턴스가 달라도 그 안에 값이 같으면 같은 것으로 봐야 한다.

동일성 비교와 동등성 비교

동일성 비교는 인스턴스의 참조 값을 비교한다. (== 사용) 동등성 비교는 인스턴스의 값을 비교한다. (equals() 사용) 값 타입은 a.equals(b) 를 사용해서 동등성 비교를 수행해야 한다. 값 타입은 equals() 메서드를 적절하게 재정의하여 사용해야 한다. (주로 모든 필드를 사용)

값 타입 컬렉션 (중요)

---

@Entity
public class Member {
    @ElementCollection
    @CollectionTable(name = "FAVORITE_FOOD", joinColumns = @JoinColumn(name = "MEMBER_ID"))
    private Set<String> favoriteFoods = new HashSet<>();
    @ElementCollection
    @CollectionTable(name = "ADDRESS", joinColumns = @JoinColumn(name = "MEMBER_ID"))
    private List<Address> addressHistory = new ArrayList<>();
}

Hibernate: 
    create table ADDRESS (
       MEMBER_ID bigint not null,
        city varchar(255),
        street varchar(255),
        zipcode varchar(255)
    )
Hibernate: 
    create table FAVORITE_FOOD (
       MEMBER_ID bigint not null,
        favoriteFoods varchar(255)
    )
Hibernate: 
    create table Member (
       id bigint generated by default as identity,
        city varchar(255),
        street varchar(255),
        zipcode varchar(255),
        name varchar(255),
        WORK_CITY varchar(255),
        WORK_STREET varchar(255),
        WORK_ZIPCODE varchar(255),
        endDate timestamp,
        startDate timestamp,
        primary key (id)
    )
Hibernate: 
    alter table ADDRESS 
       add constraint FKsuulxb5rmrxvb83yr43ox86wn 
       foreign key (MEMBER_ID) 
       references Member
Hibernate: 
    alter table FAVORITE_FOOD 
       add constraint FKjchfnr69biisfgjdpoe82rpa4 
       foreign key (MEMBER_ID) 
       references Member

값 타입 컬렉션은 값 타입을 하나 이상 저장할 때 사용하며, @ElementCollection 와 @CollectionTable 을 사용하여 DB 에 저장한다. DB 는 컬렉션을 같은 테이블에 저장할 수 없기 때문에, 컬렉션을 저장하기 위한 별도의 테이블이 필요하다.

값 타입 컬렉션 저장

Set<String> favoriteFood = Set.of("치킨", "족발", "피자");
List<Address> addressHistory = List.of(new Address("city1", "street1", "1000"), new Address("city1", "street2", "2000"));
Member member = new Member(null, "member1", favoriteFood, addressHistory);
em.persist(member);

해당 코드를 실행해보면 아래와 같은 쿼리를 볼 수 있다.

Hibernate: 
    /* insert hellojpa.Member
        */ insert 
        into
            Member
            (id, name) 
        values
            (null, ?)
Hibernate: 
    /* insert collection
        row hellojpa.Member.addressHistory */ insert 
        into
            ADDRESS
            (MEMBER_ID, city, street, zipcode) 
        values
            (?, ?, ?, ?)
Hibernate: 
    /* insert collection
        row hellojpa.Member.addressHistory */ insert 
        into
            ADDRESS
            (MEMBER_ID, city, street, zipcode) 
        values
            (?, ?, ?, ?)
Hibernate: 
    /* insert collection
        row hellojpa.Member.favoriteFoods */ insert 
        into
            FAVORITE_FOOD
            (MEMBER_ID, favoriteFoods) 
        values
            (?, ?)
Hibernate: 
    /* insert collection
        row hellojpa.Member.favoriteFoods */ insert 
        into
            FAVORITE_FOOD
            (MEMBER_ID, favoriteFoods) 
        values
            (?, ?)
Hibernate: 
    /* insert collection
        row hellojpa.Member.favoriteFoods */ insert 
        into
            FAVORITE_FOOD
            (MEMBER_ID, favoriteFoods) 
        values
            (?, ?)

여기서 알 수 있는 사실은 Member 엔티티만 persist() 했음에도 불구하고 모든 값 타입 컬렉션들이 저장되는 것을 알 수 있다. 이는 값 타입 컬렉션이 다른 테이블에 저장 되더라도 그냥 값 타입과 다를 바가 없다는 의미이며 생명주기를 Member 엔티티와 동일하게 갖는다는 것을 알 수 있다. 즉, List<Address> 도 사실 String 과 다를 바가 없다는 것이다. 값 타입 컬렉션은 영속성 전이(Cascade All) + 고아 객체 제거 기능을 필수로 가진다고 볼 수 있다.

값 타입 컬렉션 조회

em.flush();
em.clear();
Member findMember = em.find(Member.class, member.getId());

Hibernate: 
    select
        member0_.id as id1_6_0_,
        member0_.name as name2_6_0_ 
    from
        Member member0_ 
    where
        member0_.id=?

Member 엔티티 조회 시 위와 같은 쿼리를 볼 수 있다. 이를 통해 값 타입 컬렉션도 지연 로딩 전략이 사용되고 있다는 것을 알 수 있다. 이는 @ElementCollection 에 fetch 의 기본 설정이 LAZY 로 설정되어있기 때문이다.

값 타입 컬렉션 수정

Member findMember = em.find(Member.class, member.getId());
findMember.getFavoriteFoods().remove("치킨");
findMember.getFavoriteFoods().add("한식");
findMember.getAddressHistory().remove(new Address("city1", "street1", "1000"));
findMember.getAddressHistory().add(new Address("new", "new", "1111"));

값 타입 컬렉션을 수정하는 작업을 위와 같이 실행해보자. Address 같은 경우 동등성 비교를 위해 equals hashcode 를 꼭 재정의 해주어야 한다.

Hibernate: 
    /* delete collection hellojpa.Member.addressHistory */ delete 
        from
            ADDRESS 
        where
            MEMBER_ID=?
Hibernate: 
    /* insert collection
        row hellojpa.Member.addressHistory */ insert 
        into
            ADDRESS
            (MEMBER_ID, city, street, zipcode) 
        values
            (?, ?, ?, ?)
Hibernate: 
    /* insert collection
        row hellojpa.Member.addressHistory */ insert 
        into
            ADDRESS
            (MEMBER_ID, city, street, zipcode) 
        values
            (?, ?, ?, ?)
Hibernate: 
    /* delete collection row hellojpa.Member.favoriteFoods */ delete 
        from
            FAVORITE_FOOD 
        where
            MEMBER_ID=? 
            and favoriteFoods=?
Hibernate: 
    /* insert collection
        row hellojpa.Member.favoriteFoods */ insert 
        into
            FAVORITE_FOOD
            (MEMBER_ID, favoriteFoods) 
        values
            (?, ?)

코드를 실행하고 나면 이런 쿼리가 날아가는 것을 확인할 수 있다. Address 의 경우 요소 하나를 제거하고 하나를 추가하는 쿼리를 기대했지만, 모든 테이블을 밀어버리고 두 개의 INSERT 쿼리문이 날아가는 것을 확인할 수 있다.

값 타입 컬렉션의 제약사항

값 타입은 엔티티와 다르게 식별자 개념이 존재하지 않기 때문에, 값은 변경하면 추적이 어렵다. 때문에, 값 타입 컬렉션에 변경이 발생하면 주인 엔티티와 연관된 모든 데이터를 삭제하고, 값 타입 컬렉션에 있는 현재 값을 모두 다시 저장한다. 값 타입 컬렉션을 매핑하는 테이블은 모든 컬럼을 묶어서 기본 키를 구성해야 한다.

값 타입 컬렉션 대안

실무에서는 상황에 따라 값 타입 컬렉션 대신에 일대다 관계를 고려하는 경우가 많다. 일대다 관계를 위한 엔티티를 만들고, 여기에서 값 타입을 사용하는 방식이다. 영속성 전이와 고아 객체 제거를 통해 값 타입 컬렉션 처럼 사용한다.

@Entity
@Table(name = "ADDRESS")
public class AddressEntity {
    @Id
    @GeneratedValue
    private Long id;
    private Address address;
}

정리

• 엔티티 타입의 특징
  • 식별자가 있다
  • 생명 주기 관리
  • 공유할 수 있다
• 값 타입의 특징
  • 식별자가 없다
  • 생명 주기를 엔티티에 의존
  • 공유하지 않는 것이 안전 (복사해서 사용)
  • 즉, 불변 객체로 만드는 것이 안전
• 값 타입은 정말 값 타입이라 판단될 때만 사용
• 엔티티와 값 타입을 혼동해서 엔티티를 값 타입으로 만들면 안됨
• 식별자가 필요하고, 지속해서 값을 추적, 변경해야 한다면 엔티티로 구성하자

실전 예제 6 - 값 타입 매핑

---