JPA는 최상위의 데이터 타입을 2가지로 분류한다.
- 엔티티 타입
@Entity
로 정의하는 클래스 객체를 말한다.- 데이터가 변해도 식별자로 지속해서 추적 가능
- 예) 회원 엔티티의 키나 나이 값을 변경해도 식별자로 인식 가능
- 값 타입
- int, Integer, String처럼 단순히 값으로 사용하는 자바 기본 타입이나 객체
- 식별자가 없고 값만 있으므로 변경시 추적 불가
- 예) 숫자 100을 200으로 변경하면 완전히 다른 값으로 대체
JPA에서 값 타입은 크게 3가지로 분류된다.
기본값 타입
- 자바 기본 타입(int, double)
- 래퍼 클래스(Integer, Long)
- String
임베디드 타입
(embedded type, 복합 값 타입)컬렉션 값 타입
(collection value type)
- 예): String name, int age
- 생명주기를 엔티티의 의존한다
- 예) 회원을 삭제하면 이름, 나이 필드도 함께 삭제
- 값 타입은 공유하면 안된다.
- 예) 회원 이름 변경시 다른 회원의 이름도 함께 변경되면 안됨 (Side Effect가 일어나면 안된다)
참고: 자바의 기본 타입은 절대 공유되지 않는다.
- int, double 같은 기본 타입(primitive type)은 절대 공유되지 않는다.
👉 Side Effect가 없다- 기본 타입은 항상 값을 복사함 (참조값을 공유)
- Integer같은 래퍼 클래스나 String 같은 특수한 클래스는 공유 가능한 객체이지만 변경X
public class ValueMain {
public static void main(String[] args) {
int a = 10;
int b = a; // 해당 시점의 a값을 b에 복사한다.
b = 20;
System.out.println("a = " + a); // a = 10
System.out.println("b = " + b); // b = 20
}
}
- 새로운 값 타입을 직접 정의할 수 있다.
- JPA는
임베디드 타입(embedded type)
이라 함- 주로 기본 값 타입을 모아서 만들어서
복합 값 타입
이라고도 함 (과거에)- 임베디드 타입은 엔티티가 아니라 int, String과 같은
값 타입
이다.
회원 엔티티는 이름, 근무 시작일, 근무 종료일, 주소 도시, 주소 번지, 주소 우편번호를 가진다
👉 공통적인 속성 (근무 시작일, 근무 종료일, 주소 도시, 주소 번지, 주소 우편번호
)으로 묶을 수 있다.
보통은 위와 같이 구체적으로 설명하지 않는다.
회원 엔티티는 이름, 근무 기간, 집 주소를 가진다.
라고 추상적으로 설명한다.
👉 이렇게 묶어낼 수 있는게임베디드 타입
이다.
Member
는id : Long
,name : String
,workPeriod : Period
,homeAddress : Address
라는 4가지 속성을 가진다.
Period
는startDate, endDate
라는 2가지 속성을 가지는 값 타입이다.Address
는city, street, zipcode
라는 3가지 속성을 가지는 값 타입이다.
👉Period
,Address
가 바로 임베디드 타입
@Embeddable
: 값 타입을 정의하는 곳에 표시@Embedded
: 값 타입을 사용하는 곳에 표시- 기본 생성자는 필수이다.
- 재사용이 가능하다
- 높은 응집도를 갖는다
Period.isWork()
처럼 해당 값 타입만 사용하는 의미 있는 메소드를 만들 수 있음 (객체지향적이다)- 임베디드 타입을 포함한 모든 값 타입은, 값 타입을 소유한 엔티티에 생명주기를 의존함
- 임베디드 타입은 엔티티의 값일 뿐이다.
- 임베디드 타입을 사용하기 전과 후에 매핑하는 테이블은 같다.
- 데이터베이스 입장에서는 객체가 임베디드 타입을 쓰던 말던 상관이 없다.
- 그렇기에 객체는 임베디드 타입을 사용하여 더욱 객체지향적으로 관리할 수 있다
(임베디드 타입에 메소드까지 생성하여 활용하면 취할 수 있는 이득이 많아진다.)- 객체와 테이블을 아주 세밀하게(find-grained) 매핑하는 것이 가능
- 잘 설계한 ORM 애플리케이션은 매핑한 테이블의 수보다 클래스의 수가 더 많음
- 현업에서 값 타입을 많이 쓰진 않지만 장점들이 많다.
@Entity
public class Member {
@Id
@GeneratedValue
@Column(name = "MEMBER_ID")
private Long id;
@Column(name = "USERNAME")
private String userName;
// Period 임베디드 타입으로
private LocalDateTime startDate;
private LocalDateTime endDate;
// Address 임베디드 타입으로
private String city;
private String street;
private String zipcode;
}
Member 엔티티에 임베디드 타입
을 사용해보자
@Embeddable // 값 타입을 정의하는 곳에 표시
public class Period {
private LocalDateTime startDate;
private LocalDateTime endDate;
// 기본 생성자 필수
public Period() {}
// 해당 임베디드 타입만의 메소드를 만들 수 있다.
public boolean workNow() {
return this.startDate.compareTo(this.endDate) > 0;
}
}
@Embeddable // 값 타입을 정의하는 곳에 표시
public class Address {
// Address 임베디드 타입으로
private String city;
private String street;
private String zipcode;
// 기본 생성자 필수
public Address() {}
}
Member 엔티티는 다음과 같이 변경된다.
@Entity
public class Member {
@Id
@GeneratedValue
@Column(name = "MEMBER_ID")
private Long id;
@Column(name = "USERNAME")
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());
em.persist(member);
System.out.println("=== commit ===");
tx.commit();
@Embeddable // 값 타입을 정의하는 곳에 표시
public class Address {
// Address 임베디드 타입으로
private String city;
private String street;
private String zipcode;
// 임베디드 타입은 엔티티를 가질 수 있다.
private Member member;
// 기본 생성자 필수
public Address() {}
}
임베디드 타입이 엔티티를 가질 수 있다.
PhonNumber
라는 임베디드 타입이PhoneEntity
라는 엔티티를 가질 수 있다.- 임베디드 타입은 엔티티의 외래키 값만 가지고 있으면 되기 떄문에 가능하다.
@Entity
public class Member {
@Id
@GeneratedValue
@Column(name = "MEMBER_ID")
private Long id;
@Column(name = "USERNAME")
private String userName;
@Embedded // 값 타입을 사용하는 곳에 표시한다.
private Period workPeriod;
@Embedded
private Address homeAddress;
@Embedded
private Address workAddress;
}
Address homeAddress
와Address workAddress
처럼
한 엔티티에서 같은 값 타입 (Address
)을 갖는 속성을 여러 개 사용하면 컬럼 명이 중복된다.
👉 에러 발생
@Entity
public class Member {
@Id
@GeneratedValue
@Column(name = "MEMBER_ID")
private Long id;
@Column(name = "USERNAME")
private String userName;
@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
를 사용해서 컬러 명 속성을 재정의 할 수 있다.
👉 컬럼 명이 중복을 막을 수 있다
@Embedded // 값 타입을 사용하는 곳에 표시한다.
private Period workPeriod = null; // 임베디드 타입이 null이면
@Embeddable // 값 타입을 정의하는 곳에 표시
public class Period {
private LocalDateTime startDate;
private LocalDateTime endDate; // startDate, endDate 도 null이다.
}
임베디드 타입의 값이 null이면 매핑한 컬럼 값은 모두 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);
member1, member2는 같은 address를 사용하고 있다.
member1.getHomeAddress().setCity("newCity");
member1의 주소만 newCity로 바꾸고 싶지만 member2도 같이 바뀐다. 👉 SideEffect 버그
- 만약
Address
를 공유하고 싶다면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);
member1.getHomeAddress().setCity("newCity");
- 항상 값을 복사해서 사용하면 공유 참조로 인해 발생하는 부작용을 피할 수 있다.
- 문제는 임베디드 타입처럼 직접 정의한 값 타입은 자바의 기본타입이 아니라 객체 타입이다.
- 기본 타입은 대입 연산
=
을 사용하면 값이 복사되어 넘어가기 때문에 값이 같을 수가 없다. (기본 타입은 공유가 불가능)- 자바 기본 타입에 값을 대입하면 값을 복사한다.
- 객체 타입은 참조 값을 직접 대입하는 것을 막을 방법이 없다.
값 타입 복사
방법 처럼 Side Effect를 피할 수 있지만 (member2.setHomeAddress(copyAddress);
)
member2.setHomeAddress(member1.getHomAddress());
이를 막을 수 있는 방법이 없다
👉 객체의 공유 참조는 피할 수 없다.
int a = 10;
int b = a; //기본 타입은 값을 복사
b = 4;
Address a = new Address("Old");
Address b = a; //객체 타입은 참조를 전달
b.setCity("New");
a와 b는 같은
Address
객체를 참조하기 때문에b.setCity("New");
를 하면 a의 값도 변경됨
공유 참조는 피할 수 없다는 객체 타입의 한계를 막기 위해 불변 객체
를 사용한다.
👉 불변
이라는 작은 제약으로 부작용
이라는 큰 재앙을 막을 수 있다.
- 객체 타입을 수정할 수 없게 만들면 부작용을 원천 차단하면 된다.
- 값 타입은
불변 객체
(immutable object)로 설계해야한다.불변 객체
: 생성 시점 이후 절대 값을 변경할 수 없는 객체- 생성자로만 값을 설정하고 수정자(Setter)를 만들지 않으면 된다
- 참고 : Integer, String은 자바가 제공하는 대표적인 불변 객체
그럼에도 불구하고 값을 변경하고 싶다면 👉 새로운 객체를 생성해서 넣어야 한다.
Address address = new Address("city", "street", "10000");
Member member1 = new Member();
member1.setUserName("member1");
member1.setHomeAddress(address);
em.persist(member1);
// 새로운 객체를 생성해서 넣는다.
Address newAddress = new Address("newCity", address.getStreet(), address.getZipcode());
member1.setHomeAddress(newAddress);
오류 예방을 위해 값 타입은 불변 객체로 만들어야 한다. 꼭
public class ValueMain {
public static void main(String[] args) {
int a = 10;
int b = 10;
System.out.println("a == b : " + (a == b));
Address address1 = new Address("city", "street", "10000");
Address address2 = new Address("city", "street", "10000");
System.out.println("address2 == address1 : " + (address2 == address1));
System.out.println("address2 equals address1 : " + (address2.equals(address1)));
}
}
값 타입은 인스턴스가 달라도 그 안에 값이 같으면 같은 것으로 봐야 한다.
동일성 비교와 동등성 비교를 구분해서 사용해야 한다.
동일성(identity) 비교
인스턴스의 참조 값을 비교,==
사용한다동등성(equivalence) 비교
인스턴스의 값을 비교,equals()
사용한다- 📌값 타입은 a.equals(b)를 사용해서 동등성 비교를 해야 한다
- 값 타입의 equals() 메소드를 적절하게 재정의 한다 (주로 모든 필드 사용)
public boolean equals(Object obj) {
return (this == obj);
}
equals()의 기본 방식이
==
비교이므로 적절하게 재정의 한다
@Embeddable // 값 타입을 정의하는 곳에 표시
public class Address {
// 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;
}
@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());
}
}
IntelliJ가 기본적으로 제공해주는 equals() 오버라이드 메소드 생성방법을 따른다.
현업에서 equals로 값 타입을 비교하는 일이 많진 않다.
값 타입 컬렉션이란 값 타입을 자바 컬랙션에 담아서 사용하는 것을 말한다.
기본적으로 RDB는 컬랙션을 속성으로 담는 구조가 없다.
👉 컬랙션을 담기 위해 별도의 테이블이 필요하다
- 값 타입을 하나 이상 저장할 때 사용한다.
@ElementCollection
,@CollectionTable
사용한다- 데이터베이스는 컬렉션을 같은 테이블에 저장할 수 없다.
- 컬렉션을 저장하기 위한 별도의 테이블이 필요하다 (
FAVORITE_FOOD
,ADDRESS
)
@Entity
public class Member {
@Id
@GeneratedValue
@Column(name = "MEMBER_ID")
private Long id;
@Column(name = "USERNAME")
private String userName;
@Embedded
private Address homeAddress;
@ElementCollection
@CollectionTable(
name = "FAVORITE_FOOD",
joinColumns = @JoinColumn(name = "MEMBER_ID"))
@Column(name = "FOOD_NAME") // String으로 값이 하나이기 때문에 속성명을 지정할 수 있다.
private Set<String> favoriteFoods = new HashSet<>();
@ElementCollection
@CollectionTable(
name = "ADDRESS",
joinColumns = @JoinColumn(name = "MEMBER_ID"))
private List<Address> addressHistory = new ArrayList<>();
}
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","street","10000"));
member.getAddressHistory().add(new Address("old2","street","10000"));
em.persist(member);
FAVORITE_FOOD
,ADDRESS
가MEMBER
와 다른 테이블인데도
em.persist(member);
만으로 서로 다른 2개의 테이블에 값이 insert된다.
- 값 타입 컬랙션(
favoriteFoods
,addressHistory
)은 엔티티의 생명주기를 따른다.
그래서 값 타입 컬랙션을 따로 persist 해줄 필요가 없다.
- 값 타입 저장 예제
- 값 타입 조회 예제
- 값 타입 컬렉션도 지연 로딩 전략 사용
- 값 타입 수정 예제
- 참고: 값 타입 컬렉션은 영속성 전에(Cascade) + 고아 객체 제거 기능을 필수로 가진다고 볼 수 있다.
em.persist(member);
em.flush();
em.clear();
System.out.println("=== em.find(Member.class, member.getId()) ===");
Member findMember = em.find(Member.class, member.getId());
// 지연로딩
System.out.println("=== findMember.getAddressHistory() ===");
for (Address address : findMember.getAddressHistory()) {
System.out.println("address.getCity() = " + address.getCity());
}
System.out.println("=== findMember.getFavoriteFoods() ===");
for (String favoriteFood : findMember.getFavoriteFoods()) {
System.out.println("favoriteFood = " + favoriteFood);
}
member를 조회하면(
em.find(Member.class, member.getId()
) MEMBER 테이블만 조회한다
Address homeAddress;
는 같이 조회된다.Set<String> favoriteFoods
와List<Address> addressHistory
는 지연로딩된다.
@Target( { METHOD, FIELD })
@Retention(RUNTIME)
public @interface ElementCollection {
/**
* (Optional) The basic or embeddable class that is the element
* type of the collection. This element is optional only if the
* collection field or property is defined using Java generics,
* and must be specified otherwise. It defaults to the
* paramterized type of the collection when defined using
* generics.
*/
Class targetClass() default void.class;
/**
* (Optional) Whether the collection should be lazily loaded or must be
* eagerly fetched. The EAGER strategy is a requirement on
* the persistence provider runtime that the collection elements
* must be eagerly fetched. The LAZY strategy is a hint to the
* persistence provider runtime.
*/
FetchType fetch() default LAZY;
}
@ElementCollection
의 fetch의 기본값이LAZY
이다.
em.persist(member);
em.flush();
em.clear();
System.out.println("=== em.find(Member.class, member.getId()) ===");
Member findMember = em.find(Member.class, member.getId());
// homeCity -> newCity
// findMember.getHomeAddress().setCity("newCity"); // 이런식으로 변경하면 Side Effect 발생한다.
System.out.println("=== homeCity -> newCity ===");
Address a = findMember.getHomeAddress();
findMember.setHomeAddress(new Address("newCity", a.getStreet(), a.getZipcode())); // 통으로 갈아 끼워야한다.
// 값 타입 컬랙션 수정
// 치킨 -> 한식
// favoriteFoods의 String 자체도 값 타입이다 -> 통으로 갈아 끼워라
System.out.println("=== 치킨 -> 한식 ===");
findMember.getFavoriteFoods().remove("치킨");
findMember.getFavoriteFoods().add("한식");
homeCity -> newCity
findMember.getHomeAddress().setCity("newCity");
방식은 Side Effect 위험이 있다.findMember.setHomeAddress(new Address("newCity", a.getStreet(), a.getZipcode()));
처럼 통째로 데이터를 갈아 끼워야 한다.치킨 -> 한식
- favoriteFoods의 String 자체도 값 타입이므로 통째로 데이터를 변경해줘야 한다.
Member member = new Member();
member.setUserName("member1");
member.setHomeAddress(new Address("homeCity", "street", "10000"));
member.getAddressHistory().add(new Address("old1", "street", "10000"));
member.getAddressHistory().add(new Address("old2", "street", "10000"));
em.persist(member);
em.flush();
em.clear();
Member findMember = em.find(Member.class, member.getId());
// remove() 메소드는 equals()로 동일한 객체를 찾아 삭제한다.
// 그래서 equals() 메소드를 꼭 사전에 제대로 오버라이딩해줘야한다.
// 값 타입 컬랙션 addressHistory에서 old1인 원소의 city값을 -> newCity1 으로 변경
findMember.getAddressHistory().remove(new Address("old1", "street", "10000"));
findMember.getAddressHistory().add(new Address("newCity1", "street", "10000"));
remove()
메소드는 오버라이드 된equals()
로 동일한 객체를 찾아 삭제한다
로그를 보면
해당 Member에 소속된 Address 데이터를 모두 지운 뒤, (old1, old2 가 지워지고)
그리고 나서 insert 쿼리가 두번 나간다. (old2, newCity1이 들어간다)
- 값 타입은 엔티티와 다르게 식별자 개념이 없다.
그래서 값을 변경하면 추적이 어렵다.- 값 타입 컬렉션에 변경 사항이 발생하면,
주인 엔티티와 연관된 모든 데이터를 삭제하고, 값 타입 컬렉션에 있는 현재 값을 모두 다시 저장한다.
👉 이 특징 때문에 캆 타입 컬렉션을 사용하면 안 좋다.- 값 타입 컬렉션을 매핑하는 테이블은 모든 컬럼을 묶어서 기본키를 구성해야 함: null 입력X, 중복 저장X
- 실무에서는 상황에 따라 값 타입 컬렉션 대신에 👉 일대다 관계를 고려하는게 좋다
- 일대다 관계를 위한 엔티티를 만들고, 여기에서 값 타입을 사용
- 영속성 전이(Cascade) + 고아 객체 제거를 사용해서 값 타입 컬렉션 처럼 사용
- EX)
AddressEntity
@Entity
@Table(name = "ADDRESS")
public class AddressEntity {
@Id @GeneratedValue
private Long id;
@Embedded
private Address address;
}
@Entity
public class Member {
@Id
@GeneratedValue
@Column(name = "MEMBER_ID")
private Long id;
@Column(name = "USERNAME")
private String userName;
@Embedded
private Address homeAddress;
@ElementCollection
@CollectionTable(
name = "FAVORITE_FOOD",
joinColumns = @JoinColumn(name = "MEMBER_ID"))
@Column(name = "FOOD_NAME") // String으로 값이 하나이기 때문에 속성명을 지정할 수 있다.
private Set<String> favoriteFoods = new HashSet<>();
// @ElementCollection
// @CollectionTable(
// name = "ADDRESS",
// joinColumns = @JoinColumn(name = "MEMBER_ID"))
// private List<Address> addressHistory = new ArrayList<>();
@OneToMany(cascade = CascadeType.ALL, orphanRemoval = true)
@JoinColumn(name = "MEMBER_ID") // 일대다 단방향 매핑
private List<AddressEntity> addressHistory = new ArrayList<>();
}
Address
임베디드 객체를AddressEntity
엔티티 클래스로 한번 감싸준뒤 사용하면
값 타입 컬랙션을 사용하는 것보다 관리가 쉽고 쿼리 최적화가 가능하다.
ADDRESS
테이블에 자체적인 ID 속성이 있다
👉 값 타입이 아니라 엔티티이다.
- 엔티티 타입의 특징
- 식별자가 있다
- 생명 주기 관리가 가능하다
- 공유할 수 있다
- 값 타입의 특징
- 식별자가 없다
- 생명 주기를 엔티티에 의존한다
- 공유하지 않는 것이 안전하다 (복사해서 사용)
- 공유 되더라도 변경할 수 없게 불변 객체로 만드는 것이 안전하다
📌값 타입은 정말 값 타입이라 판단될 때만 사용해야 한다.
📌엔티티와 값 타입을 혼동해서 엔티티를 값 타입으로 만들면 안된다.
📌식별자가 필요하고, 지속해서 값을 추적, 변경해야 한다면 그것은 값 타입이 아닌 엔티티를 사용한다.
사용자가 좋아하는 음식을 저장하는 것과 같이 매우 단순한 경우에만 값 타입을 사용한다. (값을 추적할 필요도 없을 경우)
그렇지 않다면 웬만하면 엔티티를 사용해라.