[JPA] 값 타입

출처

https://www.inflearn.com/course/ORM-JPA-Basic/dashboard

자바 ORM 표준 JPA 프로그래밍 - 기본편 강의 - 인프런

 

목차

 

JPA의 데이터 타입 분류

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

 

값 타입 분류

• 기본값 타입 - Java 제공
  • 자바 기본 타입(int, double)
  • 래퍼 클래스(Integer, Long)
  • String
• 임베디드 타입(embedded type, 복합 값 타입) - 직접 정의해서 사용
  • ex) 좌표를 표현 (x좌표, y좌표를 속성으로 묶어서 사용)
• 컬렉션 값 타입(collection value type) - 직접 정의해서 사용 
  • Collection에 기본값 타입이나 임베디드 타입을 넣어서 사용

 

기본값 타입

• 예) String name, int age
• 생명주기를 엔티티에 의존합니다. ⭐
  • 예) 회원을 삭제하면 이름, 나이 필드도 함께 삭제됩니다.
• 값 타입은 공유되면 안됩니다. 
  • 예) 회원 이름 변경 시, 다른 회원의 이름도 함께 변경되면 안됩니다.(side effect)
  • 따라서, Java에서 애초에 공유가 불가능하게 설계되어 있습니다.

자바의 기본 타입은 절대 공유되지 않는다.

• int, double 같은 기본 타입(primitive type)은 절대 공유되지 않습니다.
• 기본 타입은 항상 값을 복사하여 사용합니다.
• 따라서 안전합니다.

int a = 10;
int b = a;    //b에는 a에 있는 값을 복사하여 저장한다. 즉, 각각 따로 저장공간을 가지고 있다. 

b = 20;

System.out.println("a = " + a);  //a = 10
System.out.println("b = " + b);  //b = 20

• Integer같은 래퍼 클래스나 String 같은 특수한 클래스는 공유는 가능한 객체이지만, 변경이 되지는 않습니다. (setter와 같은 함수가 정의되어 있지 않습니다.)

Integer a = new Integer(10);
Integer b = a;    //주소값(레퍼런스, 참조값)이 넘어간다.

a.setValue(20);   //a.setValue()라는 함수는 없지만, 만약에 있다면

System.out.println(a);  //a = 20
System.out.println(b);  //b = 20

 

 

임베디드 타입(복합 값 타입)

• 새로운 값 타입을 직접 정의할 수 있습니다.
• JPA는 임베디드 타입(embedded type)이라 합니다.
• 주로 기본 값 타입을 모아서 만들어서 복합 값 타입이라고도 합니다.
• 임베디드 타입도 int, String과 같은 값 타입입니다. (엔티티가 아니다.) ⭐

예시

• 회원 엔티티는 이름, 근무 시작일, 근무 종료일, 주소 도시, 주소번지, 주소 우편번호를 가집니다.

• 임베디드 타입을 사용해서 회원 엔티티는 이름,  근무 기간, 집 주소 를 가지도록 단순화할 수 있습니다.

• 단순히 말하면, Period 와 Address 클래스를 생성하고, 관련된 속성을 가집니다.
• 문제는 JPA에서 해당 클래스를 어떻게 사용하고 매핑할 수 있을까요?

 

임베디드 타입 사용법

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

 

임베디드 타입의 장점

• 재사용 (ex) Period나 Address 속성이 필요한 곳에 재사용할 수 있습니다.)
• 높은 응집도
• Period.isWork()처럼 해당 값 타입만 사용하는 의미 있는 메소드를 만들 수 있습니다. 
• 임베디드 타입을 포함한 모든 값 타입은 값 타입을 소유한 엔티티에 생명주기를 의존합니다.

 

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

• DB 테이블 입장에서는 값 타입을 쓰거나, 쓰지 않아도 변경되지 않습니다. 
• 객체 입장에서 데이터 뿐만 아니라 메서드도 가질 수 있으므로 묶었을 때 다양한 이득이 있어 사용합니다. 
• 임베디드 값 타입을 사용하기 위해선 매핑이 필요합니다.

@Embeddable, @Embedded

@Embeddable
public class Period {
    private LocalDateTime startDate;
    private LocalDateTime endDate;
		...
}

@Embeddable
public class Address {
    private String city;
    private String street;
    private String zipcode;
		...
}

@Entity
public class Member {
    @Id
    private Long id;
    @Column(name = "name")
    private String username;

    @Embedded
    private Period workPeriod;
    @Embedded
    private Address homeAddress;
}

 

Member member = new Member();
member.setUsername("hello");
member.setHomeAddress(new Address("city", "street", "zipcode"));
member.setWorkPeriod(new Period(LocalDateTime.now(), LocalDateTime.now()));

