Posts [자바 ORM 표준 JPA 프로그래밍-기본편] 임베디드 타입
Post
Cancel

[자바 ORM 표준 JPA 프로그래밍-기본편] 임베디드 타입

본 포스팅은 인프러의 JPA 기본편을 수강하고 정리하는 내용입니다.


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

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

임베디드 타입

  • 회원 엔티티는 이름, 근무 시작일, 근무 종료일, 주소 도시, 주소 번지, 주소 우편번호를 가진다.
    • 근무 시작일, 종료일 묶을 수 있지 않을까?
    • city, street, zipcode는 공통으로 클래스타입으로 만들어서 쓸 수 있지 않을까?
    • 이렇게 묶어낼 수 있는게 임베디드 타입이다.

image

보통 회원 엔티티는 이름, 근무 기간, 집 주소를 가진다 라고 보통 추상화해서 설명을 할 것이다.

image

아래처럼 클래스 두 개를 뽑아서 활용하면 된다.

image

임베디드 타입 사용법

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

Note: @Embeddable, @Embedded 둘 중의 하나만 넣어도 문제는 없지만 둘 다 넣는 것을 권장한다.

임베디드 타입의 장점

  • 재사용
  • 높은 응집도
  • Period.isWork()처럼 해당 값 타입만 사용하는 의미 있는 메소드를 만들 수 있음
    • 상당히 객체지향적으로 설계가 가능해진다.
  • 임베디드 타입을 포함한 모든 값 타입은, 값 타입을 소유한 엔티티에 생명주기를 의존함
    • 값 타임이란건 엔티티의 라이프사이클에 의존한다는걸 기억하자

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

image

객체는 데이터 뿐만 아니라 메서드라는 행위까지 가지기에 묶었을때 나오는 이득이 굉장히 많다.

예제 코드

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
@Entity
public class Member {

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

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

    // 기간 Period
    @Embedded
    private Period workPeriod;

    // 주소
    @Embedded
    private Address homeAddress;

    ...
}

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

    ...
}

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

    public boolean isWork() {
        // startDate 와 endDate 사이에 있는지 확인

        return true;
    }

    ...
}

public class JpaMain {
    public static void main(String[] args) {
        ...

        try {
            Member member = new Member();
            member.setUsername("hello");
            member.setHomeAddress(new Address("city", "street", "10"));
            member.setWorkPeriod(new Period());

            em.persist(member);

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

        emf.close();
    }

}

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

  • 임베디드 타입은 엔티티의 값일 뿐이다.
  • 임베디드 타입을 사용하기 전과 후에 매핑하는 테이블은 같다.(중요)
  • 객체와 테이블을 아주 세밀하게(find-grained) 매핑하는 것이 가능
    • 프로젝트가 점점 커지면 공통된 것을 클래스로 묶어서 그안에 메서드를 만들어 활용할 수 있는게 많다
    • 설계적으로 봤을때도 회원 엔티티는 이름, 근무기간, 집 주소를 가진다. 모델링이 훨씬 깔끔하게 떨어지고 설명하기도 쉬워진다.
  • 잘 설계한 ORM 애플리케이션은 매핑한 테이블의 수보다 클래스의 수가 더 많음
    • 사실 실무에서 Value Type을 어마어마하게 쓰진 않는다. 그렇지만 공통으로 관리할 수도 있고 장점들이 많다. 용어들이 공통화 되고, 코드가 공통화 되고!

임베디드 타입과 연관관계

image

PhoneNumber라는 값타입이 PhoneEntity라는 엔티티를 가질 수 있다.

@AttributeOverride: 속성 재정의

한 엔티티에서 같은 값 타입을 사용하면?

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
@Entity
public class Member {

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

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

    // 기간 Period
    @Embedded
    private Period workPeriod;

    // 주소
    @Embedded
    private Address homeAddress;

    // 주소
    @Embedded
    private Address workAddress;

    ...
}
  • 컬럼 명이 중복됨
    • Exception 발생! MappingException
    • @AttributeOverrides, @AttributeOverride 를 사용해서 컬러 명 속성을 재정의
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
@Entity
public class Member {

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

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

    // 기간 Period
    @Embedded
    private Period workPeriod;

    // 주소
    @Embedded
    @AttributeOverride(name = "zipcode", colum = @Column(name = "home_zipcode"))
    @AttributeOverride(name = "address1", colum = @Column(name = "home_address1"))
    @AttributeOverride(name = "address2", colum = @Column(name = "home_address2"))
    private Address homeAddress;

    // 주소
    @Embedded
        // 주소
    @Embedded
    @AttributeOverride(name = "zipcode", colum = @Column(name = "company_zipcode"))
    @AttributeOverride(name = "address1", colum = @Column(name = "company_address1"))
    @AttributeOverride(name = "address2", colum = @Column(name = "company_address2"))
    private Address workAddress;

    ...
}

임베디드 타입과 null

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

This post is licensed under CC BY 4.0 by the author.

[자바 ORM 표준 JPA 프로그래밍-기본편] 기본값 타입

[자바 ORM 표준 JPA 프로그래밍-기본편] 값 타입과 불변 객체