이 글은 김영한님의 자바 ORM 표준 JPA 프로그래밍 - 기본편 강의를 듣고 정리한 글입니다.

기본값 타입

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

값 타입 분류

• 기본값 타입
  • 자바 기본 타입(int, double)
  • 래퍼 클래스(Integer, Long)
  • String
• 임베디드 타입(embedded type, 복합 값 타입)
  • 예) 좌표 x, y를 묶어서 쓰고 싶을 때
• 컬렉션 값 타입(collection value type)
  • 예) 자바 컬렉션에 기본값 타입이나 임베디드 타입을 넣을 수 있다

기본값 타입

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

참고: 자바의 기본 타입은 절대 공유 X

• int, double 같은 기본 타입(primitive type)은 절대 공유 X

int a = 10;
int b = a;

a = 20;

System.out.println("a = " + a); // 20
System.out.println("b = " + b); // 10 // 공유되지 않음

• 기본 타입은 항상 값을 복사함
• Integer같은 레퍼런스 클래스나 String 같은 특수한 클래스는 공유 가능한 객체이지만, 변경할 수 있는 방법이 없음 (사이드 이펙트가 일어날 여지가 없다)
  

Integer a = new Integer(10);
Integer b = a; // 참조값이 넘어감. 즉, 같은 인스턴스를 공유

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

// 예시
a.setValue(20);

System.out.println("a = " + a); // 20
System.out.println("b = " + b); // 20
// 하지만 값을 변경할 수 있는 방법이 없다.

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

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

사용법

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

예제

• 기본 값 타입만을 사용한 예: 회원 엔티티는 이름, 근무 시작일, 근무 종료일, 주소 도시, 주소 번지, 주소 우편번호를 가진다.
  

Member.java

@Entity
public class Member {

    @Id
    @GeneratedValue
    @Column(name = "MEMBER_ID")
    private Long id;

    @Column(name = "USERNAME")
    private String username;

	private LocalDateTime startDate;
    private LocalDateTime endDate;

    private String city;
    private String street;
    private String zipcode;

}

• 임베디드 타입을 사용한 예: 회원 엔티티는 이름, 근무 기간, 집 주소를 가진다.
  

Member.java

@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;

}

Period.java

@Embeddable // 정의
public class Period {
    private LocalDateTime startDate;
    private LocalDateTime endDate;
}

Address.java

@Embeddable // 정의
public class Address {
    private String city;
    private String street;
    private String zipcode;
}

장점

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

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

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

임베디드 타입과 연관관계

• 엔티티도 값 타입 안에 속할 수 있다.

임베디드 타입과 null

• 임베디드 타입의 값이 null이면 매핑한 컬럼 값은 모두 null

@AttributeOverride: 속성 재정의

• 한 엔티티에서 같은 값 타입을 사용하면?
  • 컬럼 명이 중복됨

@Entity
public class Member {
	// ...

    @Embedded
    private Address homeAddress;

    @Embedded
    private Address workAddress;

}

• ⇒ @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;
  
}

값 타입과 불변 객체

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

값 타입 공유 참조

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

JpaMain.java

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 {
            Address address = new Address("city", "street", "10000");

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

            Member member2 = new Member ();
            member2.setUsername("member2");
            member2.setHomeAddress(address); // 공유 참조
            em.persist(member2);

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

            tx.commit();
        } catch (Exception e) {
            tx.rollback();
            e.printStackTrace();
        } finally {
            em.close();
        }
        
        emf.close();
    }
}

• member1의 address 값을 바꾸려고 한 것인데, member2의 addreess 값까지 바뀜
• 의도한 것이라면, 엔티티를 만들어 사용하는 것이 바람직함

값 타입 복사

• 값 타입의 실제 인스턴스인 값을 공유하는 것은 위험
• 대신 값(인스턴스)를 복사해서 사용
  

		try {
        Address address = new Address("city", "street", "10000");
        Member member = new Member();
        member.setUsername("member1");
        member.setHomeAddress(address);
        em.persist(member);
		
  		// 복사해서 사용
        Address copyAddress = new Address(address.getCity(), address.getCity(), address.getZipcode());
  
        Member member2 = new Member();
        member2.setUsername("member2");
        member2.setHomeAddress(copyAddress);
        em.persist(member2);

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

        tx.commit();
        }