em.persist(member);

 

 

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

• 임베디드 타입은 엔티티의 값일 뿐입니다. 
• 임베디드 타입을 사용하기 전이나 후나 매핑하는 테이블의 구조는 같습니다. 
• 객체와 테이블을 아주 세밀하게(find-grained) 매핑하는 것이 가능해집니다. 
• 잘 설계한 ORM 애플리케이션은 매핑한 테이블의 수보다 클래스의 수가 더 많습니다. (값 타입들이 많다.)

 

임베디드 타입과 연관관계

• 값 타입 Address가 값 타입 Zipcode를 가질 수 있습니다. 
• 값 타입 PhoneNumber가 엔티티 PhoneEntity를 가질 수 있습니다.

 

속성 재정의: @AttributeOverride

한 엔티티에서 같은 값 타입을 사용할 때 사용합니다.

@Entity
public class Member {
	...
	@Embedded
	private Address homeAddress;
	@Embedded
	private Address workAddress;
}

• 위와 같은 경우, DB 컬럼에 매핑이 될 때 컬럼명이 중복이 됩니다. 
• @AttributeOverrides, @AttributeOverride를 사용해서 컬럼명을 재정의할 수 있습니다.

@Entity
public class Member {
    ...
    @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;
}

 

 

임베디드 타입과 null

임베디드 타입의 값이 null이면, 매핑한 컬럼 값도 모두 null입니다.

@Entity
public class Member {
    @Embedded
    private Period workPeriod = null;
}

@Embeddable
public class Period {
    private LocalDateTime startDate = null;
    private LocalDateTime endDate = null;
}

 

 

값 타입과 불변 객체

값 타입은 복잡한 객체 세상을 조금이라도 단순화하려고 만든 개념입니다. 따라서 값 타입은 단순하고 안전하게 다룰 수 있어야 합니다.

 

값 타입 공유 참조

• 임베디드 타입 같은 값 타입을 여러 엔티티에서 공유하면 위험합니다. 
• 부작용(side effect) 발생

Address address = new Address("city", "street", "10000");

Member member1 = new Member();
member1.setUsername("member1");
member1.setHomeAddress(address);
em.persist(member1);

Member member2 = new Member();
member2.setUsername("member2");
member2.setHomeAddress(address);
em.persist(member2);

tx.commit();

member1.getHomeAddress().setCity("newCity");  //member1의 주소값 중 city 값 변경
//Update Query 2번 발생

⇒ 이런 종류의 side effect로 발생하는 버그는 잡기가 더욱 힘듭니다.

 

참고
만약, 이런 side effect를 일부러 의도했다면 (같은 주소값을 공유하도록) 이런 경우에는 값 타입이 아니라 Address를 엔티티로 만들어 사용해야 합니다. 

 

 

해결책: 복사

• 값 타입의 실제 인스턴스인 값을 공유하는 것은 위험합니다. 
• 따라서, 값(인스턴스)를 복사해서 사용해야 합니다.

Address address = new Address("city", "street", "10000");

Member member1 = new Member();
member1.setUsername("member1");
member1.setHomeAddress(address);
em.persist(member1);

Address copyAddress = new Address(address.getCity(), address.getStreet(), address.getZipcode());

Member member2 = new Member();
member2.setUsername("member2");
member2.setHomeAddress(copyAddress);
em.persist(member2);

//
member.getHomeAddress().setCity("newCity");

 

객체 타입의 한계

• 항상 값을 복사해서 사용하면 공유 참조로 인해 발생하는 부작용을 피할 수 있습니다.
• 하지만, 객체 타입은 참조 값을 직접 대입하는 것을 막을 방법이 없습니다. 

[기본 타입(primitive type)]

int a = 10;
int b = a;  //기본 타입은 값을 복사
b = 4;

---
a는 여전히 10

[객체 타입]

Address a = new Address(“Old”);
Address b = a;   //객체 타입은 참조를 전달
b.setCity(“New”)

---
a도 "New"로 변경

 

불변 객체

• 객체 타입을 수정할 수 없게 만들면 부작용을 원천 차단할 수 있습니다. 
• 따라서, 값 타입은 불변 객체(immutable object)로 설계해야합니다. 
• 불변 객체: 생성 시점 이후 절대 값을 변경할 수 없는 객체
• 생성자로만 값을 설정하고 수정자(Setter)를 만들지 않으면 됩니다.
• 참고: Integer, String은 자바가 제공하는 대표적인 불변 객체

 

값 타입의 비교

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

int a = 10;
int b = 10;

Address a = new Address(“서울시”)
Address b = new Address(“서울시”)

