[JPA] 값 타입 (엔티티 타입과 비교 / 기본값타입 / 임베디드타입 / 컬렉션 값타입)
* 정보전달의 목적이 아닌 개인 스터디 정리 글 입니다.
강의 : 인프런 <자바 ORM 표준 JPA 프로그래밍 기본편>
교육자 : 김영한
JPA 데이터 타입
엔티티 타입
- @Entity로 정의한 객체
- 데이터가 변해도 식별자로 추적 가능
ex) 회원 엔티티의 키나 나이 값을 변경해도 식별자로 인식 가능
값 타입
- int, Integer, String처럼 단순히 값으로 사용하는 자바 기본 타입이나 객체
- 식별자가 없고 값만 있어 값 변경시 추적 불가
ex) 숫자 100을 200으로 변경하면 다른값으로 대체됨
1. 기본값 타입
: 생명주기를 엔티티에 의존하며 값 타입은 공유하여 사용할 수 없음
- 자바 기본 타입 (int, double)
- 래퍼 클래스 (Integer, Long)
- String
2. 임베디드 타입 (복합 값 타입)
: 새로운 값 타입을 직접 정의할 수 있으며 주로 기본 값 타입을 모아 만들어 복합 값 타입 이라고도함
ex) 회원 엔티티에 주소가 도시, 번지수, 우편번호로 나누어져있는 부분을 '주소'로 묶어 사용
사용법
- @Embeddable : 값 타입을 정의하는 곳에 표시
- @Embedded : 값 타입을 사용하는 곳에 표시
- @AttributeOverride : 속성 재정의 (한 엔티티에서 같은 값 타입으로 중복해서 사용할 경우)
- 기본 생성자 필수
* 임베디드 타입의 값이 null이면 매핑한 컬럼 값은 모두 null이됨
Address class (임베디드 타입)
import jakarta.persistence.Embeddable;
import java.util.Objects;
@Embeddable
public class Address {
private String city;
private String street;
private String zipcode;
public Address() {}
public Address(String city, String street, String zipcode) {
this.city = city;
this.street = street;
this.zipcode = zipcode;
}
public String getCity() {
return city;
}
//setter의 경우 사용하지 않거나 private으로 설정필요
private void setCity(String city) {
this.city = city;
}
public String getStreet() {
return street;
}
private void setStreet(String street) {
this.street = street;
}
public String getZipcode() {
return zipcode;
}
private void setZipcode(String zipcode) {
this.zipcode = zipcode;
}
@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 class (회원 엔티티)
@Entitiy
public class Memeber {
@Id @GeneratedValue
@Column(name = "MEMBER_ID")
private Long id;
@Column(name = "USERNAME")
private String name;
@Embedded
private Address homeAddress;
//Address라는 값타입을 중복해서 사용할 경우 이와 같이 컬럼명을 재정의
@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;
//.. 생략
}
회원 엔티티의 Address를 이와 같이 컬럼명을 재정의 할 경우 생성되는 테이블
임베디드 타입 장점
- 재사용성
- 높은 응집도
- 해당 값 타입만 사용하는 의미 있는 메서드를 만들 수 있음
- 임베디드 타입을 포함한 모든 값 타입은 값타입을 소유한 엔티티에 생명주기를 의존함
임베디드 타입과 테이블 매핑
- 임베디드 타입은 엔티티의 값일 뿐임
- 임베디드 타입을 사용하기 전과 후에 매핑하는 테이블은 같음
- 객체와 테이블을 아주 세밀하게 매핑하는 것이 가능
- 잘 설계한 ORM 애플리케이션은 매핑한 테이블 수보다 클래스 수가 더 많음
값 타입과 불변 객체
값 타입은 복잡한 객체를 단순화하려고 만든 개념이다.
따라서 값 타입은 단순하고 안전하게 다룰 수 있어야한다.
값 타입 공유 참조
- 임베디드 타입 같은 값 타입을 여러 엔티티에서 공유하면 위험함
- 부작용 발생
import jakarta.persistence.*;
public class JpaMain {
public static void main(String[] args) {
EntityManagerFactory emf = Persistence.createEntityManagerFactory("hello");
EntityManager em = emf.createEntityManager();
EntityTransaction tx = em.getTransaction();
tx.begin();
try {
Member member1 = new Member();
member1.setName("member1");
member1.setHomeAddress(new Address("abc","def", "111"));
em.persist(member1);
Member member2 = new Member();
member2.setName("member2");
member2.setHomeAddress(new Address("abc","def", "111"));
em.persist(member2);
//setter를 public으로 설정했을 경우
member1.getHomeAddress().setCity("newCity");
tx.commit();
} catch (Exception e) {
tx.rollback();
} finally {
em.close();
}
emf.close();
}
}
Address 임베디드 타입의 setter를 public으로 설정 후에 이와 같은 코드를 실행시키면
member1만 업데이트 될거라는 예상과 달리 member1과 member2의 City명이 함께 변경된다. (부작용)
따라서 값 타입의 실제 인스턴스 값을 공유하는 것은 위험하니 값을 복사해서 사용해야한다.
Address addr = new Address("abc", "def", "111");
Address copyAddr = new Address("newCity", addr.getStreet(), addr.getZipcode());
Member member2 = new Member();
member2.setName("member2");
member2.setHomeAddress(copyAddr);
em.persist(member2);
복사하여 저장한 결과
그러나 이러한 복사 방법에도 한계가 있다.
객체 타입의 한계
- 항상 값을 복사해서 사용하면 공유 참조로 인해 발생하는 부작용을 피할 수 없다.
- 문제는 임베디드 타입처럼 직접 정의한 값 타입은 자바의 기본 타입이 아니라 객체타입이다.
- 자바 기본 타입에 값을 대입하면 값을 복사한다.
- 객체 타입은 참조 값을 직접 대입하는 것을 막을 방법이 없다.
- 객체의 공유 참조는 피할 수 없다.
//기본 타입 : a와 b가 다른 값을 가짐
int a = 10;
int b = a; //기본 타입은 값을 복사함
b = 4;
//객체 타입 : a와 b가 같은 값을 가짐
Address a = new Address("Old");
Address b = a; //객체 타입은 참조(주소)를 전달
b.setCity("New");
따라서 값 타입을 불변 객체로 만들어야한다.
불변 객체
- 생성 시점 이후 절대 값을 변경할 수 없는 객체
- 객체 타입을 수정할 수 없게 만들어 부작용을 원천 차단
- 생성자로만 값을 설정하고 수정자(Setter)를 만들지 않거나 private으로 설정
- 참고 : Integer, String은 자바가 제공하는 대표적인 불변 객체
값 타입의 비교
인스턴스가 달라도 그 안에 값이 같으면 같은 것으로 봐야함
int a = 10;
int b = 10;
Address a = new Address("서울시");
Address b = new Address("서울시");
//a와 b는 같은것으로 봐야한다.- 동일성 비교 : 인스턴스의 참조 값을 비교 ( == 사용 )
- 동등성 비교 : 인스턴스의 값을 비교 ( equals() 사용 )
- 값 타입은 a.equals(b)를 사용해서 동등성 비교를 해야함
- 값 타입의 equals()메소드를 적절하게 재정의 : 위의 Address 예시 처럼 equals와 hashcode를 override
3. 컬렉션 값 타입
- 값 타입을 하나 이상 저장할 때 사용
- @ElementCollection, @CollectionTable 사용
- 데이터베이스는 컬렉션을 같은 테이블에 저장할 수 없음
- 컬렉션을 저장하기 위한 별도의 테이블이 필요함
- Member class에 컬렉션 값 타입 추가
@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<>();
public Set<String> getFavoriteFoods() {
return favoriteFoods;
}
public void setFavoriteFoods(Set<String> favoriteFoods) {
this.favoriteFoods = favoriteFoods;
}
public List<Address> getAddressHistory() {
return addressHistory;
}
public void setAddressHistory(List<Address> addressHistory) {
this.addressHistory = addressHistory;
}
- 컬렉션 값 타입 저장
import jakarta.persistence.*;
public class JpaMain {
public static void main(String[] args) {
EntityManagerFactory emf = Persistence.createEntityManagerFactory("hello");
EntityManager em = emf.createEntityManager();
EntityTransaction tx = em.getTransaction();
tx.begin();
try {
Member member1 = new Member();
member1.setName("member1");
member1.setHomeAddress(new Address("homeCity","street", "11111"));
//collection 저장
member1.getFavoriteFoods().add("치킨");
member1.getFavoriteFoods().add("피자");
member1.getFavoriteFoods().add("햄버거");
//collcetion 저장
member1.getAddressHistory().add(new Address("oldCity1","street", "11111"));
member1.getAddressHistory().add(new Address("oldCity2","street", "11111"));
em.persist(member1);
tx.commit();
} catch (Exception e) {
tx.rollback();
} finally {
em.close();
}
emf.close();
}
}
- 저장 결과 (컬렉션 테이블 분리됨)
- 컬렉션 값 타입 조회 : 지연로딩 전략이 적용됨
Member 조회시 임베디드 타입은 같이 조회하지만 컬렉션은 조회하지않음.
ex ) homeAddress의 경우는 임베디드 타입이므로 member 엔티티를 가져올때 같이 조회되지만
favorite_food와 address_history는 실제 food와 address값을 사용할때 조회됨
- 컬렉션 값 수정
Member findMember = em.find(Member.class, member1.getId());
// findMember.getHomeAddress().setCity("newCity"); //절대 금지
Address oldAddr = member1.getHomeAddress();
findMember.setHomeAddress(new Address("newCity", oldAddr.getStreet(), oldAddr.getZipcode()));
//임베디드 타입은 이와같이 통째로 바꿀것
//컬렉션의 경우 : 컬렉션에서 지우고 추가할것
//치킨->삼겹살 수정시
findMember.getFavoriteFoods().remove("치킨");
findMember.getFavoriteFoods().add("삼겹살");
//oldCity1 -> newCity2 (equals로 비교하기때문에 equals override필수)
findMember.getAddressHistory().remove(new Address("oldCity1","street", "11111"));
findMember.getAddressHistory().add(new Address("newCity2","street", "11111"));
이와같이 컬렉션 값을 수정하기 위해서는 컬렉션에서 해당 값을 remove시킨 후에 다시 추가하는 방법을 사용해야한다.
여기서 index로 지우는게 아니라면 값을 equals로 비교하기 때문에 equals override는 필수적이다.
* 참고 : 값 타입 컬렉션은 영속성 전이(Cascade) + 고아 객체 제거 기능을 필수로 가진다.
addressHistory의 실행 쿼리를 보면
address 테이블의 데이터가 전부 delete되고 insert가 두번 실행된다.
하나의 데이터만 삭제되고 다시 추가 될 줄 알았는데 왜이렇게 되는 걸까?
이유는 값 타입 컬렉션의 제약사항 때문이다.
값 타입 컬렉션 제약 사항
- 값 타입은 엔티티와 다르게 식별자 개념이 없음
- 값을 변경하면 추적이 어려움
- 값 타입 컬렉션에 변경사항이 발생하면 주인 엔티티와 연관된 모든 데이터를 삭제하고, 값 타입 컬렉션에 있는 현재 값을 모두 다시 저장함
- 값 타입 컬렉션을 매핑하는 테이블은 모든 컬럼을 묶어 기본키로 구성해야함 => not null, 중복 X
값 타입 컬렉션 대안
- 실무에서는 상황에 따라 값 타입 컬렉션 대신 일대다 관계를 고려
- 일대다 관계를 위한 엔티티를 만들고 여기서 값 타입을 사용
- 영속성 전이 + 고아객체 제거를 사용하여 값 타입 컬렉션 처럼 사용
Address를 AddressEntity로 사용하기
import jakarta.persistence.Entity;
import jakarta.persistence.GeneratedValue;
import jakarta.persistence.Id;
import jakarta.persistence.Table;
@Entity
@Table(name = "ADDRESS")
public class AddressEntity {
@Id @GeneratedValue
private Long id;
private Address address;
public AddressEntity() {
}
public AddressEntity(Long id, Address address) {
this.id = id;
this.address = address;
}
public AddressEntity(String city, String street, String zipcode) {
this.address = new Address(city, street, zipcode);
}
public Long getId() {
return id;
}
public void setId(Long id) {
this.id = id;
}
public Address getAddress() {
return address;
}
public void setAddress(Address address) {
this.address = address;
}
}
Member 클래스의 addressHistory List 타입변수를 AddressEntity로 변경 및 일대다 관계 매핑
@OneToMany(cascade = CascadeType.ALL, orphanRemoval = true)
@JoinColumn(name = "MEMBER_ID")
private List<AddressEntity> addressHistory = new ArrayList<>();
public List<AddressEntity> getAddressHistory() {
return addressHistory;
}
public void setAddressHistory(List<AddressEntity> addressHistory) {
this.addressHistory = addressHistory;
}
이와 같이 변경 시 ADDRESS 테이블에 식별할수 있는 ID값이 생긴다.
* 정리
엔티티 타입의 특징
- 식별자 O
- 생명주기 관리
- 공유 가능
값 타입의 특징
- 식별자 X
- 생명주기를 엔티티에 의존
- 공유하지 않는 것이 안전 (복사해서 사용해야함)
- 불변 객체로 만드는것이 안전
* 값 타입은 정말 값 타입이라 판단될 때만 사용
* 엔티티와 값 타입을 혼동해서 엔티티를 값 타입으로 만들면 안됨
* 식별자가 필요하고, 지속해서 값을 추적하거나 변경해야 한다면 그것은 값 타입이 아닌 엔티티