객체 타입의 한계

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

// 기본 타입(primitive type)
int a = 10;
int b = a; // 기본 타입은 값을 복사
b = 4; // b 변경해도, a 값 유지

// 객체 타입
Address a = new Address("Old");
Address b = a; // 객체 타입은 참조를 전달
b.setCity("New"); // b 변경하면 a의 값도 바뀜

불변 객체

• 객체 타입을 수정할 수 없게 만들어 부작용을 원천 차단
• 값 타입은 불변 객체(immutable object)로 설계해야함
  • 불변 객체: 생성 시점 이후 절대 값을 변경할 수 없는 객체
• 생성자로만 값을 설정하고 수정자(Setter)를 만들지 않으면 됨
  • 즉, setter를 만들지 않거나, private으로 만들면 됨
• 참고: Integer, String은 자바가 제공하는 대표적인 불변 객체
• 값을 바꾸고 싶을 경우: 새로 만들어서 통째로 갈아 끼워야 함
  

Address newAddress = new Address("NewCity", address.getCity(), address.getZipcode());
member.setHomeAddress(newAddress);

• ⇒ 불변이라는 작은 제약으로 부작용이라는 큰 재앙을 막을 수 있다.

값 타입의 비교

• 값 타입: 인스턴스가 달라도 그 안에 값이 같으면 같은 것으로 봐야 함

int a = 10;
int b = 10;
System.out.println("a == b: " + (a==b)); // true

Address addr1 = new Address("서울시");
Address addr2 = new Address("서울시");
System.out.println("addr1 == addr2: " + (addr1==addr2)); // false

• 동일성(identity) 비교: 인스턴스의 참조 값을 비교, == 사용
• 동등성(equivalence) 비교: 인스턴스의 값을 비교, equals() 사용
• 값 타입은 a.equals(b)를 사용해서 동등성 비교를 해야 함
• 값 타입의 equals() 메소드를 적절하게 재정의(주로 모든 필드 사용)
  • 클래스에서 Generate - equals() and hashCode() 로 메소드 생성할 때, 'Use getters during code generation' 옵션 선택
    
    
  • 옵션을 선택하면 getter를 호출함. 선택하지 않으면 필드에 직접 접근함.
    • equals()와 hashCode()가 아니더라도, JPA에서 메소드를 통해 값을 get하도록 코드를 작성하는 것이 좋음
    • 옵션 선택 안했을 경우: 프록시일 경우, 계산이 안됨.
    • 옵션 선택했을 경우
  • hashCode도 알맞게 구현해줘야 함.
  • 참고: 프록시를 복잡하게 쓰게 될 경우에는 getter로 고쳐야할 수도 있음.

System.out.println("addr1 equals addr2: " + (addr1.equals(addr2))); // true

값 타입 컬렉션

• 값 타입을 하나 이상 저장할 때 사용
• @ElementCollection, @CollectionTable 사용
• 데이터베이스는 컬렉션을 같은 테이블에 저장할 수 없다.
  • MEMBER와 ADDRESS가 일대다(->지연로딩) 개념으로 이어짐
  • 식별자ID를 넣어 PK로 쓰게 되면 값 타입이 아니라 엔티티가 됨. 값들을 조합해 PK로 구성해야 함.
• 컬렉션을 저장하기 위한 별도의 테이블이 필요함

Member.java

@Entity
public class Member {

	// ...

	@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<>();
}

JpaMain.java

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 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);

            tx.commit();
        } catch (Exception e) {
            tx.rollback();
            e.printStackTrace();
        } finally {
            em.close();
        }
        
        emf.close();
		}
}

• member만 persist()해도, 값 타입 컬렉션들이 자동으로 같이 들어감. 다른 값 타입들처럼 라이프사이클이 member에 소속됨.

값 타입 컬렉션 사용

• 값 타입 저장 예제
• 값 타입 조회 예제
  • 값 타입 컬렉션도 지연 로딩 전략을 사용해 쿼리를 날린다

        try {
			// ...
			em.persist(member);

			em.flush();
            em.clear();

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

            List<Address> addressHistory = findMember.getAddressHistory();
            for (Address address : addressHistory) { // iter
                System.out.println("address = " + address.getCity());
            }

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

			tx.commit();
		}