• 동일성(identity) 비교: 인스턴스의 참조 값을 비교합니다. == 사용
• 동등성(equivalence) 비교: 인스턴스의 값을 비교합니다. equals() 사용
• 값 타입은 a.equals(b)를 사용해서 동등성 비교를 해야 합니다. 
• 값 타입의 equals() 메소드를 적절하게 재정의해야 합니다 (주로 모든 필드 사용)

@Embeddable
public class Address {

    ...
    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        Address address = (Address) o;
        return Objects.equals(city, address.city) && Objects.equals(street, address.street)
                && Objects.equals(zipcode, address.zipcode);
    }

    @Override
    public int hashCode() {
        return Objects.hash(city, street, zipcode);
    }
    ...
}

 

 

 

 

---

값 타입 컬렉션

• 값 타입을 하나 이상 저장할 때 사용합니다. 
• 데이터베이스는 컬렉션을 테이블에 저장할 수 없습니다. 
• Member 입장에서 List<Address>는 일대다와 같은 개념입니다. 
• 따라서, 컬렉션을 저장하기 위한 별도의 테이블이 필요합니다. 
• @ElementCollection, @CollectionTable

@Entity
public class Member {

    ...
    
    @ElementCollection
    @CollectionTable(name = "FAVORITE_FOOD", joinColumns = @JoinColumn(name = "MEMBER_ID"))
    @Column(name = "FOOD_NAME")
    private Set<String> favoriteFoods = new HashSet<>();

    @ElementCollection
    @CollectionTable(name = "ADDRESS", joinColumns = @JoinColumn(name = "MEMBER_ID"))
    private List<Address> addressHistory = new ArrayList<>();
    
    ...
}

Hibernate:
  create table Member {
      MEMBER_ID bigint not null,
      city varchar(255),
      street varcar(255),
      zipcode varchar(255),
      USERNAME varchar(255),
      TEAM_ID bigint,
      primary key (MEMBER_ID)
  }

Hibernate:
  create table FAVORITE_FOOD {
      MEMBER_ID bigint not null,
      FOOD_NAME varchar(25)
  }

Hibernate:
  create table ADDRESS {
      MEMBER_ID bigint not null,
      city varchar(255),
      street varchar(255),
      zipcode varchar(255)
  }

 

 

값 타입 컬렉션 실습

값 타입 저장

Member member = new Member();
member.setUsername("member1");
member.setHomeAddress(new Address("homeCity", "street", "10000"));

member.getFavoriteFoods().add("치킨");
member.getFavoriteFoods().add("족발");
member.getFavoriteFoods().add("피자");

member.getAddressHistory().add(new Address("old1", "street1", "10000"));
member.getAddressHistory().add(new Address("old2", "street1", "10000"));

em.persist(member);

• Member만 persist 했는데, 다른 테이블의 값들도 모두 저장되었습니다. 
• 값 타입도 본인 스스로의 라이프 사이클이 없고, Member가 전담합니다. (String username과 마찬가지)
• 참고: 값 타입 컬렉션은 영속성 전이(Cascade) + 고아 객체 제거 기능을 필수로 가집니다.

 

값 타입 조회

• 값 타입 컬렉션도 지연 로딩 전략 사용을 사용합니다.

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

Hibernate:
  select
    MEMBER_ID,
    city,
    street,
    zipcode,
    USERNAME
  form Member
  where MEMBER_ID=?

• Member 테이블만 조회합니다.

Member findMember = em.find(Member.class, member.getId());
List<Address> addressHistory = findMember.getAddressHistory();
for (Address address : addressHistory) {
    System.out.println("address=" + address.getCity());
}

Set<String> favoriteFoods = findMember.getFavoriteFoods();
for (String favoriteFood : favoriteFoods) {
    System.out.println("favoriteFood= " + favoriteFood);
}

Hibernate:
  select
    MEMBER_ID,
    city,
    street,
    zipcode,
    USERNAME
  from
    Member
  where 
    MEMBER_ID=?

Hibernate:
  select
    MEMBER_ID,
    city,
    street,
    zipcode
  from
    ADDRESS
  where 
    MEMBER_ID=?

Hibernate:
  select
    MEMBER_ID,
    FOOD_NAME
  from
    FAVORITE_FOOD
  where
    MEMBER_ID=?

 

 

값 타입 수정

• 값 타입 컬렉션은 영속성 전이(Cascade) + 고아 객체 제거 기능을 필수로 가집니다.

//homeCity -> newCity
//findMember.getHomeAddress().setCity("newCity");  //사용하면 X
Address oldAddress = findMember.getHomeAddress();
findMember.setHomeAddress(new Address("newCity", oldAddress.getStreet(), oldAddress.getZipcode()));

//치킨 -> 한식
findMember.getFavoriteFoods().remove("치킨");
findMember.getFavoriteFoods().add("한식");