• 값 타입 수정 예제

            // homeCity -> newCity
            // findMember.getHomeAddress().setCity("newCity"); // 부작용 위험! 하면 안됨
            Address a = findMember.getHomeAddress();
            findMember.setHomeAddress(new Address("newCity", a.getStreet(), a.getZipcode()));
    
    		// 치킨 -> 한식
    		// 단순 String이며, String 자체가 값 타입. 통째로 갈아끼어야 함.
            findMember.getFavoriteFoods().remove("치킨");
            findMember.getFavoriteFoods().add("한식");

• 참고: 값 타입 컬렉션은 영속성 전이(Cascade) + 고아 객체 제거 기능을 필수로 가진다고 볼 수 있다.
  • 컬렉션의 값만 변경해도, 실제 데이터베이스 쿼리가 날라가면서 JPA가 알아서 바꿔줌.

제약사항

• 값 타입은 엔티티와 다르게 식별자 개념이 없다.
• 값은 변경하면 추적이 어렵다.
• 값 타입 컬렉션에 보관된 값 타입들은 별도의 테이블에 보관되기 때문에, 변경될 때 데이터베이스에 있는 원본 데이터를 찾기 어렵다.
  • 엔티티에 소속된 값 타입은 자신이 소속된 엔티티를 데이터베이스에서 찾아 값을 변경한다.
• 값 타입 컬렉션에 변경 사항이 발생하면, 주인 엔티티와 연관된 모든 데이터를 삭제하고, 값 타입 컬렉션에 있는 현재 값을 모두 다시 저장한다.

			// old1 -> newCity
			findMember.getAddressHistory().remove(new Address("old1", "street", "10000"));
            // equals()와 hashCode()가 제대로 구현되어야 하는 이유
            findMember.getAddressHistory().add(new Address("newCity", "street", "10000"));

• 값 타입 컬렉션을 매핑하는 테이블은 (MEMBER_ID를 포함한) 모든 컬럼을 묶어서 기본키를 구성해야 함: null 입력X, 중복 저장X

대안

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

AddressEntity.java

@Entity
@Table(name = "ADDRESS")
public class AddressEntity {

    @Id @GeneratedValue
    private Long id;

    private Address address;

    public AddressEntity(String city, String street, String zipcode) {
        this.address = new Address(city, street, zipcode);
    }

    public AddressEntity(Address address) {
        this.address = address;
    }
}

Address.java

@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;
    }
}

Member_Type.java

@Entity(name = "Member")
public class Member_Type {

    @Id
    @GeneratedValue
    @Column(name = "MEMBER_ID")
    private Long id;

    @Column(name = "USERNAME")
    private String username;

    @Embedded
    private Period workPeriod;

    @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<>();

    // 값 타입 컬렉션 대신에 일대다 관계 고려해 엔티티 만듦
    @OneToMany(cascade = CascadeType.ALL, orphanRemoval = true)
    @JoinColumn(name = "MEMBER_ID")
    private List<AddressEntity> addressHistory = new ArrayList<>();
}

JpaMain.java

        try {
			// ...
			member.getAddressHistory().add(new AddressEntity("old1", "street", "10000"));
           	member.getAddressHistory().add(new AddressEntity("old2", "street", "10000"));
			// ...
		}

실행 결과

• 자체적인 PK가 생기고, MEMBER_ID를 FK로 가져옴

정리

• 엔티티 타입의 특징
  • 식별자O
  • 생명 주기 관리
  • 공유
• 값 타입의 특징
  • 식별자X
  • 생명 주기를 엔티티에 의존
  • 공유하지 않는 것이 안전(복사해서 사용)
  • 불변 객체로 만드는 것이 안전
• 값 타입은 정말 값 타입이라 판단될 때만 사용
• 엔티티와 값 타입을 혼동해서 엔티티를 값 타입으로 만들면 안됨
• 식별자가 필요하고, 지속해서 값을 추적, 변경해야 한다면 그것은 값 타입이 아닌 엔티티
  • 추적할 필요 없고, 업데이트 할 필요 없이 정말 단순한 값이라면 값 타입 컬렉션 사용
  • EX) 셀렉트 박스