//old1 -> new1
findMember.getAddressHistory().remove(new Address("old1", "street1", "10000")); //equals 와 hashcode 가 재정의되어 있어야 한다.
findMember.getAddressHistory().add(new Address("newCity1", "street1", "10000"));

Hibernate:
  delete 
    from
      ADDRESS
    where
      MEMER_ID=?
//ADDRESS에 있는 MEMBER_ID가 일치하는 모든 데이터를 삭제

//남아있는 기존의 데이터와 새로 변경한 데이터 2개를 삽입
Hibernate:
  insert
    into
      ADDRESS (MEMBER_ID, city, street, zipcode)
    values
      (?, ?, ?, ?) 
Hibernate:
  insert
    into
      ADDRESS (MEMBER_ID, city, street, zipcode)
    values
      (?, ?, ?, ?)

 

 

값 타입 컬렉션의 제약사항

• 값 타입은 엔티티와 다르게 식별자 개념이 없으므로, 값을 변경하면 추적이 어렵습니다. 
• 따라서, 값 타입 컬렉션에 변경 사항이 발생한다면, 주인 엔티티와 연관된 모든 데이터를 삭제하고, 값 타입 컬렉션에 있는 현재 값을 모두 다시 저장합니다. ⭐
• 또한, 값 타입 컬렉션을 매핑하는 테이블은 모든 컬럼을 묶어서 기본 키를 구성해야 합니다. 그래야, null 입력X, 중복 저장X

 

값 타입 컬렉션 대안

• 실무에서는 상황에 따라 값 타입 컬렉션 대신에 일대다 관계를 고려합니다. 
• 일대다 관계를 위한 엔티티를 만들고, 여기에 값 타입을 사용합니다. 
• 영속성 전이(Cascade) + 고아 객체 제거를 사용해서 값 타입 컬렉션 처럼 사용합니다.

EX) AddressEntity

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

@Entity
public class Member {

    ...

    @OneToMany(cascade = CascadeType.ALL, orphanRemoval = true)
    @JoinColumn(name = "MEMBER_ID")
    private List<AddressEntity> addressHistory = new ArrayList<>();
    
    ...
}

member.getAddressHistory().remove(new AddressEntity("old1", "street1", "10000"));
member.getAddressHistory().add(new AddressEntity("newCity1", "street1", "10000"));

 

 

정리

• 엔티티 타입의 특징
  • 식별자 O
  • 생명 주기 관리
  • 공유 가능
• 값 타입의 특징
  • 식별자 X
  • 생명 주기를 엔티티에 의존
  • 공유하지 않는 것이 안전 (복사해서 사용)
  • 불변 객체로 만드는 것이 안전

 

결론

• 값 타입은 정말 값 타입이라 판단될 때만 사용해야 합니다. (ex) 멀티 셀렉트로 넘어오는 값들 (체크 박스) [치킨, 피자])
• 엔티티와 값 타입을 혼동해서 엔티티를 값 타입으로 만들면 안됩니다.
• 식별자가 필요하고, 지속해서 값을 추적, 변경해야 한다면 값 타입이 아닌 엔티티입니다.
  (ex) 주소이력와 같은 데이터도 값을 추적해야 하므로 엔티티)

 

 

---

실전 예제 - 6. 값 타입 매핑

@Embeddable
public class Address {

    @Column(length = 10)
    private String city;
    @Column(length = 20)
    private String street;
    @Column(length = 5)
    private String zipcode;
    
    ...

    //private setter
    private void setCity(String city) {
        this.city = city;
    }

    //equals, hasCode() 재정의
    //프록시를 사용하기 위해선 getter를 사용해서 재정의하는 것이 좋다. 
    @Override
    public boolean equals(Object o) {
        if (this == o) {
            return true;
        }
        if (o == null || getClass() != o.getClass()) {
            return false;
        }
        Address address = (Address) o;
        return Objects.equals(getCity(), address.getCity()) && Objects.equals(getStreet(),
                address.getStreet()) && Objects.equals(getZipcode(), address.getZipcode());
    }

    @Override
    public int hashCode() {
        return Objects.hash(getCity(), getStreet(), getZipcode());
    }
}

@Entity
public class Member extends BaseEntity{
    ...
    @Embedded
    private Address address;
}

@Entity
public class Delivery extends BaseEntity {
    ...
    @Embedded
    private Address address;
}

• city, street, zipcode가 공통으로 들어가 있습니다. 
• 값 타입을 사용하면 다음과 같이 의미있는 비지니스 메서드를 만들 수 있습니다.

public String fullAddress() {
    return getCity() + "" + getStreet() + "" + getZipcode();
}